From e2cd076c3967d354ce305ecd6680acc588a662ab Mon Sep 17 00:00:00 2001 From: IThundxr Date: Sun, 27 Jul 2025 20:57:24 -0400 Subject: [PATCH 1/8] Issue templates --- .github/ISSUE_TEMPLATE/bug.yml | 38 ++++++++ .github/ISSUE_TEMPLATE/bug_report.yml | 127 -------------------------- .github/ISSUE_TEMPLATE/config.yml | 4 + .github/ISSUE_TEMPLATE/crash.yml | 26 ++++++ 4 files changed, 68 insertions(+), 127 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/crash.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 000000000..cd1464ecb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,38 @@ +name: I found a bug! +description: "Report some other kind of issue. You should ask in the Discord first to make sure it's actually a bug with Flywheel." +labels: [ "type: bug" ] +body: + - type: textarea + attributes: + label: Description + description: > + Please describe the issue with as much detail as possible. + Explain what happened, and what should have happened instead. + Add images, screenshots, or videos if they could be useful. + validations: + required: true + + - type: input + attributes: + label: Game Log + description: > + We need the game log for additional information about the bug. + This file can be found in the \"logs\" folder of your Minecraft folder as \"latest.log\". + Please upload the file to https://mclo.gs/ and put the link here. + Do **not** paste the *contents* of the file here, because that will make this issue very hard to read. + validations: + required: true + + - type: textarea + attributes: + label: Debug Information + description: > + Please run the \"/flywheel info\" command in-game. + This will allow you to copy useful information to your clipboard that will greatly help with debugging. + Please paste this information here. + validations: + required: true + + - type: markdown + attributes: + value: "Thank you for taking the time to make a report and help improve Flywheel!" diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index 3dbe6f0b0..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,127 +0,0 @@ -name: Bug Report -description: Create a bug report to help us improve Flywheel -labels: [ "bug" ] -body: - - type: textarea - attributes: - label: Describe the Bug - description: A clear and concise description of what the bug is - validations: - required: true - - type: textarea - attributes: - label: Reproduction Steps - description: Tell us about the steps to reproduce the bug - value: | - 1. - 2. - 3. - ... - validations: - required: true - - type: textarea - attributes: - label: Expected Result - description: A clear and concise description of what you expected to happen - validations: - required: true - - type: textarea - attributes: - label: Screenshots and Videos - description: If applicable, add screenshots or videos to help explain your problem - validations: - required: false - - type: input - attributes: - label: Crash Report or Log - description: If applicable, please add a link to the crash report or log that was created when this issue occured - validations: - required: false - - type: markdown - attributes: - value: "*[Pastebin](https://pastebin.com/) is standard.*" - - type: input - attributes: - label: Operating System - description: The operating system you were using when the bug occured - placeholder: Windows 11 - validations: - required: true - - type: input - attributes: - label: What is your GPU? - description: Enter the vendor and model of the GPU you were using when the bug occured - placeholder: Nvidia GeForce RTX 3060 - validations: - required: true - - type: dropdown - attributes: - label: Mod Version - description: The version of the mod you were using when the bug occured - options: - - "0.6.8.a" - - "0.6.8" - - "0.6.7" - - "0.6.6" - - "0.6.5" - - "0.6.4" - - "0.6.3" - - "0.6.2" - - "0.6.1" - - "0.6.0" - - "0.5.1" - - "0.5.0a" - - "0.5.0" - - "0.4.2-rc" - - "0.4.1" - - "0.4.0" - - "0.3.0" - - "0.2.5" - - "0.2.4" - - "0.2.3" - - "0.2.2" - - "0.2.1" - - "0.2.0" - - "0.1.1" - - "0.1.0" - - "0.0.3" - - "0.0.2" - - "0.0.1" - validations: - required: true - - type: dropdown - attributes: - label: Minecraft Version - description: The version of Minecraft you were using when the bug occured - options: - - "1.19.2" - - "1.18.2" - - "1.18.1" - - "1.18" - - "1.17.1" - - "1.16.5" - - "1.16.4" - validations: - required: true - - type: input - attributes: - label: Loader Version - description: The version of Forge or Fabric you were using when the bug occured - placeholder: Forge 39.0.0 - validations: - required: true - - type: textarea - attributes: - label: Other Mods - description: Please list any other mods that were running when the crash happened - validations: - required: false - - type: textarea - attributes: - label: Additional Context - description: Add any extra context about the bug here - validations: - required: false - - type: markdown - attributes: - value: "Thank you for taking the time to make this bug report and to help improve Flywheel" diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..d384d5e09 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,4 @@ +contact_links: + - name: Discord Server + url: https://discord.gg/ambsHEyaAD + about: Join us on Discord. diff --git a/.github/ISSUE_TEMPLATE/crash.yml b/.github/ISSUE_TEMPLATE/crash.yml new file mode 100644 index 000000000..43754dd7a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/crash.yml @@ -0,0 +1,26 @@ +name: My game crashed! +description: Report an issue that crashes the game. +labels: [ "type: crash" ] +body: + - type: textarea + attributes: + label: Context + description: What were you doing when the game crashed? Add images, screenshots, or videos if they could be useful. + validations: + required: true + + - type: input + attributes: + label: Crash Report + description: > + We need the crash report to figure out why the crash happened. + This file can be found in the \"crash-reports\" folder of your Minecraft folder. + It will be the newest file there. + Please upload the file to https://mclo.gs/ and put the link here. + Do **not** paste the *contents* of the file here, because that will make this issue very hard to read. + validations: + required: true + + - type: markdown + attributes: + value: "Thank you for taking the time to make a report and help improve Flywheel!" From 6b7b9a0d88ac59dadbbbf9a831e88c88c74c5989 Mon Sep 17 00:00:00 2001 From: IThundxr Date: Sun, 27 Jul 2025 21:04:08 -0400 Subject: [PATCH 2/8] Update template --- .github/ISSUE_TEMPLATE/bug.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index cd1464ecb..34a9ac614 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -13,6 +13,7 @@ body: required: true - type: input + id: game_log attributes: label: Game Log description: > @@ -24,6 +25,7 @@ body: required: true - type: textarea + id: debug_info attributes: label: Debug Information description: > From d7fbb88821b70b95f14a6d042269005c7b1d900d Mon Sep 17 00:00:00 2001 From: IThundxr Date: Sun, 27 Jul 2025 21:30:36 -0400 Subject: [PATCH 3/8] Remove id's for autofill --- .github/ISSUE_TEMPLATE/bug.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 34a9ac614..cd1464ecb 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -13,7 +13,6 @@ body: required: true - type: input - id: game_log attributes: label: Game Log description: > @@ -25,7 +24,6 @@ body: required: true - type: textarea - id: debug_info attributes: label: Debug Information description: > From 128b4a51cdef54e42602a706aa73d997d244db03 Mon Sep 17 00:00:00 2001 From: IThundxr Date: Sun, 27 Jul 2025 21:30:43 -0400 Subject: [PATCH 4/8] Fix command --- .github/ISSUE_TEMPLATE/bug.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index cd1464ecb..c63b47ab9 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -27,7 +27,7 @@ body: attributes: label: Debug Information description: > - Please run the \"/flywheel info\" command in-game. + Please run the \"/flywheel debug info\" command in-game. This will allow you to copy useful information to your clipboard that will greatly help with debugging. Please paste this information here. validations: From 828e43f1859566de910d628f7e0c41becc068d41 Mon Sep 17 00:00:00 2001 From: IThundxr Date: Sun, 27 Jul 2025 21:35:55 -0400 Subject: [PATCH 5/8] Improve command formatting --- .../engine_room/flywheel/impl/FlwDebugInfo.java | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/common/src/main/java/dev/engine_room/flywheel/impl/FlwDebugInfo.java b/common/src/main/java/dev/engine_room/flywheel/impl/FlwDebugInfo.java index daabe6627..0f3e22c9d 100644 --- a/common/src/main/java/dev/engine_room/flywheel/impl/FlwDebugInfo.java +++ b/common/src/main/java/dev/engine_room/flywheel/impl/FlwDebugInfo.java @@ -51,21 +51,32 @@ public static Component getDebugCommandInfo() { addVisualizationManagerDebugInfo(manager, out); // Write out to a string both to emit to chat and include in the click event. - var debugInfoString = out.toString(); + String debugInfoString = out.toString(); return Component.literal(debugInfoString) .append(Component.literal("\n\nClick to copy debug info to clipboard") .withStyle(Style.EMPTY.withUnderlined(true) - .withClickEvent(new ClickEvent(ClickEvent.Action.COPY_TO_CLIPBOARD, debugInfoString)) + .withClickEvent(new ClickEvent(ClickEvent.Action.COPY_TO_CLIPBOARD, formatForIssue(debugInfoString))) .withHoverEvent(new HoverEvent(HoverEvent.Action.SHOW_TEXT, Component.literal(debugInfoString))))) .append(Component.literal("\n\nClick to open an issue on GitHub") .withStyle(Style.EMPTY.withUnderlined(true) .withColor(ChatFormatting.BLUE) - .withClickEvent(new ClickEvent(ClickEvent.Action.OPEN_URL, "https://github.com/Engine-Room/Flywheel/issues")) + .withClickEvent(new ClickEvent(ClickEvent.Action.OPEN_URL, "https://github.com/Engine-Room/Flywheel/issues/new")) .withHoverEvent(new HoverEvent(HoverEvent.Action.SHOW_TEXT, Component.literal("Opens URL:\nhttps://github.com/Engine-Room/Flywheel/issues"))))); } + private static String formatForIssue(String original) { + return """ +
+ Debug Info + + %s + +
+ """.formatted(original); + } + private static void addBackendDebugInfo(@Nullable VisualizationManagerImpl manager, StringBuilder out) { appendHeader(out, "Backend"); From 6f164159541d1580b91d3f96d7afb207502b7fb7 Mon Sep 17 00:00:00 2001 From: IThundxr Date: Wed, 3 Sep 2025 16:26:42 -0400 Subject: [PATCH 6/8] fix template --- .github/ISSUE_TEMPLATE/bug.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index c63b47ab9..c2a97e852 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -1,5 +1,5 @@ name: I found a bug! -description: "Report some other kind of issue. You should ask in the Discord first to make sure it's actually a bug with Flywheel." +description: "Report some other kind of issue." labels: [ "type: bug" ] body: - type: textarea @@ -17,7 +17,7 @@ body: label: Game Log description: > We need the game log for additional information about the bug. - This file can be found in the \"logs\" folder of your Minecraft folder as \"latest.log\". + This file can be found in the `logs` folder of your Minecraft folder as \"debug.log\". Please upload the file to https://mclo.gs/ and put the link here. Do **not** paste the *contents* of the file here, because that will make this issue very hard to read. validations: @@ -27,7 +27,7 @@ body: attributes: label: Debug Information description: > - Please run the \"/flywheel debug info\" command in-game. + Please run the `/flywheel debug info` command in-game. This will allow you to copy useful information to your clipboard that will greatly help with debugging. Please paste this information here. validations: From 3dc440b26d34993b7628c82d6af33469fcbc9967 Mon Sep 17 00:00:00 2001 From: IThundxr Date: Wed, 3 Sep 2025 16:27:16 -0400 Subject: [PATCH 7/8] update formatting --- .github/ISSUE_TEMPLATE/bug.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index c2a97e852..209d81fb6 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -17,7 +17,7 @@ body: label: Game Log description: > We need the game log for additional information about the bug. - This file can be found in the `logs` folder of your Minecraft folder as \"debug.log\". + This file can be found in the `logs` folder of your Minecraft folder as `debug.log`. Please upload the file to https://mclo.gs/ and put the link here. Do **not** paste the *contents* of the file here, because that will make this issue very hard to read. validations: From 5e4a9a0ddd0ce3be1dc5770d69cd69c631a09978 Mon Sep 17 00:00:00 2001 From: IThundxr Date: Wed, 3 Sep 2025 16:28:14 -0400 Subject: [PATCH 8/8] address reviews --- .../engine_room/flywheel/impl/FlwDebugInfo.java | 15 ++------------- 1 file changed, 2 insertions(+), 13 deletions(-) diff --git a/common/src/main/java/dev/engine_room/flywheel/impl/FlwDebugInfo.java b/common/src/main/java/dev/engine_room/flywheel/impl/FlwDebugInfo.java index 0f3e22c9d..269fb9c20 100644 --- a/common/src/main/java/dev/engine_room/flywheel/impl/FlwDebugInfo.java +++ b/common/src/main/java/dev/engine_room/flywheel/impl/FlwDebugInfo.java @@ -56,27 +56,16 @@ public static Component getDebugCommandInfo() { return Component.literal(debugInfoString) .append(Component.literal("\n\nClick to copy debug info to clipboard") .withStyle(Style.EMPTY.withUnderlined(true) - .withClickEvent(new ClickEvent(ClickEvent.Action.COPY_TO_CLIPBOARD, formatForIssue(debugInfoString))) + .withClickEvent(new ClickEvent(ClickEvent.Action.COPY_TO_CLIPBOARD, debugInfoString)) .withHoverEvent(new HoverEvent(HoverEvent.Action.SHOW_TEXT, Component.literal(debugInfoString))))) .append(Component.literal("\n\nClick to open an issue on GitHub") .withStyle(Style.EMPTY.withUnderlined(true) .withColor(ChatFormatting.BLUE) .withClickEvent(new ClickEvent(ClickEvent.Action.OPEN_URL, "https://github.com/Engine-Room/Flywheel/issues/new")) - .withHoverEvent(new HoverEvent(HoverEvent.Action.SHOW_TEXT, Component.literal("Opens URL:\nhttps://github.com/Engine-Room/Flywheel/issues"))))); + .withHoverEvent(new HoverEvent(HoverEvent.Action.SHOW_TEXT, Component.literal("Opens URL:\nhttps://github.com/Engine-Room/Flywheel/issues/new"))))); } - private static String formatForIssue(String original) { - return """ -
- Debug Info - - %s - -
- """.formatted(original); - } - private static void addBackendDebugInfo(@Nullable VisualizationManagerImpl manager, StringBuilder out) { appendHeader(out, "Backend");