Skip to content

Commit c16bc4f

Browse files
authored
Add instructions to README (#28)
* Add instructions to README * Update README.md
1 parent 73aa138 commit c16bc4f

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

demo/Blackholio/README.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,30 @@ Need help with the tutorial? [Join our Discord server](https://discord.gg/spacet
2525
---
2626

2727
### **Getting Started**
28-
To get started, follow these steps:
28+
If you want to follow a more structured tutorial where it shows you how to set everything up, start with our [Blackholio Tutorial](https://spacetimedb.com/docs/unity/part-1).
2929

30-
1. Clone this repository:
30+
If you just want to checkout the final project and play around a bit, follow these steps:
31+
32+
1. [Install SpacetimeDB CLI](https://spacetimedb.com/install)
33+
2. Start SpacetimeDB in a separate terminal with `spacetime start`.
34+
3. Clone this repository:
3135
```bash
3236
git clone https://github.com/ClockworkLabs/Blackholio.git
3337
cd Blackholio
3438
```
35-
2. Install [Unity Hub](https://unity.com/download) and Unity **2022.3.32f1 LTS**.
36-
3. Follow the tutorial parts:
37-
- [Part 1: Setup](https://spacetimedb.com/docs/unity/part-1)
38-
- [Part 2: Connecting to SpacetimeDB](https://spacetimedb.com/docs/unity/part-2)
39-
- [Part 3: Gameplay](https://spacetimedb.com/docs/unity/part-3)
40-
- [Part 4: Moving and Colliding](https://spacetimedb.com/docs/unity/part-4)
39+
4. Publish the server logic. You can either publish the csharp server or the rust server.
40+
```bash
41+
cd server-rust/
42+
# Upload the module to SpacetimeDB
43+
bash ./publish.sh
44+
# Update the client bindings in case they are out of date
45+
bash ./generate.sh
46+
```
47+
5. Install [Unity Hub](https://unity.com/download) and Unity version **2021.2** or newer.
48+
6. Open the scene named `Main.unity`
49+
7. Hit play!
4150

42-
4. Run the game using the Unity Editor or build for your platform.
51+
You should be prompted for a username and you should be able to move around, eat food and defeat other players!
4352

4453
---
4554

@@ -65,7 +74,7 @@ Blackholio/
6574
---
6675

6776
### **Requirements**
68-
- **Unity**: Version `2022.3.32f1 LTS` or later.
77+
- **Unity**: Version `2021.2` or newer.
6978
- **Rust**: Version `1.65.0` or later (for the SpacetimeDB server module).
7079
- **SpacetimeDB CLI**: Installed via [SpacetimeDB installation guide](https://spacetimedb.com/docs/install).
7180

0 commit comments

Comments
 (0)