This page is your one stop shop for learning how to build on top of Downstream. We recommend that you follow the Tutorials to get up and running. The tutorials will explain how to set up your work space and then run you through small example Islands that focus on a small set of mechanics.
Once you feel you are up to speed on what is currently possible on Downstream, you can check out our Existing Maps and Games!
The Existing Maps are various things that Playmint has created in Downstream. There are some smaller examples like the Gate Demo and some larger examples like the quest-map.
The Existing Games are full games that have been developed by external developers and one by Playmint! They will give you an insight into how far Downstream has already been pushed!
Specific questions? Drop into our Discord where you can have direct access to the Playmint dev team!
See the References for information on common tooling and commands.
| Tutorial | Preview | Features |
|---|---|---|
| 1. My First Map |  |
Workspace Set up, Wallets, Units, Tile Fabricator, Building Fabricator, Decorations, CLI, Important files |
| 2. Enemies in inaccessible places |  |
Doors, Bags, Enemies, Movement, Blockers, Combat |
| 3. Questing |  |
Quests system, coordinates |
| 4. Disco Room |  |
Tile Colors, Unit Costumes, Billboards, Custom UI |
| 5. Measuring Success |  |
Counters, Timers, Display Buildings, Custom Onchain State |
| 6. Unit Control Room |  |
Controlling Unit Actions via Buildings |
All example maps can be found here
| Folder | Tile Fabricator View | Description |
|---|---|---|
| default |  |
A single tile map. Deploy this andhen use ds-cli to apply any other map |
| example-gate |  |
A map containing a Door and key demo |
| quest-map |  |
Showcase of Downstream core systems. Uses the quest system to guide players from task to task |
| team-vanilla |  |
Handy multiple size and shape arenas. Good for setting up and playing multiple session based games |
| tiny |  |
A small empty map. Good for iterating on building development. |
| croissant |  |
A Multi Game Map. This showcases multiple games on one map including Tonk Attack; Hexcraft; The Labyrinth and Ducks v Burgers. Tonk attack requires it's own services to be run, see below for details |
All example games can be found here
| Folder | Tile Fabricator View | Description |
|---|---|---|
| tonk |  |
Game by Tonk. Uses: Connection to external server; extensive UI take over; item UI plugin; Unit model swaps |
| hexcraft |  |
Game from 1kx. Uses: Team allocation; Building contract code linked; Restricted crafting; Restricted building; Unit model swaps |
| labyrinth |  |
Game from RockawayX. Uses: Doors; Password hashing; Combat Stats; Item checking; Quests; Map reset |
| duck-burger | |
Game by Playmint. Learn how to make DVB using Tutorial 5 |
Tonk attack requires Tonk services to be running: Run with docker using the tonk profile: docker compose --profile tonk up