antivirak / japonsko-vn

RenPy visual novel about gaijin trip to japan
0 stars 0 forks source link

feature/dictionary - added dictionary feature #60

Closed CaptainAgilek closed 1 month ago

CaptainAgilek commented 2 months ago

Summary by Sourcery

Add a dictionary feature to the game, providing definitions for various Japanese terms. Enhance the user interface by replacing the stats button overlay with a right-side menu overlay in the story script.

New Features:

Enhancements:

sourcery-ai[bot] commented 2 months ago

Reviewer's Guide by Sourcery

This pull request implements a new dictionary feature and updates the UI by replacing the stats button overlay with a right-side menu overlay. The changes involve modifying the game's UI and introducing a new Dictionary class to manage game-specific terms and their descriptions.

User journey diagram for updated UI with right-side menu overlay

journey
    title User Journey with Right-Side Menu Overlay
    section Before Update
      User: Click on stats button
      User: View stats overlay
    section After Update
      User: Access right-side menu
      User: View additional options
      User: Navigate through menu items

Class diagram for the new Dictionary class

classDiagram
    class Dictionary {
        +content: dict
        +__init__()
        +add_item(key: str, description: str)
    }

File-Level Changes

Change Details Files
Replaced stats button overlay with right-side menu overlay
  • Removed 'show screen stats_button_overlay'
  • Added 'show screen right_side_menu_overlay'
game/story/akt1.rpy
Implemented a new Dictionary class for managing game-specific terms
  • Created a Dictionary class with a predefined content dictionary
  • Implemented an add_item method to add new entries to the dictionary
  • Included various Japanese terms and game-specific concepts in the initial dictionary content
game/dictionary/dictionary_ren.py

Tips and commands #### Interacting with Sourcery - **Trigger a new review:** Comment `@sourcery-ai review` on the pull request. - **Continue discussions:** Reply directly to Sourcery's review comments. - **Generate a GitHub issue from a review comment:** Ask Sourcery to create an issue from a review comment by replying to it. - **Generate a pull request title:** Write `@sourcery-ai` anywhere in the pull request title to generate a title at any time. - **Generate a pull request summary:** Write `@sourcery-ai summary` anywhere in the pull request body to generate a PR summary at any time. You can also use this command to specify where the summary should be inserted. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) to: - Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others. - Change the review language. - Add, remove or edit custom review instructions. - Adjust other review settings. #### Getting Help - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).