Thank you for your interest in contributing to Material Maker! Please take a look below before making your first contribution.
- Bug reports and feature suggestions
- Contributing pull requests
- Translations
- Financial contributions
- Contacting the developer
Bug reports and feature suggestions should be made here.
Before creating a new issue, check if your problem/proposal is already mentioned by using the search function to avoid creating duplicates.
When reporting a bug, make sure to follow the template and provide the following(when possible/if required):
- Material Maker version
- System information(OS, GPU)
- What is expected and what happened instead
- Outputs from the terminal
- A screenshot/video showing the problem
- Project file(if you believe the issue relates to a specific setup)
Using AI/LLM or any form of agentic coding for your pull request is not allowed.
Use your own words when writing the description. If English is a barrier, consider using a dedicated language service(i.e. Google Translate, DeepL).
Using Godot Engine
Material Maker is built using the Godot Engine using GDScript. As such, it is required to download the software in order to open/test the project. The version used for development can be seen in the project.godot file under the config/features key.
If you are opening the project in Godot Engine for the first time, Game Embedding must be disabled or else the app may not launch in the editor.
This can be set from the editor settings:
Run > Window Placement > Game Embed Mode and setting it to Disabled
Formatting
Follow the Godot Style Guide when formatting your code. Consider looking at surrounding code to copy their patterns and style.
Additionally,
- Use static typing, and explictly type over inferred typing, i.e.
var my_button : Button = Button.new()instead ofvar my_button := Button.new(). - Use a single new-line when separating functions
PR Workflow
- Fork the repository.
- Setup Git and clone the repository.
- Create a new branch:
git checkout -b feat-new-panel - Make your changes, and add them using
git add . - Commit your changes:
git commit -m "Implemented new panel" - Push your branch:
git push origin feat-new-panel - Create a new pull request and describe your changes.
If your contribution resolves an existing issue, please add a Github closing keyword in the description of your pull request (e.g. - Closes #1234). This will make linked issue(s) to close automatically if your PR is merged.
Material Maker provides translation files via an online registry which users can download from within the software.
To contribute to this registry, create your translation file, host it somewhere linkable(i.e. in a github repository) and contact RodZill4 directly, via Discord.
Both .csv and .po format are supported. You can use this script to generate a po template and edit your translation using poedit. Also see this README.md.
It might also help to use an existing translation as a basis.
Although Material Maker is provided for free, it is still possible to contribute financially to help other costs(such as website hosting) and allow more time to be spent on developing/maintaining the software.
- Joining the Patreon
- Donating on Itch.io
- Getting a Steam copy and leaving a review
For casual discussion around Material Maker or about contributing, you can find RodZill4 (@rodzlabs) on the Discord server.