summaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE/bug_report_velocity.yml
blob: 1de18a2a0eea1fa8a028e3cc085bd0a2e7ff09b9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
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