Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a menu to read documentation in-game. It can be accessed from the main menu. It is intended to be used by developers and players. The players will access the gameplay section of the documentation for help. Developers will access the modding section of the documentation. It is desigend to read .md files so the help files can be read on github as well.
The limitation this creates is that only markdown that is supported in this addon can be used. If you add other markdown then is supported in the addon, it will probably render fine on Github but not in-game. If additional formatting is needed, you can always contribute to that repository so everyone can use new functionality.
It can already read documentation files (not images) that were not shipped with the game from your local disk. This requires that the Documentation folder is present in the game directory so you would have to download that from the repository.
This is what it looks like in-game:
This PR introduces the basic version of the documentation reader but additional functionality could be added in the future: