Skip to content

Commit 4dc26b0

Browse files
docs: improve
1 parent 4925bcd commit 4dc26b0

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ architecture is ECS-driven using [Flecs Rust](https://github.com/Indra-db/Flecs-
1616

1717
https://github.com/user-attachments/assets/64a4a8c7-f375-4821-a1c7-0efc69c1ae0b
1818

19-
# Event
19+
## Event
2020

2121
The upcoming 10k-player PvP event draws inspiration from the class progression systems and [tag mode](https://diepio.fandom.com/wiki/Tag) from [diep.io](https://diep.io/). The gameplay mechanics also draw influence from Hypixel Pit's combat systems. Players will gain levels (XP) from mining ore and killing other players.
2222

2323
We're partnering with [TheMisterEpic](https://www.youtube.com/channel/UCJiFgnnYpwlnadzTzhMnX_Q) to run an initial proof-of-concept event with around 2k players. Following its success, we'll host the full-scale 10,000-player PvP battle alongside numerous YouTubers and streamers.
2424

2525

26-
# Benchmarks
26+
## Benchmarks
2727

2828
| Players | Tick Time (ms) | Core Usage (%) | Total CPU Utilization (%) |
2929
|---------|----------------|----------------|---------------------------|
@@ -59,9 +59,9 @@ be horizontally scaled to maintain performance as player count grows.
5959
![image](https://github.com/user-attachments/assets/65fc6d7b-7e73-44e0-afac-cae928d443b6)
6060

6161

62-
# Architecture
62+
## Architecture
6363

64-
## Overview
64+
### Overview
6565
```mermaid
6666
flowchart TB
6767
subgraph GameServer["Game Server (↕️ Scaled)"]
@@ -128,7 +128,7 @@ flowchart TB
128128
class TokioIO async
129129
```
130130

131-
## Proxy
131+
### Proxy
132132

133133
```mermaid
134134
sequenceDiagram
@@ -162,21 +162,21 @@ sequenceDiagram
162162
```
163163

164164

165-
# Running
165+
## Running
166166

167-
## Debug mode
167+
### Debug mode
168168

169169
```bash
170170
docker compose up --build
171171
```
172172

173-
## Release mode
173+
### Release mode
174174

175175
```bash
176176
docker compose -f docker-compose.release.yml up --build
177177
```
178178

179-
# Features
179+
## Features
180180

181181
**Language:** Rust
182182
**Goal:** Game engine for massive events
@@ -221,3 +221,7 @@ Legend:
221221

222222
**Note:** This feature list represents core functionality. Hyperion is designed to be modular meaning you can implement
223223
your own mechanics and replace the core mechanics with your own.
224+
225+
## Star History
226+
227+
[![Star History Chart](https://api.star-history.com/svg?repos=andrewgazelka/hyperion&type=Date)](https://star-history.com/#andrewgazelka/hyperion&Date)

0 commit comments

Comments
 (0)