Otomo documentation¶
Otomo is a self-hosted, open-source backend for Godot live-service games. It's the part of an online game that players never see: the servers that deliver content updates, remember who each player is, put friends into a party, and find a game server for their match. Your game ships the fun; otomo runs everything around it, on a server you control.
This documentation is for teams who have never used otomo before and want to run it for their own game. You'll host otomo on your own Linux VM, then connect your Godot project to it with otomo's SDK.
You don't need to be a web or server programmer
These pages assume you know Godot and a little C#, and nothing else. Every time a page uses a networking, web or Linux term for the first time, it explains it. If a word is still unfamiliar, look it up in the Glossary.
The path from zero to a running game¶
Most teams follow these pages in order:
- What is otomo? Decide whether otomo fits your game.
- Before you begin Get a VM, a domain name, and your PC ready.
- Deploy otomo on a VM Install and start otomo, and give it a public HTTPS address. This takes an afternoon.
- Install the SDK Add otomo to your Godot project and check the game reaches your server.
- Publish your first content update Change something in the admin website and watch the running game pick it up.
- Run a new game server build and Join a match Put your game server behind otomo and get players into matches.
Find something specific¶
| I want to… | Go to |
|---|---|
| Show a download bar while the game updates | Build a download screen |
| Use the admin website | Use the admin website |
| Put announcements (or another list) in the game | Namespace presets |
| Look up a function, signal or setting | SDK reference |
| Fix an error | Troubleshooting and Error codes |
| Update otomo or back it up | Deploy otomo on a VM › Keeping it running |
| Understand how otomo works inside, or which service does what | How otomo works: the big picture |
How this documentation is organised¶
- Getting started
- What otomo is, what you need, and how to deploy it on a VM.
- Architecture
- How otomo is built, for people who run it or change it: the two planes, how sign-in and service-to-service trust work, how content, matches and the economy move through the services, and how the stack is deployed and monitored. Start with the big picture.
- Concepts
- Plain-language explanations of the ideas behind otomo: how a game talks to a server, what HTTP is, what a login token is, how content updates work, what a container is. Read these once. The guides link back to them whenever you need them.
- Guides
- Step-by-step walkthroughs. Each one says what you need before you start, gives every command and click, and shows what you should see after each step.
- Reference
- Short, exact descriptions for when you already know what you're looking for: every public function, signal and setting of the SDK, every error code, and a glossary.
Contributing to otomo itself¶
These pages are about using otomo. If you want to change otomo's own code, start with
CONTRIBUTING.md and the design documents in the repository's design/ folder.