zart 1.0.1

Zart - Dart Implementation of Infocom Z-Machine #

West of House
You are standing in an open field west of a white house, with a 
boarded front door. You could circle the house to the north or south.
There is a small mailbox here.

>

Some of my most memorable early gaming experiences were playing Infocom interactive fiction games.

This project is a labor of love.

Enjoy!

Features #

  • Plays V3, V5, V7, and V8 games (see "Limitations" below)
  • Supports loading raw game files (.z3, .z5, .z8, etc)
  • Supports loading .zblorb files, but only uses the game file from the package at this time.
  • Separates the UI implementation from the core interpreter functions, providing extensibility to virtually any platform that Dart runs on (currently Mac, Linux, Windows, and Web).

Limitations #

Older Games May Not Work #

Some games, especially ones compiled with older version of Inform, may not work properly. Trial and error is the only way to know.

The older Infocom games (V3 & V5) appear to work fine.

Games compiled with the latest Inform 7 appear to work fine.

Want to author your own IF games? #

http://inform7.com/

Next Steps #

  • Bug fixes, optimization, enhancements to some op codes.
  • Add in some detection to warn if the game file may not be playable.
  • Improve the web interpreter (not included with this library) to support split screening, cursor positioning, etc.

Reference Material #

License #

Source Code: Apache 2.0 (see LICENSE file)

Game files include are covered under their own applicable copyrights and licensing.

Fun Fact #

This was the first package ever uploaded to https://pub.dev back during the pre v1.0 days of Dart.

Use this package as a library

1. Depend on it

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


dependencies:
  zart: ^1.0.1

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

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

3. Import it

Now in your Dart code, you can use:


import 'package:zart/zart.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
16
Health:
Code health derived from static analysis. [more]
84
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
65
Overall:
Weighted score of the above. [more]
46
Learn more about scoring.

We analyzed this package on Nov 8, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.6.0
  • pana: 0.12.21

Platforms

Detected platforms: Flutter, web, other

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

Health suggestions

Fix lib/machines/machine.dart. (-3.45 points)

Analysis of lib/machines/machine.dart reported 7 hints, including:

line 17 col 1: Prefer using /// for doc comments.

line 52 col 27: Use = to separate a named parameter from its default value.

line 60 col 3: Prefer using /// for doc comments.

line 76 col 3: Prefer using /// for doc comments.

line 332 col 12: Use isNotEmpty instead of length

Fix lib/z_machine.dart. (-2.96 points)

Analysis of lib/z_machine.dart reported 6 hints, including:

line 1 col 26: Use lowercase_with_underscores when specifying a library prefix.

line 16 col 1: Prefer using /// for doc comments.

line 110 col 3: Prefer using /// for doc comments.

line 141 col 3: Prefer using /// for doc comments.

line 146 col 13: Don't explicitly initialize variables to null.

Fix lib/machines/version_5.dart. (-1.99 points)

Analysis of lib/machines/version_5.dart reported 4 hints:

line 11 col 1: Prefer using /// for doc comments.

line 495 col 12: Use isNotEmpty instead of length

line 531 col 12: Use isNotEmpty instead of length

line 565 col 12: Use isNotEmpty instead of length

Fix additional 20 files with analysis or formatting issues. (-8.48 points)

Additional issues in the following files:

  • lib/operand.dart (4 hints)
  • lib/IO/default_provider.dart (3 hints)
  • lib/DRandom.dart (2 hints)
  • lib/IO/iff.dart (1 hint)
  • lib/IO/quetzal.dart (1 hint)
  • lib/debugger.dart (1 hint)
  • lib/dictionary.dart (1 hint)
  • lib/game_object.dart (1 hint)
  • lib/machines/version_3.dart (1 hint)
  • lib/machines/version_8.dart (1 hint)
  • lib/zscii.dart (1 hint)
  • lib/IO/blorb.dart (Run dartfmt to format lib/IO/blorb.dart.)
  • lib/IO/io_provider.dart (Run dartfmt to format lib/IO/io_provider.dart.)
  • lib/binary_helper.dart (Run dartfmt to format lib/binary_helper.dart.)
  • lib/game_exception.dart (Run dartfmt to format lib/game_exception.dart.)
  • lib/header.dart (Run dartfmt to format lib/header.dart.)
  • lib/machines/version_7.dart (Run dartfmt to format lib/machines/version_7.dart.)
  • lib/memory_map.dart (Run dartfmt to format lib/memory_map.dart.)
  • lib/stack.dart (Run dartfmt to format lib/stack.dart.)
  • lib/zart.dart (Run dartfmt to format lib/zart.dart.)

Maintenance issues and suggestions

Provide a file named CHANGELOG.md. (-20 points)

Changelog entries help developers follow the progress of your package. See the example generated by stagehand.

The package description is too short. (-15 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Maintain an example.

None of the files in the package's example/ directory matches known example patterns.

Common filename patterns include main.dart, example.dart, and zart.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
test ^1.6.3 1.9.4
Transitive dependencies
_fe_analyzer_shared 1.0.0
analyzer 0.39.1
args 1.5.2
async 2.4.0
boolean_selector 1.0.5
charcode 1.1.2
collection 1.14.12
convert 2.1.1
coverage 0.13.3+1
crypto 2.1.3
csslib 0.16.1
front_end 0.1.29
glob 1.2.0
html 0.14.0+3
http 0.12.0+2
http_multi_server 2.1.0
http_parser 3.1.3
io 0.3.3
js 0.6.1+1
kernel 0.3.29
logging 0.11.3+2
matcher 0.12.6
meta 1.1.8
mime 0.9.6+3
multi_server_socket 1.0.2
node_interop 1.0.3
node_io 1.0.1+2
node_preamble 1.4.8
package_config 1.1.0
package_resolver 1.0.10
path 1.6.4
pedantic 1.8.0+1
pool 1.4.0
pub_semver 1.4.2
shelf 0.7.5
shelf_packages_handler 1.0.4
shelf_static 0.2.8
shelf_web_socket 0.2.3
source_map_stack_trace 1.1.5
source_maps 0.10.8
source_span 1.5.5
stack_trace 1.9.3
stream_channel 2.0.0
string_scanner 1.0.5
term_glyph 1.1.0
test_api 0.2.11
test_core 0.2.15
typed_data 1.1.6
vm_service 2.1.1
watcher 0.9.7+12
web_socket_channel 1.1.0
yaml 2.2.0