diff --git a/.github/ISSUE_TEMPLATE/1-crash.yml b/.github/ISSUE_TEMPLATE/1-crash.yml new file mode 100644 index 00000000..adb68726 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-crash.yml @@ -0,0 +1,65 @@ +name: Crash +description: The game closes, freezes or shows a FATAL message. +labels: [bug, crash] +body: + - type: markdown + attributes: + value: | + Check the pinned issues at the top of the issue list first: they cover the known crashes and their workarounds. + + Do not attach or link game files, keys, firmware or builds. Issues that do are closed. + - type: checkboxes + id: duplicates + attributes: + label: Existing issues + options: + - label: I read the pinned issues and [searched open and closed issues](https://github.com/valentderah/totk-pc-recomp/issues?q=is%3Aissue) for this crash. + required: true + - type: input + id: version + attributes: + label: Version + description: The title line of the settings menu (F1), for example "TotK Recomp 0.1.0, game 1.4.3". + validations: + required: true + - type: input + id: system + attributes: + label: GPU, driver and Windows version + description: Copy system info in the menu's Advanced tab puts them on the clipboard. + validations: + required: true + - type: dropdown + id: when + attributes: + label: When does it crash? + options: + - At startup, before the Nintendo logo + - Between the Nintendo logo and the title screen + - While loading a save + - In gameplay + - In a cutscene + validations: + required: true + - type: dropdown + id: blocker + attributes: + label: Can you keep playing? + options: + - "Yes, it does not happen again after a restart, or I can avoid it" + - "No, it happens every time at the same point" + validations: + required: true + - type: textarea + id: steps + attributes: + label: What you did before the crash + validations: + required: true + - type: textarea + id: log + attributes: + label: Log + description: Attach logs\totk.log from the folder of totk.exe. Copy it before you start the game again, because the next start overwrites it. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/2-graphics.yml b/.github/ISSUE_TEMPLATE/2-graphics.yml new file mode 100644 index 00000000..bf297032 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-graphics.yml @@ -0,0 +1,59 @@ +name: Graphics glitch +description: Artifacts, missing or broken textures, flicker, wrong colours or shadows. +labels: [bug, graphics] +body: + - type: markdown + attributes: + value: | + Check the pinned issues at the top of the issue list first: they cover the known glitches on each GPU. + + Do not attach or link game files, keys, firmware or builds. Issues that do are closed. + - type: checkboxes + id: duplicates + attributes: + label: Existing issues + options: + - label: I read the pinned issues and [searched open and closed issues](https://github.com/valentderah/totk-pc-recomp/issues?q=is%3Aissue) for this glitch. + required: true + - type: input + id: version + attributes: + label: Version + description: The title line of the settings menu (F1), for example "TotK Recomp 0.1.0, game 1.4.3". + validations: + required: true + - type: input + id: system + attributes: + label: GPU, driver and Windows version + description: Copy system info in the menu's Advanced tab puts them on the clipboard. + validations: + required: true + - type: textarea + id: screenshot + attributes: + label: Screenshot or video + description: Drag the file into this field. Say where in the game it was taken. + validations: + required: true + - type: textarea + id: details + attributes: + label: What looks wrong and when + description: Does it show all the time, in one place, or after some time in play? Which settings did you change from the defaults? + validations: + required: true + - type: dropdown + id: blocker + attributes: + label: Can you keep playing? + options: + - "Yes" + - "No, I cannot see enough to play" + validations: + required: true + - type: textarea + id: log + attributes: + label: Log + description: Attach logs\totk.log from the folder of totk.exe. diff --git a/.github/ISSUE_TEMPLATE/3-bug.yml b/.github/ISSUE_TEMPLATE/3-bug.yml new file mode 100644 index 00000000..20d7087f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-bug.yml @@ -0,0 +1,65 @@ +name: Other bug +description: Sound, controls, performance, the settings menu, the installer, or game logic. +labels: [bug] +body: + - type: markdown + attributes: + value: | + Check the pinned issues at the top of the issue list first. + + Do not attach or link game files, keys, firmware or builds. Issues that do are closed. + - type: checkboxes + id: duplicates + attributes: + label: Existing issues + options: + - label: I read the pinned issues and [searched open and closed issues](https://github.com/valentderah/totk-pc-recomp/issues?q=is%3Aissue) for this bug. + required: true + - type: dropdown + id: area + attributes: + label: Area + options: + - Audio + - Controls and input + - Performance and stutter + - Settings menu and overlay + - Installer + - Game logic and physics + - Something else + validations: + required: true + - type: input + id: version + attributes: + label: Version + description: The title line of the settings menu (F1), for example "TotK Recomp 0.1.0, game 1.4.3". + validations: + required: true + - type: input + id: system + attributes: + label: GPU, driver and Windows version + description: Copy system info in the menu's Advanced tab puts them on the clipboard. + validations: + required: true + - type: dropdown + id: blocker + attributes: + label: Can you keep playing? + options: + - "Yes" + - "No, it stops the game or a quest" + validations: + required: true + - type: textarea + id: steps + attributes: + label: What happened and how to reproduce it + validations: + required: true + - type: textarea + id: log + attributes: + label: Log + description: Attach logs\totk.log from the folder of totk.exe. diff --git a/.github/ISSUE_TEMPLATE/4-feature.yml b/.github/ISSUE_TEMPLATE/4-feature.yml new file mode 100644 index 00000000..7d2f4ffe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4-feature.yml @@ -0,0 +1,17 @@ +name: Feature request +description: A setting, option or support for something the port does not do yet. +labels: [enhancement] +body: + - type: checkboxes + id: duplicates + attributes: + label: Existing issues + options: + - label: I [searched open and closed issues](https://github.com/valentderah/totk-pc-recomp/issues?q=is%3Aissue) and the Planned section of the README for this request. + required: true + - type: textarea + id: request + attributes: + label: What you want and why + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml deleted file mode 100644 index eb22ae3b..00000000 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ /dev/null @@ -1,32 +0,0 @@ -name: Bug report -description: Something breaks, crashes or looks wrong. -body: - - type: markdown - attributes: - value: | - Do not attach or link game files, keys, firmware or builds. Issues that do are closed. - - type: input - id: version - attributes: - label: Version - description: The title line of the settings menu (F1), for example "TotK Recomp 0.1.0, game 1.4.3". - validations: - required: true - - type: input - id: system - attributes: - label: GPU, driver and Windows version - description: Copy system info in the menu's Advanced tab puts them on the clipboard. - validations: - required: true - - type: textarea - id: steps - attributes: - label: What happened and how to reproduce it - validations: - required: true - - type: textarea - id: log - attributes: - label: Log - description: Attach logs\totk.log from the folder of totk.exe. After a crash, copy it before you start the game again. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 3ba13e0c..7e047e82 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1 +1,5 @@ blank_issues_enabled: false +contact_links: + - name: Question or help with setup + url: https://github.com/valentderah/totk-pc-recomp/discussions + about: Installing, updating and configuring the port. Ask in Discussions.