Guide for submitting examples
Submitting example is a great way to contribute to GDevelop and help others. If your example is good enough, it will be accepted to the example library and will be available in GDevelop.
This Guide shows how you can submit an example to GDevelop example library.
Check if the same example already exists
The first thing you should do is check if an example that does the same thing already exists. You won't be excited to take your time making something that already has been done.
Search through the examples list in GDevelop (Create a new project → Examples tab), and make sure the same example doesn't exist.
Discussing with the community
The example will be MIT licensed (see this for more info about the MIT license).
You will have to make sure the example can be MIT licensed and make sure the resources can also be distributed under the MIT license. If you are having doubts about the license of the resources, ask the creator and ask for permission (this is important!).
In general, try to keep your example as minimal as possible. It will ensure it's easier to make sure it's very high quality and can be added easily.
Names should describe its use well and clearly. Example: a variable for storing player's health can be named
PlayerHealth. The object name can be
Player, but avoid crytic/shorthand names like
Names should not have spaces in them. Example: use
PascalCaseis recommended, but using other styles is fine.
Variables should be initialized in the variable editor. It is ok to leave them uninitialized for some situations, but it's generally recommended.
Unused variables should be deleted
- If custom extensions are used, add proper comments, description to the events see Extension best practices for more info
Related events should be added into a group with proper naming.
- Color code your groups to allow differentiating them quickly.
If the same events are used in multiple places, you can use external events or a function in an extension.
Remove empty events.
Remove disabled events or events that were used for testing.
Unfold any events so that they are easily visible, except groups events, which should be folded to allow getting a quick overview of all systems in the example.
Use comments to document events.
You can change the color of the comments according to its use (for example, green for a tip, orange for a warning). Otherwise, just keep the default color.
If the example needs a wiki page, create one in this wiki and when it's done, add a link to it in the example.
Remove unused resources from both the resource manager and then from the project folder
It is recommended to add all the resources in a folder called
assets, and add sub-folders according to the use of the assets (GUI, Player, Power-ups) if needed.
The images should not be too large (2000x2000 is a maximum).
You will have to confirm that this example and all of its resources can be integrated to the GitHub repository (where all the example are stored), distributed and MIT licensed.
Keep everything clean
- Remove any unnecessary scenes, external events, external layouts
- Remove unused variables
- Remove unused resources, images, sounds, fonts, from the project folder
- Remove any unnecessary events from the event sheet
.jsonfile and the project folder's name should be renamed to the example's name, with
-instead of spaces. For example: an example with
Not a vaniaas name should have
not-a-vaniaas its folder name and its
The project should not be using multiple files for saving (using a single JSON file).
The project should have a
README.mdfile with a text describing the example (see Submitting examples section for more information).
The project properties should be properly filled out.
Project Name The project name should be the example name.
Package Name The package name should follow
com.example.<projectname>. In PascalCase, e.g:
Version The version that is added to the library (after review) should be
1.0.0, and incremented as changes are added after it's added.
Author is your username. An account will have to be registered and a proper username will be needed to be able to add the username. Type the username and pick the username from the drop-down menu
- Game resolution shouldn't exceed 1920x1080 so that the example can run on all devices without any performance issues .
- If the example uses pixel art with small assets, "nearest neighbor" rendering is recommended.
Thumbnail and example description
You can include a
thumbnail.pngwhich is the icon for the example and will be shown in the examples library
The project folder should include a
README.mdfile that has a description of the example. You can create a
.mdfile by opening any text editor (like Notepad on Windows), writing the description and saving the files with the name
Both the thumbnail and the Readme.md file should be in the main folder and not in any sub-folders.
Submitting the example
You can submit the example to the Example repository as an issue.
- Go to the site,
- Click The Green New Issue button:
- A option to select issue template will be shown, click New Example:
- You will get a text box where you can write the "issue" which is where you can upload the project file (as a
zipfile) and add a proper description about it.
- Change the title to the example's name.
## Describe the examplein the textbox, add a proper description about the example, feel free to add any screenshots.
- You will also be given a checklist of what is necessary. If you have done them, add
xin the in brackets against each checklist.
- [ ] My Game has a proper name in the game properties. - [ ] My Game package name begins with 'com.examples'. - [ ] My Game has all events unfolded. - [ ] I've added myself as the author in the game properties. - [ ] I've included a file called 'README.md' with a description in proper English, explaining what this example is doing. - [ ] I confirm that this game and all its resources can be integrated to this Github repository, distributed and MIT licensed. - [ ] I've cleaned unused resources in the project.
## Game folder, add a zip of your project and drag and drop it into the text box.
- Now click
Congratulations! Now your example has been submitted, but it won't be directly added to the library. A review of the example will be done to make sure the example is ready to be added. You might have to refactor some events if the review suggests to.
There is no guarantee that your example will be accepted, it can be rejected if the example is not suitable
for the library. Also remember that while it's hard to get some feedback, reviewers are asking for changes because they believe this will improve your example. Try to rework the example using their feedback! Once you think it's good enough, you can ask for another review or discuss points where you might disagree.