Giters

jakubg1 / OpenSMCE

Game engine which allows creating a broad range of marble popper games.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Finish game documentation

jakubg1 opened this issue · comments

commented

Relates to #70.

Currently, most of the JSON structures are documented. The way it's done right now is as following:

  • The schemas are the primary source of all information. They are located in the schemas folder in the repository.
  • This data is referenced to in doc/game/data.txt in my own "language". I will refer to it as Doc Language.
  • The doc/game/generate.py is a Python script file which loads the doc/game/data.txt file and:
    1. Converts all JSON schemas referred to in that file to the Doc Language,
    2. Generates all HTML pages based on the final Doc Language contents which is the final form of game documentation.
  • The schemas are also loaded by JSON files themselves.

The following needs to be done:

  • Document the following structures:
    • Collectible Generators
    • Fonts
    • Particles
    • UI2 Layouts
    • UI2 Animations
    • UI2 Sequences
  • Potentially, make a Doc Language -> JSON Schema converter and base everything off Doc Language, as this seems to be much less hassle, especially potentially in cases like enums, "one of the following" or content types. (a252642)
  • Update the Doc Language -> HTML converter to support the new structures.
  • Make a JSON Schema / Doc Language -> Config Class converter to save hassle with #70.