diff --git a/.github/ISSUE_TEMPLATE/1-ui_sprite.yml b/.github/ISSUE_TEMPLATE/1-ui_sprite.yml new file mode 100644 index 0000000000..ad87387277 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-ui_sprite.yml @@ -0,0 +1,97 @@ +name: Bug - UI and Sprite (report typos further down) +description: Report an issue with sprites, buttons, backgrounds, visual overlaps etc. +title: "[UI] " +labels: [ 'visual', 'bug' ] +body: + - type: checkboxes + id: existing_issue + attributes: + label: Pre-requisites + options: + - label: I have searched the existing issues + required: true + - label: This issue was encountered (or replicated) on a non-edited Clan + required: true + - type: textarea + id: description + attributes: + label: Description + description: Describe the bug + placeholder: "e.g. My 12 moon mediator apprentice doesn't have their accessory on the mediation screen." + validations: + required: true + - type: dropdown + id: grade + attributes: + label: Grade + description: How much of an impact does this issue have on play? + options: + - Unimportant - Little to no impact on play + - Non-vital - Can easily be ignored and does not have a large impact on play + - Regular - Should be handled soon, but doesn't necessarily break the game or inhibit the player + - Important - Has a large effect on the gameplay but is not urgent + - Dire - Still playable, but a major feature is broken + - Game-breaking - makes it impossible to play the game + default: 2 + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce the behavior + placeholder: | + 1. Go to '...' + 2. Click on '...' + 3. Scroll down to '...' + 4. See error + validations: + required: true + - type: textarea + id: patrol + attributes: + label: Patrol ID + Outcome Print (if applicable) + description: For assistance, see [\"what's a patrol ID and do I need it?\"](https://www.clangen.io/docs/report-a-bug#whats-a-patrol-id-do-i-need-it) and [\"how do I find the patrol ID?\"](https://www.clangen.io/docs/report-a-bug#how-do-i-find-the-patrol-id) + - type: input + id: version + attributes: + description: See [here](https://www.clangen.io/docs/report-a-bug/#how-do-i-find-my-game-version) for help finding your game version. + label: "Commit # or Game Version Number" + placeholder: e.g. "4ef20d05" (if on development) or "v0.12.2" (if stable) + validations: + required: true + - type: dropdown + id: fullscreen + attributes: + label: Is this bug only happening in fullscreen? + description: Answer "yes" if the issue is resolved by using windowed mode, or if it relates to fullscreen. + options: + - "No" + - "Yes" + validations: + required: true + - type: input + id: fullscreen_size + attributes: + label: If yes, what is your display size in pixels? + description: Include height and width; this can usually be found in your computer's display settings. + placeholder: e.g. 1920x1080 + - type: dropdown + id: fullscreen_config + attributes: + label: Select any visual config options you are using + description: You can select more than one. + multiple: true + options: + - Disable sprite antialiasing + - Ignore fullscreen scaling rules + - Other (specify in additional context) + - type: textarea + id: additional_context + attributes: + label: Additional context + placeholder: Add any other context about the problem here. + - type: textarea + id: screenshots + attributes: + label: Screenshots + placeholder: Add screenshots to help explain your problem. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/2-audio.yml b/.github/ISSUE_TEMPLATE/2-audio.yml new file mode 100644 index 0000000000..255adafc63 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-audio.yml @@ -0,0 +1,71 @@ +name: Bug - Audio +description: Issues related to sound, including playback, sound effects and music +title: "[AUDIO] " +labels: [ 'audio', 'bug'] +body: + - type: checkboxes + id: existing_issue + attributes: + label: Pre-requisites + options: + - label: I have searched the existing issues + required: true + - label: This issue was encountered (or replicated) on a non-edited Clan + required: true + - type: textarea + id: description + attributes: + label: Description + description: Describe the bug + placeholder: "e.g. When I enter the medicine cat den, the music stalls for a second before it resumes again." + validations: + required: true + - type: dropdown + id: grade + attributes: + label: Grade + description: How much of an impact does this issue have on play? + options: + - Unimportant - Little to no impact on play + - Non-vital - Can easily be ignored and does not have a large impact on play + - Regular - Should be handled soon, but doesn't necessarily break the game or inhibit the player + - Important - Has a large effect on the gameplay but is not urgent + - Dire - Still playable, but a major feature is broken + - Game-breaking - makes it impossible to play the game + default: 2 + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce the behavior + placeholder: | + 1. Go to '...' + 2. Click on '...' + 3. Scroll down to '...' + 4. See error + validations: + required: true + - type: textarea + id: patrol + attributes: + label: Patrol ID + Outcome Print (if applicable) + description: See [what's a patrol ID and do I need it?](https://www.clangen.io/docs/report-a-bug#whats-a-patrol-id-do-i-need-it) and [how do I find the patrol ID?](https://www.clangen.io/docs/report-a-bug#how-do-i-find-the-patrol-id) + - type: input + id: version + attributes: + description: See [here](https://www.clangen.io/docs/report-a-bug/#how-do-i-find-my-game-version) for help finding your game version. + label: "Commit # or Game Version Number" + placeholder: e.g. "4ef20d05" (if on development) or "v0.12.2" (if stable) + validations: + required: true + - type: textarea + id: additional_context + attributes: + label: Additional context + placeholder: Add any other context about the problem here. + - type: textarea + id: screenshots + attributes: + label: Screenshots/Video + placeholder: If applicable, add screenshots or video to help explain your problem. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/3-bug_report.yml b/.github/ISSUE_TEMPLATE/3-bug_report.yml new file mode 100644 index 0000000000..e87e7bf693 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-bug_report.yml @@ -0,0 +1,76 @@ +name: Bug - Code +description: General bugs related to how the game runs and responds to you. +title: "[BUG] " +labels: [ 'bug' ] +body: + - type: checkboxes + id: existing_issue + attributes: + label: Pre-requisites + options: + - label: I have searched the existing issues + required: true + - label: This issue was encountered (or replicated) on a non-edited Clan + required: true + - type: textarea + id: description + attributes: + label: Description + description: Describe the bug + placeholder: "e.g. Cats are lost in a moon event but are still in the clan cat list." + validations: + required: true + - type: dropdown + id: grade + attributes: + label: Grade + description: How much of an impact does this issue have on play? + options: + - Unimportant - Little to no impact on play + - Non-vital - Can easily be ignored and does not have a large impact on play + - Regular - Should be handled soon, but doesn't necessarily break the game or inhibit the player + - Important - Has a large effect on the gameplay but is not urgent + - Dire - Still playable, but a major feature is broken + - Game-breaking - makes it impossible to play the game + default: 2 + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce the behavior + placeholder: | + 1. Go to '...' + 2. Click on '...' + 3. Scroll down to '...' + 4. See error + validations: + required: true + - type: textarea + id: patrol + attributes: + label: Patrol ID + Outcome Print (if applicable) + description: See [what's a patrol ID and do I need it?](https://www.clangen.io/docs/report-a-bug#whats-a-patrol-id-do-i-need-it) and [how do I find the patrol ID?](https://www.clangen.io/docs/report-a-bug#how-do-i-find-the-patrol-id) + - type: input + id: version + attributes: + description: See [here](https://www.clangen.io/docs/report-a-bug/#how-do-i-find-my-game-version) for help finding your game version. + label: "Commit # or Game Version Number" + placeholder: e.g. "4ef20d05" (if on development) or "v0.12.2" (if stable) + validations: + required: true + - type: textarea + id: errormsg + attributes: + label: Error log + description: Attach the full error log here. Details on how to find the error log are given [here](https://www.clangen.io/docs/report-a-bug#how-do-i-find-the-error-log + - type: textarea + id: additional_context + attributes: + label: Additional context + placeholder: Add any other context about the problem here. + - type: textarea + id: screenshots + attributes: + label: Screenshots + placeholder: If applicable, add screenshots to help explain your problem. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/4-enhancement.yml b/.github/ISSUE_TEMPLATE/4-enhancement.yml new file mode 100644 index 0000000000..97294c0400 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4-enhancement.yml @@ -0,0 +1,9 @@ + name: Enhancement + description: Suggest changes to the existing code. This is NOT for making suggestions for the game. It's for contributors to request code changes from other contributors, usually ones that have been discussed. + title: "[ENHANCE] " + labels: ['enhancement'] + body: + - type: textarea + attributes: + label: Description + description: Please describe the changes you would like to see. Give details on the current behavior vs. the goal behavior. If you have an idea of how specifically this change could be made, explain it. diff --git a/.github/ISSUE_TEMPLATE/project.md b/.github/ISSUE_TEMPLATE/5-project.md similarity index 97% rename from .github/ISSUE_TEMPLATE/project.md rename to .github/ISSUE_TEMPLATE/5-project.md index 9e2994f794..9af8779349 100644 --- a/.github/ISSUE_TEMPLATE/project.md +++ b/.github/ISSUE_TEMPLATE/5-project.md @@ -1,7 +1,7 @@ --- name: Project about: Request assistance with a coding project. -title: "[PROJECT]" +title: "[PROJECT] " labels: 'help-wanted' --- diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index 57e76c842f..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,73 +0,0 @@ -name: Bug report -description: Create a report to help us improve -title: "[BUG] " -body: - - type: dropdown - id: type - attributes: - label: Type of bug - description: What kind of issue are you experiencing? - options: - - Please choose an option... - - UI - anything to do with the user interface - maybe a button is not working, or the way some assets are formatted seems to be off. - - Sprite - an issue with the art in the game - - Audio - issues related to the audio system - - Code - general bugs related to how the game runs and responds to you. - - 'Typo - misspellings or incorrect grammar - IMPORTANT: "bugs" of this type are collected here: https://github.com/ClanGenOfficial/clangen/issues/1818' - validations: - required: true - - type: textarea - id: description - attributes: - label: Description - description: Describe the bug - placeholder: "ex.: This bug implies that the cat is never..." - validations: - required: true - - type: dropdown - id: grade - attributes: - label: Grade - description: How much of an impact does this issue have on play? - options: - - Please choose an option... - - Game-breaking - a bug that makes it impossible to play the game - - Dire - Still playable, but a major feature is broken - - Important - The bug has a large effect on the gameplay but is not urgent - - Regular - A typical bug that should be seen to soon, but doesn't necessarily break the game or inhibit the player - - Non-vital - This bug can easily be ignored and does not have a large impact on play - - Unimportant - This bug has little to no impact on play. - validations: - required: true - - type: textarea - id: reproduce - attributes: - label: Steps to reproduce the behavior - placeholder: | - 1. Go to '...' - 2. Click on '....' - 3. Scroll down to '....' - 4. See error - validations: - required: true - - type: textarea - id: patrol - attributes: - label: Patrol ID + Outcome Print (if applicable) - placeholder: If you don't know what this means, you probably don't need to fill it out. - - type: input - id: version - attributes: - label: "Commit # or Game Version Number" - validations: - required: true - - type: textarea - id: additional_context - attributes: - label: Additional context - placeholder: Add any other context about the problem here. - - type: textarea - id: screenshots - attributes: - label: Screenshots - placeholder: If applicable, add screenshots to help explain your problem. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..9edd51715e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Bug - Typo (misspellings/improper grammar) + url: https://github.com/ClanGenOfficial/clangen/issues/1818 + about: Report an issue with text itself (spelling, punctuation, and grammar). \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md deleted file mode 100644 index c28034ac9b..0000000000 --- a/.github/ISSUE_TEMPLATE/enhancement.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -name: Enhancement -about: Suggest changes to the existing code. This is NOT for making suggestions for the game. It's for contributors to request code changes from other contributors, usually ones that have been discussed. -title: "[CODE]" -labels: 'enhancement' ---- - -**Description** -Please describe the changes you would like to see. Give details on the current behavior vs. the goal behavior. If you have an idea of how specifically this change could be made, explain it. \ No newline at end of file diff --git a/docs-resources/assets/report-a-bug/find_game_version_dev_source.png b/docs-resources/assets/report-a-bug/find_game_version_dev_source.png new file mode 100644 index 0000000000..98f9d32be7 Binary files /dev/null and b/docs-resources/assets/report-a-bug/find_game_version_dev_source.png differ diff --git a/docs-resources/assets/report-a-bug/find_game_version_stable_step1.png b/docs-resources/assets/report-a-bug/find_game_version_stable_step1.png new file mode 100644 index 0000000000..9db020a663 Binary files /dev/null and b/docs-resources/assets/report-a-bug/find_game_version_stable_step1.png differ diff --git a/docs-resources/assets/report-a-bug/find_game_version_stable_step2.png b/docs-resources/assets/report-a-bug/find_game_version_stable_step2.png new file mode 100644 index 0000000000..378b6fd33a Binary files /dev/null and b/docs-resources/assets/report-a-bug/find_game_version_stable_step2.png differ diff --git a/docs-resources/assets/report-a-bug/find_game_version_stable_step3.png b/docs-resources/assets/report-a-bug/find_game_version_stable_step3.png new file mode 100644 index 0000000000..7e15a9cd3a Binary files /dev/null and b/docs-resources/assets/report-a-bug/find_game_version_stable_step3.png differ diff --git a/docs-resources/assets/report-a-bug/find_game_version_stable_step5.png b/docs-resources/assets/report-a-bug/find_game_version_stable_step5.png new file mode 100644 index 0000000000..158240c08f Binary files /dev/null and b/docs-resources/assets/report-a-bug/find_game_version_stable_step5.png differ diff --git a/docs-resources/assets/report-a-bug/patrol_block_stdout.png b/docs-resources/assets/report-a-bug/patrol_block_stdout.png new file mode 100644 index 0000000000..25b1c77f5f Binary files /dev/null and b/docs-resources/assets/report-a-bug/patrol_block_stdout.png differ diff --git a/docs/dev/code/index.md b/docs/dev/code/index.md index 4c182a2875..c2f3d369cc 100644 --- a/docs/dev/code/index.md +++ b/docs/dev/code/index.md @@ -9,46 +9,8 @@ This will cover the basic information for code. * keep playing around with fixing bugs or adding new features. Eventually you’ll develop an intuition for where things will probably be in the codebase ## Bug Reporting -### Form -This form will be used to create bug reports in the repo in the future. - -**Type:** (only select one) - -* UI - anything to do with the user interface. Maybe a button is not working, or the way some assets are formatted seems to be off. -* Sprite - an issue with the art in the game -* Code - general bugs related to how the game runs and responds to you. -* Typo - misspellings or incorrect grammar - IMPORTANT: this type of "bugs" are collected in the [typo tracking issue](https://github.com/ClanGenOfficial/clangen/issues/1818) - -**Describe the bug** -ex.: This bug implies that the cat is never .... - -**Grade:** (only select one) - -* Game-breaking - a bug that makes it impossible to play the game -* Dire - Still playable, but a major feature is broken -* Important - The bug has a large affect on the gameplay, but is not urgent -* Regular - A typical bug that should be seen to soon, but doesn’t necessarily break the game or inhibit the player -* Non-vital - This bug can easily be ignored and does not have a large impact on play -* Unimportant - This bug has little to no impact on play. - -**Reproduce** -Steps to reproduce the behavior: - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Patrol ID + Outcome Print (if applicable):** - -**Screenshots:** -If applicable, add screenshots to help explain your problem. - -**Commit # or Game Version Number:** - -**Additional context** -Add any other context about the issue here. +See [report a bug](../../report-a-bug.md). ## Game Config The [game config](https://github.com/ClanGenOfficial/clangen/blob/development/resources/game_config.json), found in resources/game_config.json, holds several developmental settings that are used within ClanGen. These settings are diff --git a/docs/report-a-bug.md b/docs/report-a-bug.md new file mode 100644 index 0000000000..ebc833bcc5 --- /dev/null +++ b/docs/report-a-bug.md @@ -0,0 +1,98 @@ +# Reporting a Bug + +Thank you for your interest in helping improve ClanGen! We're sorry to hear you've encountered issues, and we hope we +can help resolve them! + +### Bugs as a result of save editing + +A quick aside before we begin: ClanGen does not support editing your own saves manually. Although we host resources that +help you do so, these are player-maintained and not affiliated with ClanGen in any way. Bugs as a result of save-editing +will NOT be investigated or fixed, and any issues that arise as a result of editing saves are the player's sole +responsibility. + +!!! warning "Reporting bugs with edited saves" +Do not submit bug reports for bugs encountered on an edited save. If you encounter a bug whilst playing on an edited +save, only report it if you can replicate it in an unedited save. + +Good to go? Head to +the [new issue page on GitHub (opens in a new window)](https://github.com/ClanGenOfficial/clangen/issues/new/choose){: +target=none}. + +## FAQs + +- [How do I find my game version?](#how-do-i-find-my-game-version) +- [What's a patrol ID? Do I need it?](#whats-a-patrol-id-do-i-need-it) +- [How do I find the patrol ID?](#how-do-i-find-the-patrol-id) +- [How do I find the error log?](#how-do-i-find-the-error-log) + +### How do I find my game version? + +#### Playing stable + +1. If you can open the game, press the settings + info button + ![Main menu of ClanGen, the fourth menu button is highlighted](assets/report-a-bug/find_game_version_stable_step1.png) + !!! tip "Can't open the game?" + Jump to [can't open the game](#cant-open-the-game). +2. Press "Open Data Directory". This will open a file explorer on your computer. + ![Settings screen with bottom-left button highlighted](assets/report-a-bug/find_game_version_stable_step2.png) +3. Open the "logs" folder. + ![File system with logs folder highlighted](assets/report-a-bug/find_game_version_stable_step3.png) +4. Find the most recent stdout file and open it in Notepad or a similar text editing program. +5. Copy the version number from the third line, "Running on commit [...]" + ![Stdout log with the correct version number highlighted](assets/report-a-bug/find_game_version_stable_step5.png) + !!! tip + If you don't see something that looks like this, ensure you selected std**OUT**, not std**ERR**. + +#### Playing development + +On development versions of ClanGen, the commit number is in the bottom-right of every screen. +![ClanGen main menu with commit number highlighted](assets/report-a-bug/find_game_version_dev_source.png) + +#### Can't open the game? + +If the game immediately crashes, you can get to the default log location manually. + +=== "Stable (executable)" +| Operating System | Default Location | +|------------------|--------------------------------------------------------------| +| Windows | `C:\Users\[current user]\AppData\Local\ClanGen\ClanGen\logs` | +| Mac | | +| Linux | | +!!! todo +...what are the default locations for other OSes? + +=== "Stable (from source)" +Wherever the active source files are stored, inside a folder called `logs`. + +=== "Development (executable)" +| Operating System | Default Location | +|------------------|------------------------------------------------------------------| +| Windows | `C:\Users\[current user]\AppData\Local\ClanGen\ClanGenBeta\logs` | +| Mac | | +| Linux | | +!!! todo +...what are the default locations for other OSes? + +=== "Development (from source)" +Wherever the running source files are stored, inside a folder called `logs`. + +### What's a patrol ID? Do I need it? + +The patrol ID is a string that the game and developers use to refer to the sequence of events in a patrol. It might look +like this: `gen_hunt_rabbit`. + +If you encountered your issue on the Patrol screen at some point after selecting cats, we'll want the patrol ID to +investigate what happened. + +### How do I find the patrol ID? + +See the section on [finding your game version](#how-do-i-find-my-game-version) to find the stdout file. Scroll right to +the bottom of that file and find the affected patrol (it can be identified by which cats were on it if it's not the last +one). +![Patrol block in `stdout` with patrol ID and outcome highlighted](assets/report-a-bug/patrol_block_stdout.png) + +### How do I find the error log? + +See the section on [finding your game version](#how-do-i-find-my-game-version) to find the logs directory. Instead of +selecting `stdout`, find and upload the most recent `stderr`. You can either upload the file or copy its contents, but +the entire file's contents are required. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index b0865b2505..5d6f69f136 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,6 +6,7 @@ edit_uri: https://github.com/ClanGenOfficial/clangen/edit/development/docs/ nav: - Welcome: - index.md + - report-a-bug.md - Developer Documentation: - dev/index.md - Project Basics: @@ -100,6 +101,7 @@ extra_css: # if you add an extension, add a link to it's matching documentation to contributing/documentation-resources.md markdown_extensions: - abbr + - attr_list - admonition - pymdownx.details - pymdownx.superfences