Skip to content

Contributing Code Or Docs To GodotSteam

Modifying Code

There is a convention we try to keep, which seems like a hodge-podge of styles:

  • Use camel-case for all function names. We mostly follow Valve's lead with this instead of Godot's, but we have discussed changing it.
  • Use snake-case for all signal names, variables, and arguments.
  • Make sure your code compiles before submitting a pull-request. Run a quick:

    scons platform=[your platform] production=yes tools=yes target=release_debug
    scons platform=[your platform] tools=yes target=editor

We'll figure the rest out later. So far that's it!

Modifying Examples

Add new examples or edit the existing ones.

Please try to keep most of the standard Godot conventions, use snake_case, double linebreak between functions, etc.

Don't shy away from explaining things in the comments. Since these are meant for people to learn adn figure out how Steamworks functions, definitely pack in any information you think necessary.

Modifying Docs

Feel free to make any edits you think are needed, really. CSS changes, new tutorials, extra links, fixes for functions or signals, or even adding your own game to the "Games Using GodotSteam" list.

Try to make any new or edited content fit the same styles as the other pages. But if you have an eye for design and think of something better, please share that too.

Thank you for helping make the project more useful for the community!