dmi_read 0.1.0

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 47

DMI Read

A Dart library for reading .dmi spritesheet files used by the BYOND platform.

This library does not depend on dart:io, and thus can be used both in browser and the VM.

Current version has been tested against dmis generated by BYOND version 510.1347.

Background

BYOND is a proprietary game engine and platform, allowing creation of 2D tile-based multiplayer games through its Dream Maker component.

In BYOND game sources, sprites are kept in .dmi files. .dmi files are sprite sheets in a PNG file with a zTXt chunk containing metadata which describes the frames in the sprite sheet. An image viewer or editor will generally be able to open the whole sprite sheet, however, figuring out where the individual sprites are, and how they are grouped requires parsing the attached .dmi metadata.

Example

Print the names of every state in foo.dmi:

DmiSheet sheet = new DmiSheet.fromBytes(
    await new File('foo.dmi').readAsBytes());
sheet.states.forEach((state) {
  print(state.name);
});

For a slightly longer example, see dmi_read_example.dart.

Project

dmi_read is free software licensed under the ISC license. See the LICENSE file for details.

Bug reports and pull requests can be filed at github.com/DeeUnderscore/dmi_read.

Changelog

0.1.0

Initial release.

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  dmi_read: "^0.1.0"

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

Alternatively, your editor might support pub get or packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:dmi_read/dmi_read.dart';
        
Version Uploaded Documentation Archive
0.1.0 Dec 18, 2016 Go to the documentation of dmi_read 0.1.0 Download dmi_read 0.1.0 archive

Analysis

This feature is new.
We welcome feedback.
More details: scoring.

We analyzed this package, and provided a score, details, and suggestions below.

  • completed on Feb 3, 2018
  • Dart: 2.0.0-dev.20.0
  • pana: 0.10.1

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
0 / 100
Health:
Code health derived from static analysis. [more]
99 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
87 / 100
Overall score:
Weighted score of the above. [more]
47

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in primary library package:dmi_read/dmi_read.dart.

Suggestions

  • Package is pre-v1 release.

    While there is nothing inherently wrong with versions of 0.*.*, it usually means that the author is still experimenting with the general direction API.

  • Use analysis_options.yaml.

    Rename old .analysis_options file to analysis_options.yaml.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.20.0 <2.0.0
archive ^1.0.27 1.0.33
image ^1.1.26 1.1.29
string_scanner ^1.0.1 1.0.2
Transitive dependencies
args 1.3.0
browser 0.10.0+2
charcode 1.1.1
collection 1.14.5
convert 2.0.1
crypto 2.0.2+1
matcher 0.12.1+4
path 1.5.1
petitparser 1.7.0
source_span 1.4.0
stack_trace 1.9.1
typed_data 1.1.5
xml 2.6.0 3.0.0-alpha
Dev dependencies
test >=0.12.0