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.

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

Add documentation menu #7

Merged
merged 2 commits into from
Nov 21, 2023

Conversation

snipercup
Copy link
Collaborator

@snipercup snipercup commented Nov 5, 2023

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:
image

This PR introduces the basic version of the documentation reader but additional functionality could be added in the future:

  1. Ability to read images from the local disk that were not shipped with the game (for mods). This requires dynamic resource loading which will be useful for other modding applications as well
  2. An in-game documentation editor
  3. Mod support so any mod can have its own documentation directory

Adds a button on the home screen to the documentation scene and the documentation scene itself
@Khaligufzel Khaligufzel merged commit c49ae8d into Khaligufzel:main Nov 21, 2023
@snipercup snipercup deleted the add-documentation-menu branch November 21, 2023 23:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants