Rollout

The full project rollout includes the complete, working Zurk implementation (including both the Zurk engine and the ZurkParser with semantic validation functionality) and at least one novel world description file that demonstrates all features of the Zurk engine. The Zurk engine MUST support and a trace mechanism that allows a hardcopy of an entire Zurk game session to be recorded to a TRACE FILE (Section 4.4.2). The jar file for this milestone MUST provide a default Main-Class of Zurk (Section 4.1).

The deliverables for this milestone are:

Zurk.java ZurkParser.java

The main class files for the Zurk engine and the ZurkParser implementation.

Other Java source files

Any other supporting code files necessary to compile, load, and use the ZurkParser module.

Compiled .class files

In addition to the source .java files, the submission jar file MUST include all necessary compiled .class files so that the jar file can be executable without recompilation.

API documentation

The handin MUST also include the full, compiled JavaDoc documentation for the Zurk and ZurkParser implementations. This documentation MUST include full descriptions of every public or protected method, field, sub-class, enclosed class, or constructor employed by Zurk or ZurkParser. This documentation hierarchy MUST be included in a sub-directory named documentation/ within the submission jar file.

Test cases

The submission jar file MUST include a subdirectory named tests/ that includes all of the test data used to demonstrate the performance of the parser implementation. Both the test case input and the output generated by your parser must be present.

CVS logfiles

The submission MUST include CVS log files for every Java source file (and possibly additional files, such as user documentation, test files, etc.), demonstrating reasonable version control during development.

At the designer's option, this submission MAY also include:

BUGS.TXT

This file documents any known outstanding bugs, missing features, performance problems, or failures to meet specifications of your submission. Note that the penalty for such problems will be smaller if they're fully documented here than if the instructors discover them independently.

README.TXT

This file includes any other notes or documentation necessary to use or understand the submission that are not already included in other documentation.

The submission directory MUST be named lastname_p2m2 and the submission jar file MUST be named lastname_p2m2.jar.