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 game documentation #112

Open
9 of 10 tasks
jakubg1 opened this issue Jul 9, 2023 · 0 comments
Open
9 of 10 tasks

Finish game documentation #112

jakubg1 opened this issue Jul 9, 2023 · 0 comments
Assignees
@jakubg1
Labels
A: Documentation Issue with documentation. A: Game Data Issue with game data. D: Feature Request A feature that may be implemented in a future version. D: Organization A change that will not impact the end-user, but may be helpful for simplifying/documenting the code. R: WIP The resolution is in progress.
Milestone
Beta 5.0.0 release

Comments

@jakubg1
Copy link
Owner

jakubg1 commented Jul 9, 2023 •
edited
Loading

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 Extract all JSON structures to their own classes #70.
@jakubg1 jakubg1 added D: Feature Request A feature that may be implemented in a future version. D: Organization A change that will not impact the end-user, but may be helpful for simplifying/documenting the code. R: WIP The resolution is in progress. A: Modding Issue which will impact modders if worked on. Potentially a breaking change. labels Jul 9, 2023
@jakubg1 jakubg1 added this to the Full 1.0 release milestone Jul 9, 2023
@jakubg1 jakubg1 self-assigned this Jul 9, 2023
@jakubg1 jakubg1 added A: Game Data Issue with game data. A: Documentation Issue with documentation. and removed A: Modding Issue which will impact modders if worked on. Potentially a breaking change. labels May 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jakubg1 jakubg1

Labels
A: Documentation Issue with documentation. A: Game Data Issue with game data. D: Feature Request A feature that may be implemented in a future version. D: Organization A change that will not impact the end-user, but may be helpful for simplifying/documenting the code. R: WIP The resolution is in progress.
Projects
None yet
Milestone
Beta 5.0.0 release
Development

No branches or pull requests
1 participant
@jakubg1