Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Finish WORLD.md (the docs for the "json/areas" files) #189

Open
Synival opened this issue Mar 16, 2020 · 0 comments
Open

Finish WORLD.md (the docs for the "json/areas" files) #189

Synival opened this issue Mar 16, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone
Version 0.1.0 (Re...

Comments

@Synival
Copy link
Owner

Synival commented Mar 16, 2020

WORLD.md should contain all information necessary to write entire areas from scratch. This means:

  1. Areas
  2. Rooms
    1. Exits
    2. Resets
  3. Objects
    1. All object types
  4. Mobs
  5. (Probably not) Mob programs

Each section needs the following documented:

  1. Required properties
  2. Optional properties
  3. When applicable: Flag / type values

A few extra sections:

  1. "Extended" human-readable multiline format
  2. Files in json/config
  3. What are "portals"?
  4. Help files
  5. The files in json/meta
@Synival Synival added the documentation Improvements or additions to documentation label Mar 16, 2020
@Synival Synival added this to the Version 0.1.0 (Release) milestone Mar 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
Version 0.1.0 (Release)
Development

No branches or pull requests
1 participant
@Synival