Submitting a Game to the Thumby Arcade
Consider going through the Getting Started with Thumby tutorial before continuing with this one!
- Your Thumby game
- A GitHub account
- Thumby Code Editor - NOTE: Only Google Chrome and Microsoft Edge support running the TinyCircuits Thumby Code Editor webpage
Create & Login to GitHub Account
Go to GitHub.com and login or create an account. GitHub is a code hosting platform created to track versions of code and collaborate with others.
Once you have an account, get familiar with GitHub features like creating a code repository, branching, pushing changes to GitHub from your local machine, and making commits and pull requests to public repositories. You can do all of this through GitHub's website, or you can learn how to do it all from the command line.
At TinyCircuits, we share all of our software and hardware files through GitHub publicly under the Creative Commons Attribution Share-Alike 3.0 License. Open source contributions lead to greater and faster innovation through sharing and collaboration - you sharing your game on GitHub makes you a part of the amazing open source community!
If you are not quite ready to submit your game and want some feedback, or players to test the game, consider sharing it on the Thumby board of the TinyCircuits forum or with the community on our Discord.
Create Game & Share
Once your game is in a state where you are ready to share it with everyone and publish it to the public Thumby Arcade, go through the instructions in the README file available on the repository of the Thumby Games to learn how to name your files, which files to include, and other important details. In short, you will need to submit a folder with 3 (or more) files:
- GameName/GameName.py - The main file of your game that references any other files, like a .bin or .raw image you use in the game - include all files needed for your main game file to work!
- GameName/arcade_description.txt - Include the title of your game, a short description, your name, and the version of your game. Add any instructions important to play your game. This text is displayed when hovering over your game in the Thumby Arcade.
- GameName/arcade_title_video.webm - A .webm video of gameplay. Use the video camera 🎥 button in the Emulator panel of the Thumby Code Editor Website to record a .webm of gameplay. Zoom in to at least 8x to provide a good quality video. The zoom factor displays in the bottom left of the Emulator.
Submit Your Game
The following instructions (with pictures!) will guide you through submitting your game to the Thumby Arcade step-by-step all through your web browser - no need to use the command line if you're not comfortable with it. You just need a GitHub account!
Log in to your GitHub account and navigate to the Thumby Games Repository page. Press the 'Fork' button in the top right of the page to fork your own copy of the repository:
Add Files to Your Local, Forked Repository
The game files you put together in a folder of the same main game .py file are what you will want to add here. Make sure the folder name and the .py file have the exact same name - this name is case sensitive!
Click the 'Add file' button to access the drop down for the 'Upload files' option.
Drag and drop your [GameName] folder to the above window where directed.
Commit Game Files
Now that you have added the folder of all the files needed to play your game, you will need to 'Commit' them to finalize your selections. Consider adding a description for these changes, such as "Add a game called [GameName]". Once you're happy with the description, press the 'Commit changes' button:
Submit Pull Request
Go back to the main Thumby Games repository and click on the 'Pull Requests' tab. On this page, press the 'New pull request' button:
Select your local, forked repository to compare changes. Once selected, check that you can see all the files you want to submit. If everything looks good, press the 'Create pull request' button:
On the next page, you get the chance to add more information on what exactly is in your pull request. Add some description on the status of your game, and then press the 'Create pull request' button:
That's all! You should see a successful message that your branch has no conflicts with the base branch.
Now that you have submitted a successful pull request, you just need to wait on the TinyCircuits team to accept your game before it's added to the Thumby Arcade. If there are any issues with the PR, a TinyCircuits team member will comment and let you know!