Issue tracker tips and rules

Section

Please read this page fully before opening issues on our issue tracker or opening a new forum topic.

In short, these are the steps you should do before opening an issue on GitHub:

  1. Carefully check our Knowledge base
  2. Search the website for similar topics
  3. If 1. or 2. did not help, open a forum topic in appropriate section
  4. If it turns out there is an actual bug, report it on the GitHub

Before opening an issue on the GitHub

Solutions to most of the common problems can be found in our Knowledgebase.

Search for similar or duplicate issues before opening a new issue to avoid duplicates. Duplicate issues will be removed and multiple duplicate posts can result in user block. Incomplete issues with a very small amount of detail will be removed. The same goes for the issues that could easily be solved with a minimal search on the website. When you publish the issue, it is first only visible to you and the developers. After we review it, it can be seen and commented on by the whole community.

Many issues turn out to be support requests due to a lack of knowledge from the user. Therefore we require the users to search the forums first, and if they do not find a similar topic, open a new forum topic. Very likely, the solution will be in a change on how the user is approaching a problem. If this is not the case, community members and moderators will advise escalating the issue to the GitHub issue tracker. When this happens, the issue is ready for GitHub, no sooner.

We are aware this may be tedious, but we have set this set of rules due to past misuse of the issue tracker, which puts a lot of toll and pressure on the contributors of the project with a very limited time budget for this project, mostly taken from the contributor's free time.

Helping us understand the issue context

When possible, attach your MCreator workspace (preferably a minimal example workspace required to reproduce the bug; use File -> Export workspace to a shareable ZIP...), game logs (full logs, do not crop them, in text format, not screenshots of logs) from the Console tab or terminal, and steps to reproduce the bug in your workspace. Please specify which mod elements to check in your workspace too, if applicable.

Long logs should be pasted to the Gist service (GitHub Gist, Pastebin, Hastebin, ...) and linked to the issue.

Things to keep in mind

Make sure to post only one feature request or bug report in each ticket, so each separate item can be tracked by our issue tracking system. Issues with multiple requests will be removed. The tracker is not a place for large lists of feature requests. Such lists belong to Feature requests and ideas for MCreator forum section and we will pick the most requested features from there. For questions related to the usage of MCreator, open a forum topic instead. The issue tracker is not a place for programming support neither.



Donate to MCreator

By donating to developers you can speed up development, as with more resources, we can dedicate more time to MCreator. It is a free project made by developers working on it in their free time.