Blackholio

Blackholio is a small-scoped MMORPG built using Unity and SpacetimeDB, designed to showcase scalable multiplayer game development. Inspired by agar.io, Blackholio reimagines the mechanics with a space theme where players become planets, stars, and black holes in a competitive cosmic arena.

Game Overview

• Gameplay: Absorb smaller entities, grow, evolve, and dominate the leaderboard as a black hole.
• Scale: Supports hundreds of players seamlessly with SpacetimeDB's real-time synchronization.
• Objective: Demonstrate SpacetimeDB's features and best practices in a fun, interactive project.

---

Tutorial Overview

This repository accompanies the Blackholio Unity Tutorial, which guides you through building the game from scratch while learning:

• Unity integration with SpacetimeDB.
• Client-server setup for multiplayer games.
• SpacetimeDB features, including reducers, tables, and scheduled events.

By following the tutorial, you'll develop:

1. A basic understanding of SpacetimeDB for multiplayer games.
2. A functional game prototype with scalable multiplayer features.

Need help with the tutorial? Join our Discord server!

---

Getting Started

If you want to follow a more structured tutorial where it shows you how to set everything up, start with our Blackholio Tutorial.

If you just want to checkout the final project and play around a bit, follow these steps:

1. Install SpacetimeDB CLI
2. Start SpacetimeDB in a separate terminal with spacetime start.
3. Clone this repository:

   git clone https://github.com/ClockworkLabs/SpacetimeDB.git
   cd SpacetimeDB/demo/Blackholio
   

4. Publish the server logic. You can either publish the csharp server or the rust server.

   cd server-rust/
   # Upload the module to SpacetimeDB
   bash ./publish.sh
   # Update the client bindings in case they are out of date
   bash ./generate.sh
   

5. Install Unity Hub and Unity version 2021.2 or newer.
6. Open the scene named Main.unity
7. Hit play!

You should be prompted for a username and you should be able to move around, eat food and defeat other players!

---

Features

• Core Gameplay: Consume, grow, and dominate.
• Multiplayer: Scales to hundreds of players with SpacetimeDB.
• Dynamic Gameplay: Spawning, movement, collisions, and evolution mechanics.
• Learn by Building: Explore the mechanics of Unity and SpacetimeDB through the tutorial.

---

Repository Structure

Blackholio/
├── client-unity/      # Unity client project
├── server-rust/       # SpacetimeDB server module (Rust implementation)
├── server-csharp/     # SpacetimeDB server module (C# implementation)
├── docs/              # Tutorial documentation and images
└── README.md          # This file

---

Requirements

• Unity: Version 2021.2 or newer.
• Rust: Version 1.65.0 or later (for the SpacetimeDB server module).
• SpacetimeDB CLI: Installed via SpacetimeDB installation guide.

---

Resources

• SpacetimeDB Documentation
• Join our Discord Community
• Agar.io (inspiration)

---

License

This project is licensed under the Apache License.

Feel free to fork, modify, and use Blackholio as a starting point for your own projects. Contributions are welcome!

---

Feedback

We'd love to hear your thoughts on the tutorial or game! Open an issue in the repository or chat with us on Discord.

Happy developing, and enjoy creating the cosmos with Blackholio! 🚀