diff options
Diffstat (limited to '.github')
| -rw-r--r-- | .github/CONTRIBUTING.md | 22 | ||||
| -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 | ||||
| -rw-r--r-- | .github/SECURITY.md | 46 | ||||
| -rw-r--r-- | .github/workflows/release-paper.yaml | 30 | ||||
| -rw-r--r-- | .github/workflows/release-velocity.yaml | 30 | ||||
| -rw-r--r-- | .github/workflows/release.yaml | 34 |
9 files changed, 400 insertions, 105 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 5489c70..3365568 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -16,16 +16,24 @@ If your issue is not already reported, please create a new issue using the provi We welcome contributions to LunaticChat! -LuckPerms adheres to the [Kotlin Coding Conventions](https://kotlinlang.org/docs/coding-conventions.html). +LunaticChat adheres to the [Kotlin Coding Conventions](https://kotlinlang.org/docs/coding-conventions.html). It also uses Ktlint. Merging pull requests into the main branch requires passing Ktlint checks. When submitting a pull request, remember to run `./gradlew ktlintFormat`. When making major changes that break backward compatibility, please discuss them beforehand via an issue or discussion. Such changes often cause confusion when made without prior discussion. +### Design Guide + +Our documentation site provides an overview of LunaticChat's design. + +We highly recommend reading it before you begin development. + +[Introduction / Developer Guide - LunaticChat Documentation](https://lc.m1sk9.dev/docs/developers/introduction) + ### Project Structure -LunaticChat uses a multi-module Gradle setup. +LunaticChat uses a multi-module Gradle setup. - `engine`: Contains code shared across all platforms. - `platform-paper`: Contains code specific to the Paper platform. @@ -35,4 +43,12 @@ LunaticChat uses a multi-module Gradle setup. LunaticChat comes with a Docker environment that can be launched as a debug server. -Running `./x start` will launch a Paper server with LunaticChat installed. +It is driven by `./x <action> <platform>`, where the platform is required: + +- `./x start paper` builds the plugin and starts a single Paper server (`localhost:25565`) +- `./x start folia` starts a single Folia server (`localhost:25565`) +- `./x start velocity` starts a Velocity proxy with two backend Paper servers (`localhost:25577`) + +Builds default to a nightly version derived from the current commit; pass `--stable` to build as a stable release. + +Run `./x help` for the remaining actions (`stop`, `log`, `clean`, `rcon`). 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..1de18a2 --- /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, **after at least one player has joined** — the handshake is only sent once a player connects, so on an empty server the state is always `DISCONNECTED`. It reports the connection state, the plugin version of both sides, and this server's protocol version." + 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: diff --git a/.github/SECURITY.md b/.github/SECURITY.md index b2a5b43..8589d94 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -2,15 +2,49 @@ ## Supported Versions -LunaticChat only supports the latest version at any given time. -Older versions are not supported, and backports will not be provided unless absolutely necessary. +The Paper/Folia and Velocity plugins are released independently, and **only the latest release of each is supported**. Older releases are not supported, and backports will not be provided unless absolutely necessary. -### In Minecraft +| Component | Supported | +|-----------|-----------| +| LunaticChat for Paper / Folia (latest `paper/vX.Y.Z`) | Yes | +| LunaticChat for Velocity (latest `velocity/vX.Y.Z`) | Yes | +| Any earlier release | No | +| Nightly builds and CI artifacts | No | -The Minecraft version follows the `api-version` on which the latest LunaticChat runs. However, it fundamentally depends on the Paper API / Velocity API version. +### Platform requirements -(Example: If the `api-version` is `1.21`, operation on `1.21.X` is guaranteed.) +The supported platforms and runtime follow whatever the latest release is built against: + +| | Supported | +|---|---| +| Minecraft | The `api-version` the latest release declares (currently `26.2`), i.e. `26.2.x` | +| Server software | Paper, Folia, and Velocity 4 | +| Java | 25 or later | + +Spigot, BungeeCord, and Velocity 3.5.x are **not** supported, and there are no plans to support them. + +### Paper and Velocity combinations + +Paper–Velocity compatibility is decided by the internal **protocol version**, not by the plugin version. A combination that the protocol rejects will refuse to relay chat; that is intended behavior, not a vulnerability. See [Paper / Velocity Compatibility](https://lc.m1sk9.dev/docs/reference/compatibility) for the rules and the compatibility matrix. + +If a report involves a proxy setup, please include the plugin version of **both** sides and the output of `/lcv status`. ## Reporting a Vulnerability -Do not report security issues using Issues. Please report them by sending an encrypted email to [me@m1sk9.dev](mailto:me@m1sk9.dev). +**Do not report security issues through Issues or Discussions.** Please use one of the following private channels: + +1. **GitHub private vulnerability reporting** (preferred) — [open a draft security advisory](https://github.com/m1sk9/LunaticChat/security/advisories/new). This keeps the report private until a fix is published. +2. **Encrypted email** — [me@m1sk9.dev](mailto:me@m1sk9.dev), encrypted with the public key at [github.com/m1sk9.gpg](https://github.com/m1sk9.gpg). + +Please include as much of the following as you can: + +- The affected component (Paper/Folia or Velocity) and its version +- Minecraft and server software versions, and the Java version +- Which optional features were enabled in `config.yml` (`japaneseConversion`, `channelChat`, `velocityIntegration`, …), since most of them are off by default +- Steps to reproduce, and the impact you believe it has + +A fix is shipped as a new release of the affected platform. If you would like to be credited in the advisory, please say so in your report. + +### Vulnerabilities in dependencies + +Known vulnerabilities in third-party dependencies are tracked by Dependabot and do not need a private report — an ordinary issue or pull request is fine. Please do use a private channel if you can demonstrate that a dependency issue is actually exploitable through LunaticChat. diff --git a/.github/workflows/release-paper.yaml b/.github/workflows/release-paper.yaml index 9459ed6..3718163 100644 --- a/.github/workflows/release-paper.yaml +++ b/.github/workflows/release-paper.yaml @@ -94,35 +94,13 @@ jobs: VERSION=${{ needs.validate.outputs.version }} JAR_NAME=${{ needs.validate.outputs.jar_name }} - cat > /tmp/release-notes.md <<EOF - LunaticChat Paper/Folia v${VERSION} has been released. - - ## Download - - - [GitHub](https://github.com/m1sk9/LunaticChat/releases/tag/${TAG_NAME}) - - [Modrinth (Paper/Folia)](https://modrinth.com/plugin/lunaticchat/version/${VERSION}) - - ## What's new - - ### Highlights - - ### New Features - - ### Improvements - - ### Changes - - ### Bug Fixes - - ### Notes - - EOF - + # The notes point at the changelog on the documentation site rather than + # repeating it here, so the release notes live in exactly one place. gh release create "$TAG_NAME" \ "platform-paper/build/libs/$JAR_NAME" \ --title "v${VERSION} (Paper/Folia)" \ --draft \ - --notes-file /tmp/release-notes.md + --notes "Release notes: [Paper/Folia v${VERSION}](https://lc.m1sk9.dev/changelog/paper/v${VERSION})" - name: Publish to Modrinth (Paper/Folia) uses: cloudnode-pro/modrinth-publish@8dc596b20b94959bf244180235d90729d05a674f # v2 @@ -133,7 +111,7 @@ jobs: version: ${{ needs.validate.outputs.version }} channel: ${{ env.MODRINTH_CHANNEL }} changelog: |- - Please refer to the [GitHub release](https://github.com/m1sk9/LunaticChat/releases/tag/paper/v${{ needs.validate.outputs.version }}) for update details. + Please refer to the [release notes](https://lc.m1sk9.dev/changelog/paper/v${{ needs.validate.outputs.version }}) for update details. loaders: |- paper folia diff --git a/.github/workflows/release-velocity.yaml b/.github/workflows/release-velocity.yaml index e71eef9..561e7ee 100644 --- a/.github/workflows/release-velocity.yaml +++ b/.github/workflows/release-velocity.yaml @@ -96,35 +96,13 @@ jobs: VERSION=${{ needs.validate.outputs.version }} JAR_NAME=${{ needs.validate.outputs.jar_name }} - cat > /tmp/release-notes.md <<EOF - LunaticChat Velocity v${VERSION} has been released. - - ## Download - - - [GitHub](https://github.com/m1sk9/LunaticChat/releases/tag/${TAG_NAME}) - - [Modrinth (Velocity)](https://modrinth.com/plugin/lunaticchat/version/${VERSION}-velocity) - - ## What's new - - ### Highlights - - ### New Features - - ### Improvements - - ### Changes - - ### Bug Fixes - - ### Notes - - EOF - + # The notes point at the changelog on the documentation site rather than + # repeating it here, so the release notes live in exactly one place. gh release create "$TAG_NAME" \ "platform-velocity/build/libs/$JAR_NAME" \ --title "v${VERSION} (Velocity)" \ --draft \ - --notes-file /tmp/release-notes.md + --notes "Release notes: [Velocity v${VERSION}](https://lc.m1sk9.dev/changelog/velocity/v${VERSION})" - name: Publish to Modrinth (Velocity) uses: cloudnode-pro/modrinth-publish@8dc596b20b94959bf244180235d90729d05a674f # v2 @@ -135,7 +113,7 @@ jobs: version: ${{ needs.validate.outputs.version }}-velocity channel: ${{ env.MODRINTH_CHANNEL }} changelog: |- - Please refer to the [GitHub release](https://github.com/m1sk9/LunaticChat/releases/tag/velocity/v${{ needs.validate.outputs.version }}) for update details. + Please refer to the [release notes](https://lc.m1sk9.dev/changelog/velocity/v${{ needs.validate.outputs.version }}) for update details. loaders: velocity game-versions: ${{ env.MODRINTH_VELOCITY_GAME_VERSIONS }} files: platform-velocity/build/libs/${{ needs.validate.outputs.jar_name }} diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 48be8f8..c139272 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -100,33 +100,13 @@ jobs: PAPER_JAR_NAME=${{ needs.validate.outputs.paper_jar_name }} VELOCITY_JAR_NAME=${{ needs.validate.outputs.velocity_jar_name }} + # The notes point at the changelog on the documentation site rather than + # repeating it here, so the release notes live in exactly one place. cat > /tmp/release-notes.md <<EOF - LunaticChat ${TAG_NAME} has been released. - - | Platform | Version | - |----------|---------| - | Paper/Folia | ${PAPER_VERSION} | - | Velocity | ${VELOCITY_VERSION} | - - ## Download - - - [GitHub](https://github.com/m1sk9/LunaticChat/releases/tag/${TAG_NAME}) - - Modrinth: [Paper/Folia](https://modrinth.com/plugin/lunaticchat/version/${PAPER_VERSION}), [Velocity](https://modrinth.com/plugin/lunaticchat/version/${VELOCITY_VERSION}-velocity) - - ## What's new - - ### Highlights - - ### New Features - - ### Improvements - - ### Changes - - ### Bug Fixes - - ### Notes + Release notes: + - [Paper/Folia v${PAPER_VERSION}](https://lc.m1sk9.dev/changelog/paper/v${PAPER_VERSION}) + - [Velocity v${VELOCITY_VERSION}](https://lc.m1sk9.dev/changelog/velocity/v${VELOCITY_VERSION}) EOF gh release create "$TAG_NAME" \ @@ -145,7 +125,7 @@ jobs: version: ${{ needs.validate.outputs.paper_version }} channel: ${{ env.MODRINTH_CHANNEL }} changelog: |- - Please refer to the [GitHub release](https://github.com/m1sk9/LunaticChat/releases/tag/${{ github.ref_name }}) for update details. + Please refer to the [release notes](https://lc.m1sk9.dev/changelog/paper/v${{ needs.validate.outputs.paper_version }}) for update details. loaders: |- paper folia @@ -161,7 +141,7 @@ jobs: version: ${{ needs.validate.outputs.velocity_version }}-velocity channel: ${{ env.MODRINTH_CHANNEL }} changelog: |- - Please refer to the [GitHub release](https://github.com/m1sk9/LunaticChat/releases/tag/${{ github.ref_name }}) for update details. + Please refer to the [release notes](https://lc.m1sk9.dev/changelog/velocity/v${{ needs.validate.outputs.velocity_version }}) for update details. loaders: velocity game-versions: ${{ env.MODRINTH_VELOCITY_GAME_VERSIONS }} files: platform-velocity/build/libs/${{ needs.validate.outputs.velocity_jar_name }} |