diff options
Diffstat (limited to '.github')
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report_folia.yml | 127 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report_paper.yml (renamed from .github/ISSUE_TEMPLATE/bug_report.yml) | 47 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report_velocity.yml | 156 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.yml | 13 |
4 files changed, 326 insertions, 17 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report_folia.yml b/.github/ISSUE_TEMPLATE/bug_report_folia.yml new file mode 100644 index 0000000..3c7fada --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report_folia.yml @@ -0,0 +1,127 @@ +name: Bug Report (Folia) +description: Report a bug or unexpected behavior on a Folia server +labels: ["Type: bug", "Module: Folia"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report a bug! Please fill out the information below to help us fix the issue. + + Use this template only if the problem happens on **Folia**. If it also reproduces on plain Paper, please use the Paper template instead. If the problem involves a **Velocity** proxy, use the Velocity template. + + - type: textarea + id: description + attributes: + label: Bug Description + description: A clear and concise description of what the bug is. + placeholder: Describe the bug you encountered... + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to Reproduce + description: Steps to reproduce the behavior + placeholder: | + 1. Run command '...' + 2. Send message '...' + 3. See error + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: What you expected to happen + placeholder: Describe what you expected to happen... + validations: + required: true + + - type: textarea + id: actual-behavior + attributes: + label: Actual Behavior + description: What actually happened + placeholder: Describe what actually happened... + validations: + required: true + + - type: dropdown + id: reproduces-on-paper + attributes: + label: Does this also happen on Paper? + description: Folia-only behavior usually points at a thread or region issue, so this narrows it down a lot. + options: + - "Folia only (does not happen on Paper)" + - "Happens on Paper too" + - "Not tested on Paper" + validations: + required: true + + - type: input + id: plugin-version + attributes: + label: LunaticChat Version + description: Run `/lc status` in-game to see the version and commit hash. + placeholder: "e.g., v1.3.0 (7c54422)" + validations: + required: true + + - type: input + id: folia-version + attributes: + label: Folia Version + description: Run `/version` on the server. + placeholder: "e.g., Folia 26.2-12" + validations: + required: true + + - type: input + id: minecraft-version + attributes: + label: Minecraft Version + description: What version of Minecraft are you running? + placeholder: "e.g., 26.2" + validations: + required: true + + - type: input + id: java-version + attributes: + label: Java Version + description: LunaticChat requires Java 25 or later. + placeholder: "e.g., Java 25" + validations: + required: true + + - type: checkboxes + id: enabled-features + attributes: + label: Enabled Features + description: Which optional features are enabled in `config.yml`? Most of them are off by default. + options: + - label: "`features.quickReplies` (/reply)" + - label: "`features.japaneseConversion` (romaji to Japanese)" + - label: "`features.channelChat`" + - label: "`features.velocityIntegration`" + + - type: textarea + id: logs + attributes: + label: Logs and Error Messages + description: "Please paste relevant logs or error messages here. Full stack traces matter on Folia — they show which thread the call came from. Setting `debug: true` in `config.yml` produces more detail." + placeholder: Paste your logs here... + render: shell + validations: + required: false + + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Add any other context about the problem here (how many players and worlds were involved, screenshots, other installed plugins, related issues, etc.) + placeholder: Any additional information... + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report_paper.yml index 9d35bc8..dfddc26 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report_paper.yml @@ -1,12 +1,14 @@ -name: Bug Report -description: Report a bug or unexpected behavior in LunaticChat -labels: ["Type: bug"] +name: Bug Report (Paper) +description: Report a bug or unexpected behavior on a Paper server +labels: ["Type: bug", "Module: Paper"] body: - type: markdown attributes: value: | Thanks for taking the time to report a bug! Please fill out the information below to help us fix the issue. + If your server runs **Folia**, or if the problem involves a **Velocity** proxy (cross-server chat or cross-server direct messages), please use the corresponding template instead. + - type: textarea id: description attributes: @@ -50,26 +52,26 @@ body: id: plugin-version attributes: label: LunaticChat Version - description: What version of LunaticChat are you using? - placeholder: "e.g., v0.1.0" + description: Run `/lc status` in-game to see the version and commit hash. + placeholder: "e.g., v1.3.0 (7c54422)" validations: required: true - type: input - id: minecraft-version + id: paper-version attributes: - label: Minecraft Version - description: What version of Minecraft are you running? - placeholder: "e.g., 1.21.4" + label: Paper Version + description: Run `/version` on the server. + placeholder: "e.g., Paper 26.2-92" validations: required: true - type: input - id: paper-version + id: minecraft-version attributes: - label: Paper Version - description: What version of Paper are you using? - placeholder: "e.g., Paper-1.21.4-123" + label: Minecraft Version + description: What version of Minecraft are you running? + placeholder: "e.g., 26.2" validations: required: true @@ -77,16 +79,27 @@ body: id: java-version attributes: label: Java Version - description: What version of Java are you running? - placeholder: "e.g., Java 21" + description: LunaticChat requires Java 25 or later. + placeholder: "e.g., Java 25" validations: required: true + - type: checkboxes + id: enabled-features + attributes: + label: Enabled Features + description: Which optional features are enabled in `config.yml`? Most of them are off by default. + options: + - label: "`features.quickReplies` (/reply)" + - label: "`features.japaneseConversion` (romaji to Japanese)" + - label: "`features.channelChat`" + - label: "`features.velocityIntegration`" + - type: textarea id: logs attributes: label: Logs and Error Messages - description: Please paste relevant logs or error messages here + description: "Please paste relevant logs or error messages here. Setting `debug: true` in `config.yml` produces more detail." placeholder: Paste your logs here... render: shell validations: @@ -96,7 +109,7 @@ body: id: additional-context attributes: label: Additional Context - description: Add any other context about the problem here (screenshots, related issues, etc.) + description: Add any other context about the problem here (screenshots, other installed plugins, related issues, etc.) placeholder: Any additional information... validations: required: false diff --git a/.github/ISSUE_TEMPLATE/bug_report_velocity.yml b/.github/ISSUE_TEMPLATE/bug_report_velocity.yml new file mode 100644 index 0000000..fb622c9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report_velocity.yml @@ -0,0 +1,156 @@ +name: Bug Report (Velocity) +description: Report a bug involving the Velocity proxy, cross-server chat, or cross-server direct messages +labels: ["Type: bug", "Module: Velocity"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report a bug! Please fill out the information below to help us fix the issue. + + Use this template when the problem involves the **Velocity proxy** — cross-server global chat, cross-server direct messages, or the Paper/Folia to Velocity handshake. A bug that reproduces on a single backend server without the proxy belongs in the Paper or Folia template. + + Paper and Velocity compatibility is decided by an internal **protocol version**, not by the plugin version, so the `/lcv status` output below is the most important field on this form. + + - type: textarea + id: description + attributes: + label: Bug Description + description: A clear and concise description of what the bug is. + placeholder: Describe the bug you encountered... + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to Reproduce + description: Steps to reproduce the behavior. Please include which server each player was on. + placeholder: | + 1. Player A on 'survival' sends '...' + 2. Player B on 'lobby' runs '...' + 3. See error + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: What you expected to happen + placeholder: Describe what you expected to happen... + validations: + required: true + + - type: textarea + id: actual-behavior + attributes: + label: Actual Behavior + description: What actually happened + placeholder: Describe what actually happened... + validations: + required: true + + - type: textarea + id: lcv-status + attributes: + label: Output of `/lcv status` + description: Run `/lcv status` on an affected backend server. It reports the connection state and the protocol version of both sides. + placeholder: Paste the output here... + validations: + required: true + + - type: input + id: velocity-plugin-version + attributes: + label: LunaticChat Version (Velocity) + description: The version of `LunaticChat-<version>-velocity.jar` installed on the proxy. + placeholder: "e.g., v1.2.0" + validations: + required: true + + - type: input + id: backend-plugin-version + attributes: + label: LunaticChat Version (backend Paper / Folia) + description: Run `/lc status` on a backend server. If your backend servers run different versions, list all of them. + placeholder: "e.g., v1.3.0 (7c54422)" + validations: + required: true + + - type: input + id: velocity-version + attributes: + label: Velocity Version + description: LunaticChat is built against the Velocity 4 API. Velocity 3.5.x and BungeeCord are not supported. + placeholder: "e.g., 4.0.0" + validations: + required: true + + - type: input + id: backend-server-version + attributes: + label: Backend Server Software + description: The software and version of the affected backend servers. + placeholder: "e.g., Paper 26.2-92 / Folia 26.2-12" + validations: + required: true + + - type: input + id: java-version + attributes: + label: Java Version + description: LunaticChat requires Java 25 or later. + placeholder: "e.g., Java 25" + validations: + required: true + + - type: checkboxes + id: enabled-features + attributes: + label: Enabled Cross-Server Features + description: Which `features.velocityIntegration` settings are enabled in the backend `config.yml`? All of them are off by default. + options: + - label: "`enabled`" + - label: "`crossServerGlobalChat`" + - label: "`crossServerDirectMessage`" + + - type: textarea + id: server-layout + attributes: + label: Server Layout + description: The backend servers behind the proxy and the `features.velocityIntegration.serverName` configured on each. Cross-server direct messages are routed by that name, so a mismatch with the Velocity configuration is a common cause. + placeholder: | + - lobby (serverName: "lobby") + - survival (serverName: "survival") + - creative (serverName: "Unknown") <- not configured + validations: + required: false + + - type: textarea + id: velocity-logs + attributes: + label: Velocity Proxy Logs + description: Please paste relevant logs or error messages from the proxy. + placeholder: Paste the proxy logs here... + render: shell + validations: + required: false + + - type: textarea + id: backend-logs + attributes: + label: Backend Server Logs + description: "Please paste relevant logs or error messages from the backend servers. Setting `debug: true` in `config.yml` produces more detail." + placeholder: Paste the backend logs here... + render: shell + validations: + required: false + + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Add any other context about the problem here (screenshots, other installed plugins, related issues, etc.) + placeholder: Any additional information... + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 5bd060b..d90343e 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -7,6 +7,19 @@ body: value: | Thanks for suggesting a new feature! Please provide as much detail as possible. + - type: dropdown + id: platform + attributes: + label: Target Platform + description: Which platform would this feature apply to? A maintainer will add the matching `Module:` label. + options: + - "Paper" + - "Folia" + - "Velocity (proxy / cross-server)" + - "All platforms / not platform-specific" + validations: + required: true + - type: textarea id: feature-description attributes: |