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

Update Documentation in GitBook Based on Recent Changes #6

Open
ladroid opened this issue Jun 30, 2024 · 0 comments
Open

Update Documentation in GitBook Based on Recent Changes #6

ladroid opened this issue Jun 30, 2024 · 0 comments

Comments

@ladroid
Copy link
Owner

ladroid commented Jun 30, 2024

Description:

The project's documentation in GitBook needs to be updated to reflect the numerous changes listed in the changes.txt file. Ensuring the documentation is current will help users understand and utilize the new features and modifications effectively.

Links:

Changes to Document:

Below are the changes that need to be documented as per the changes.txt file:

Version 0.1.3 [Star Sprint]:

  1. Moved input handler into Preferences and removed unused parts of preferences in GUI
  2. Added Ambient Filter Component in GUI
  3. Added Audio Player in GUI
    • Added file dialogue for track path in Audio Player Component
  4. Modified saving part and logging in GUI
  5. Added build possibility on Windows, Linux, and MacOS in GUI
  6. Enabled color selection in Ambient Filter in GUI
  7. Allowed changing font and font size in Preferences, saved in settings.json in GUI
  8. Added Light component in GUI
  9. Split one big file gui.rs into smaller sub-files
  10. Added deep learning model for generating pixel character and modified GUI to show it
  11. Improved Particle System by adding new shape - circle
  12. Fixed bug with AI model system and added emscripten for generating a web-based game
  13. Added possibility to build for Web using WASM
  14. Added simple raycast
  15. Added icon and made simple platformer
  16. Added Rect class and improved Camera in two_d API, enhanced simple platformer
  17. Added fullscreen mode to Window, modified examples
  18. Modified Rect class, added WASM example, improved simple platformer

Version 0.1.2 [Galactic Gateway]:

  1. Split two_d.rs into smaller sub-files
  2. Created first game with various features (random dungeon, point light, enemies, health bar, etc.)
  3. Fixed bug with AudioPlayer, added example
  4. Updated README file
  5. Separated gui into gui folder
  6. Enabled docking - drag&drop components
  7. Added logging for GUI
  8. Modified translation to other languages in GUI
  9. Modified execute_code and execute_code_web for Linux and Windows in GUI
  10. Improved Texture component in GUI, added animation tags
  11. Added Input Handler in GUI
  12. Improved DisplayComponentTree in GUI
  13. Integrated VSCode in GUI
  14. Added logging for some parts of execution
  15. Fixed function
  16. Modified execute_code, logging updates
  17. Modified launch project and execute_code in GUI

Version 0.1.1 [Quasar Quest]:

  1. Improved Animation class
  2. Enhanced PointLight
  3. Added AmbientLightFilter
  4. Improved examples, added more examples
  5. Added Spot Light
  6. Added rounded/not rounded buttons
  7. Added simple profiler
  8. Integrated GEvent for keyboards
  9. Improved Dialogue System

Steps to Update:

  1. Review the changes.txt file for all listed modifications and enhancements.
  2. Update the relevant sections in the GitBook documentation to reflect these changes.
  3. Ensure that new features are documented with usage examples and any necessary setup instructions.
  4. Verify that all modified examples in the codebase are reflected in the documentation.
  5. Update the changelog or release notes in the documentation accordingly.
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

No branches or pull requests

1 participant