GDevelop Season of Docs

Season of Docs is an initiative to bring open source and technical writer communities together.

GDevelop is an open-source game development software allowing anyone to create games. What makes GDevelop unique and so easy to use are the events. Events are a powerful way to express the logic of your game, without having to learn a programming language. Want to give it a try? Try the online version or download the full software!

This year, we would love to mentor a technical writer to improve GDevelop documentation! We have a few ideas that could help a lot the software and its users.

Dozens of thousands of users are creating games with GDevelop each month. Lots of them are discovering game creation for the first time. Others are more experienced users creating impressive games with the engine.

Ideas

Those ideas are not exhaustive. Feel free to suggest your own idea! Or combine ideas into your own.

A brand new tutorial 🚀

  • Write a new tutorial, explaining step by step how to create a game. We have two complete tutorials on the wiki already, but they are fairly basic.
  • The theme of the game can be anything that sounds interesting: space shooter, endless running game, castlevania-like, beat'em up etc… Mentors will help you get started with the software and the game making.
It will be important to find a game that is fairly small so that a tutorial can cover it from the start to the end, while being interesting... and good looking 💅 (there are assets pack on websites like *itch.io* or *opengameart.org* that we can use).

Improved wiki pages 📚

  • Improve the existing documentation by checking that every object, event, behavior is covered by the documentation and improve each page with new examples, links and explanations.
  • These pages will be very useful as the software has “Help” links, inside the editor, for all features. Users will be able to learn more extensively about any feature by simply clicking on Help.

Improved extension developer guide 🤓

  • Extensions are very important in GDevelop, as they provide most features that users can use in their games. Improve the documentation on GitHub to explain how to create a new extension for the software.
  • See also this wiki page. This will be very useful to encourage new people to contribute to the game engine.

Documentation and tutorial for publishing games on various platforms 🌍

  • Create more documentation about publishing games on marketplaces, gaming websites and app stores. This is super important as users like to create games, but a game is not finished if it's not published!
  • There is already a bit of documentation on the wiki, but more step-by-step tutorials and detailed explanations about marketplaces (Kongregate, Itch.io, Facebook Instant Games…) or app stores would be super useful!
These articles/documentation can even be tightly integrated into GDevelop app itself. Mentors will be able to do updates in GDevelop.

About GDevelop open-source project, organization and mentors

GDevelop repository is available on GitHub. You can also browse the website to learn more about the software and download it.

📣Participation to Season of Docs was announced on Twitter and Facebook.

👋 Mentors will be 4ian and Blurymind. 4ian is the original author of GDevelop and Blurymind is an active contributor to the software. You'll also get support from other members of the community on the forum or the Discord!

I'm interested! How do we get started?

If you have any question, feel free to reach out to 4ian (find my email on my GitHub page, send me an DM on the forum or send me a Tweet).

Read the page for Technical Writer on Google Season of Docs. After the exploration phase, finishing on May 28, official applications can be submitted.

Thanks for considering helping GDevelop! ❤️

Frequently asked questions

Is it possible for me to contribute to GDevelop in Google Season of Docs given that I don’t have any prior experience in coding or technical writing but have used GDevelop in the past?

Yes! You'll get familiar with GDevelop as you use it before the project officially start. There is notably a period for this in August that is called “community bonding”.

How should I express my interest for contributing towards a project and whom should I express it towards?

Submit an official application when applications are open (in June, see the timeline). Also write to 4ian about what you would like to do.

Will there be enough help given that I will be contributing towards the documentation rather than the project?

Absolutely, documentation is key for GDevelop, so the authors/maintainers of the software will be able to support you and will communicate regularly with the technical writer to help.

How many technical writers will be able to partipicate?

Unfortunately, only 1 it seems. Note that participating to tutorials and the documentation is already possible! If you create an account on the wiki, you are able to edit existing pages to improve them or create new pages for tutorials.

What does GDevelop need?

More documentation and tutorials for people to create various games mainly :) See the list of ideas. The best thing to do is also to browse the forum to see what people are asking. It's a good way to see what are the main issues users are running into.

Step by step tutorials seems to be the most useful for new users.