Skip to content

Commit 0e4ec8c

Browse files
authored
Update CONTRIBUTING.md
Note on changing scenes.
1 parent 6b1eea9 commit 0e4ec8c

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ One thing I will always welcome is more games! There are just a few notes I have
1313
* **Try to make your game as small as you can.** GodotOS is built in mind to run on the web, so any large files can greatly detract from its loading times and portability.
1414
As a rule of thumb, try to make your game under 1 megabyte. Consider compressing your assets, going for a pixel-art or minimalist style, using a sprite atlas, etc.
1515
* Don't use autoloads in your game since it would have to always be running for the entire application. If you **really** need an autoload, consider passing data through save files or adding a node in `/root/`.
16-
Just make sure to delete it on window exit.
16+
Remember to delete it on window exit if you're doing this!
17+
* Avoid using functions that affect the entire scene such as `get_tree().change_scene_to_file()`. This will affect GodotOS as a whole, not just your game. Check the official games included for examples on how to safely change scenes only for the game window.
1718
* Make sure your scene and script names less generic. If you have a player and the game is called Super Bit Boy for example, call it `bit_boy_player.gd` instead of `player.gd`.
1819

1920
That's it. Good luck!

0 commit comments

Comments
 (0)