Reporting a Bug¶
The project is actively maintained and regularly updated to ensure that it's up-to-date and functioning properly.
With a project of this size and complexity, bugs may occur. If you think you have discovered a bug, you can help by submitting an issue on our Discord Server by following this guide.
If you're not a member of the project and you still want to report a bug you can fill this form.
Before creating an issue¶
Please try the following things before creating an issue.
Upgrade to latest version¶
Chances are that the bug you discovered was already fixed in a subsequent version. Thus, before reporting an issue, ensure that you're running the latest version of project.
Remove your modifications¶
If you have made modifications to the project like adding new systems, removing systems, disabling systems, changing code or changing settings, please remove or revert these modifications from your server before reporting a bug. It's hard to offer official support for bugs that might hide in your changes, so make sure to omit the following changes from your server.
If, after removing those changes, the bug is gone, the bug is likely caused by your changes. A good idea is to add them back gradually to narrow down the root cause of the problem.
Don't hesitate to ask on our Discord Server for help if you run into problems.
At this point, if you still haven't found a solution to your problem, you can create an issue because it's now very likely that you stumbled over something that we don't know yet. Read the following section to learn how to create a complete and helpful bug report.
Issue template¶
In order to make the bug reporting process as simple as possible and more efficient for the community and for the maintainer of the project it is required to follow this template when reporting a bug. It consists of the following parts:
- Title
- Context optional
- Description
- Preview
- Reproduction
- Checklist
Title¶
A good title is short and descriptive. It should be a one-sentence executive summary of the issue, so the impact and severity of the bug you want to report can be inferred from the title.
| Example | |
|---|---|
| Clear | Items with limit time don't disappear when expired. |
| Wordy | My items have limit time and don't work properly because they don't disappear. |
| Unclear | Limit time doesn't work. |
| Generic | Please help |
Context optional¶
Before describing the bug, you can provide additional context for the maintainer understand what you are trying to achieve. Explain the circumstances in which you're using the project, and what you think might be relevant. Don't write about the bug here.
Why this might be helpful: some errors only manifest in specific settings, environments or changes.
Description¶
Now, to the bug, you want to report. Provide a clear, focused, specific, and concise summary of the bug you encountered. Explain why you think this is a bug that should be reported. Adhere to the following principles:
-
Explain the what, not the how – don't explain how to reproduce the bug here, we're getting there. Focus on articulating the problem and its impact as clearly as possible.
-
Keep it short and concise – if the bug can be precisely explained in one or two sentences, perfect. Don't inflate it – the maintainer and future users will be grateful for having to read less.
-
One bug at a time – if you encountered several unrelated bugs, please create separate issues for them. Don't report them in the same issue, as this makes attribution difficult.
Stretch goal – if you found a workaround or a way to fix the bug, you can help other users temporarily mitigate the problem before the maintainer can fix the bug in the project base.
Preview¶
Attaching a preview will always help the maintainer view the issue from your side and most likely detect the problem faster. If possible always attach a preview of the bug in a video format or animated image (GIF).
Reproduction¶
A minimal reproduction is at the heart of every well-written bug report, as it allows the maintainer to quickly recreate the necessary conditions to inspect the bug and quickly find its root cause. It's a proven fact that issues with concise and small reproductions can be fixed much faster.
Example of an Issue Template¶
The final result of your template should look like this:
**Title**
Items with **limit time** don't disappear when **expired**.
**Description**
All items that have limit time don't disappear when they are expired.
**Preview**
<.mp4, .gif>
**Reproduction**
Spawn the item `50084` and wait for it to expire, it will not disappear from the inventory, resulting in making the item permanent which is not correct.
Checklist¶
Thanks for following the guide and creating a high-quality and complete bug report – you are almost done. This section ensures that you have read this guide and have worked to your best knowledge to provide everything needed in order for your issue to be addressed.
Incomplete issues¶
Please understand that incomplete issues that do not contain the minimal reproductions or do not adhere to the quality standards and requirements mentioned in this document will be closed. Issues can be reopened when the missing information has been provided.