fix #70
fix #70
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @MakinoharaShoko, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request undertakes a substantial update and reorganization of the WebGAL visual novel engine's documentation across English, Japanese, and Chinese languages. The primary goal is to enhance user understanding and feature discoverability by introducing new comprehensive guides for advanced functionalities like Spine animation and intro presentations, while also expanding and clarifying existing script command references with additional parameters and practical examples. The changes aim to provide a more structured, detailed, and user-friendly documentation experience.
Highlights
- Documentation Structure Refinement: The sidebar navigation for English, Japanese, and Chinese versions has been significantly reorganized. The 'WebGAL Script Tutorial' sections are now grouped into collapsible categories (Basic Features, Visual Content, Audio & Video, Interaction & Flow, Advanced Features), and new top-level entries for 'Deploy or Publish My Visual Novel?' (with sub-sections for web, desktop, android) and 'Spine' have been added.
- New Feature Documentation: Comprehensive new documentation pages have been added for Spine animation usage, intro presentations, and a collection of 'other features' including film mode, advanced CG/BGM unlocking, textbox control, dynamic UI style switching, debug features, end game, and wait commands.
- Enhanced Script Command Details: Existing script command documentation has been updated with more detailed explanations, new parameters, and clearer examples. This includes advanced animation parameters (e.g., brightness, contrast, bevel, bloom), BGM and voice unlock features, user input capabilities, advanced variable expression support, and various other command clarifications.
- Terminology and Typo Corrections: Several terms have been corrected for clarity and consistency (e.g., '立ち絵' to 'figures', '演出効果' to 'performance effects'), and a typo in animation names ('enter-from-right' to 'enter-from-left') has been fixed across the documentation.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request restructures the documentation, adds new documentation for features, and includes various fixes. Key areas for improvement include addressing inconsistencies in Spine animation documentation, linking new documentation files, and reducing documentation duplication.
| { | ||
| text: "Deploy or Publish My Visual Novel?", | ||
| link: "publish/", | ||
| collapsible: true, | ||
| prefix: "publish/", | ||
| children: [ | ||
| "web", | ||
| "desktop", | ||
| "android", | ||
| ] | ||
| }, |
There was a problem hiding this comment.
The file src/en/webgal-script/spine.md was added, containing updated documentation for Spine scripting. However, the sidebar configuration still points to the old src/en/spine.md file. Also, the new spine.md file is not included in the "WebGAL Script Tutorial" group.
Update the sidebar to point to the new documentation file, or merge the content from the new file into the old one to avoid confusion. Having two different documents, one of which is unlinked, is not ideal.
| { | ||
| text: "ビジュアルノベルをデプロイまたは公開する？", | ||
| link: "publish/", | ||
| collapsible: true, | ||
| prefix: "publish/", | ||
| children: [ | ||
| "web", | ||
| "desktop", | ||
| "android", | ||
| ] | ||
| }, |
There was a problem hiding this comment.
The file src/ja/webgal-script/spine.md was added, containing updated documentation for Spine scripting. However, the sidebar configuration still points to the old src/ja/spine.md file. Also, the new spine.md file is not included in the "WebGAL Script チュートリアル" group.
Update the sidebar to point to the new documentation file, or merge the content from the new file into the old one to avoid confusion. Having two different documents, one of which is unlinked, is not ideal.
| ### Animation Control | ||
|
|
||
| #### Switching Actions | ||
|
|
||
| You can use the `-motion` parameter to switch Spine animations, just like Live2D: | ||
|
|
||
| ``` ws | ||
| changeFigure:character.skel -motion=idle; | ||
| changeFigure:character.skel -motion=walk -left; | ||
| ``` | ||
|
|
||
| #### Custom ID Spine Figures | ||
|
|
||
| You can specify custom IDs for Spine figures and then use the `-motion` parameter to control animations: | ||
|
|
||
| ``` ws | ||
| changeFigure:character.skel -id=mainCharacter -left; | ||
| changeFigure:character.skel -id=mainCharacter -motion=happy; | ||
| ``` |
There was a problem hiding this comment.
There's an inconsistency in how to control Spine animations. This section suggests using changeFigure with the -motion parameter (e.g., changeFigure:character.skel -motion=walk -left;). However, src/en/webgal-script/spine.md suggests using the setAnimation command (e.g., setAnimation:walk -target=fig-left;).
Clarify which is the correct method and ensure all related documentation is consistent to prevent user confusion.
| ``` | ||
| changeFigure:exampleSpine/data.json?type=spine; | ||
| ``` | ||
|
|
There was a problem hiding this comment.
There's an inconsistency in how to control Spine animations. This section suggests using changeFigure with the -motion parameter (e.g., changeFigure:character.skel -motion=walk -left;), while src/ja/webgal-script/spine.md suggests using the setAnimation command (e.g., setAnimation:walk -target=fig-left;).
Clarify which is the correct method and ensure all related documentation is consistent to prevent user confusion.
| ## Film Mode | ||
|
|
||
| Film mode creates a more immersive viewing experience, similar to a video player's "cinema mode". | ||
|
|
||
| ### Enable Film Mode | ||
|
|
||
| ``` ws | ||
| filmMode:on; // Enable film mode | ||
| filmMode:cinematic; // Enable film mode (with parameter) | ||
| ``` | ||
|
|
||
| ### Disable Film Mode | ||
|
|
||
| ``` ws | ||
| filmMode:; // Disable film mode | ||
| filmMode:none; // Disable film mode | ||
| ``` | ||
|
|
||
| ### Features | ||
|
|
||
| - Hides some UI elements | ||
| - Takes effect immediately, doesn't block script execution | ||
| - Suitable for important plot points or special scenes | ||
|
|
||
| ### Usage Example | ||
|
|
||
| ``` ws | ||
| ; Enter important plot scene | ||
| filmMode:on; | ||
| changeBg:important_scene.jpg; | ||
| This is important plot dialogue...; | ||
| ; Exit film mode after plot ends | ||
| filmMode:; | ||
| ``` | ||
|
|
||
| ## Unlock CG | ||
|
|
||
| Besides automatically unlocking CG when changing backgrounds, you can also unlock CG separately without displaying it. | ||
|
|
||
| ### Basic Usage | ||
|
|
||
| ``` ws | ||
| unlockCg:cg/scene1.jpg; | ||
| ``` | ||
|
|
||
| ### Set CG Name and Series | ||
|
|
||
| ``` ws | ||
| unlockCg:cg/ending_a.jpg -name=Happy Ending; | ||
| unlockCg:cg/chapter2_01.jpg -name=First Meeting -series=Chapter 2; | ||
| ``` | ||
|
|
||
| ### Parameter Description | ||
|
|
||
| - `-name=name` - Set display name for CG (default uses file path) | ||
| - `-series=seriesName` - Set CG series/category (default is "default") | ||
|
|
||
| ### Features | ||
|
|
||
| - Unlocked CG is saved to user data | ||
| - Supports CG category management | ||
| - Takes effect immediately, doesn't block script execution | ||
|
|
||
| ## Unlock BGM | ||
|
|
||
| You can unlock BGM to appreciation mode separately without playing it. | ||
|
|
||
| ### Basic Usage | ||
|
|
||
| ``` ws | ||
| unlockBgm:s_Title.mp3; | ||
| ``` | ||
|
|
||
| ### Set BGM Name and Series | ||
|
|
||
| ``` ws | ||
| unlockBgm:s_Title.mp3 -name=Smiling-Swinging!!!; | ||
| unlockBgm:s_Title.mp3 -name=Theme Song -series=OP; | ||
| ``` | ||
|
|
||
| ### Parameter Description | ||
|
|
||
| - `-name=name` - Set display name for BGM (default uses file path) | ||
| - `-series=seriesName` - Set BGM series/category (default is "default") | ||
|
|
||
| ## Textbox Control | ||
|
|
||
| Control the display and hiding of textboxes, suitable for fullscreen presentations. | ||
|
|
||
| ### Hide Textbox | ||
|
|
||
| ``` ws | ||
| setTextbox:hide; | ||
| ``` | ||
|
|
||
| ### Show Textbox | ||
|
|
||
| ``` ws | ||
| setTextbox:; | ||
| setTextbox:show; | ||
| ``` | ||
|
|
||
| ### Usage Scenarios | ||
|
|
||
| ``` ws | ||
| ; Display fullscreen CG | ||
| setTextbox:hide; | ||
| changeBg:fullscreen_cg.jpg; | ||
| wait:3000; | ||
| ; Restore textbox | ||
| setTextbox:; | ||
| What a beautiful scenery!; | ||
| ``` | ||
|
|
||
| ## Dynamic Style Switching | ||
|
|
||
| You can dynamically replace CSS class names of UI elements to implement theme switching and other features. | ||
|
|
||
| ### Single Style Replacement | ||
|
|
||
| ``` ws | ||
| applyStyle:textbox-default->textbox-dark; | ||
| ``` | ||
|
|
||
| ### Batch Style Replacement | ||
|
|
||
| ``` ws | ||
| applyStyle:btn-primary->btn-dark,text-light->text-dark,bg-light->bg-dark; | ||
| ``` | ||
|
|
||
| ### Usage Scenarios | ||
|
|
||
| - Dynamic theme switching (e.g., day/night mode) | ||
| - UI style changes for specific scenes | ||
| - Interface style changes based on plot needs | ||
|
|
||
| ### Example | ||
|
|
||
| ``` ws | ||
| ; Switch to night mode | ||
| applyStyle:textbox-light->textbox-dark,btn-light->btn-dark; | ||
| ; Special scene style | ||
| applyStyle:ui-normal->ui-horror; | ||
| ``` | ||
|
|
||
| ## Debug Features | ||
|
|
||
| ### Display All Variables | ||
|
|
||
| ``` ws | ||
| showVars:; | ||
| ``` | ||
|
|
||
| Displays the values of all current variables, including regular variables and global variables, in JSON format in the dialogue box. | ||
|
|
||
| ### Usage Scenarios | ||
|
|
||
| - Debug complex variable logic | ||
| - Check variable states | ||
| - Troubleshoot during development | ||
|
|
||
| ## End Game | ||
|
|
||
| Used when the game ends, returns to the title screen. | ||
|
|
||
| ``` ws | ||
| end; | ||
| ``` | ||
|
|
||
| ### Functions | ||
|
|
||
| - Reset game stage state | ||
| - Clear quick save | ||
| - Reload initial scene (start.txt) | ||
| - Play title screen BGM | ||
|
|
||
| ## Wait Command | ||
|
|
||
| Pause the game for a specified time. | ||
|
|
||
| ``` ws | ||
| wait:1000; // Wait 1 second | ||
| wait:500; // Wait 0.5 seconds | ||
| ``` | ||
|
|
||
| ### Features | ||
|
|
||
| - Time unit is milliseconds | ||
| - Automatically jumps to next statement | ||
| - Suitable for controlling presentation pacing | ||
|
|
||
| ## Usage Tips | ||
|
|
||
| 1. **Reasonable use of film mode**: Use in important plot points or special scenes, don't switch frequently | ||
| 2. **CG unlock timing**: Unlock CG at appropriate plot points to enhance player sense of achievement | ||
| 3. **Textbox control**: Mainly used for fullscreen presentations, remember to restore afterwards | ||
| 4. **Style switching**: Ensure switched styles exist to avoid style errors | ||
| 5. **Debug features**: Use frequently during development, remember to remove debug code before release | ||
|
|
||
| Although these features may seem simple, proper use can greatly enhance the game's professionalism and user experience. No newline at end of file |
There was a problem hiding this comment.
This file duplicates information for several commands that are also documented in other files. This applies to all languages.
Commands like wait, end, setTextbox, showVars are also in src/en/webgal-script/base.md. filmMode is also in src/en/webgal-script/scenes.md. unlockCg, unlockBgm are also in src/en/webgal-script/bg-and-figure.md and src/en/webgal-script/audio.md respectively. applyStyle is also in src/en/webgal-script/variable.md.
Consolidate the documentation for each command into one primary location and link to it from other relevant pages to improve maintainability and avoid future inconsistencies.
No description provided.