Skip to content

Commit d605754

Browse files
andrewgazelkaandrewgazelka
authored
docs: update README (#871)
1 parent 9792bce commit d605754

File tree

1 file changed

+30
-41
lines changed

1 file changed

+30
-41
lines changed

‎README.md

Lines changed: 30 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,8 @@
66
[![Issues](https://img.shields.io/github/issues/andrewgazelka/hyperion)](https://github.com/andrewgazelka/hyperion/issues)
77
[![Last Commit](https://img.shields.io/github/last-commit/andrewgazelka/hyperion)](https://github.com/andrewgazelka/hyperion/commits)
88

9-
Thank you for your hard work[^1] [@CuzImClicks](https://github.com/CuzImClicks), [@Indra-db](https://github.com/Indra-db), [@james-j-obrien](https://github.com/james-j-obrien), [@Ruben2424](https://github.com/Ruben2424), [@SanderMertens](https://github.com/SanderMertens), [@Tebarem](https://github.com/Tebarem), and [@TestingPlant](https://github.com/TestingPlant).
10-
11-
Hyperion is a **Minecraft game engine** that aims to enable a 10k player PvP battle to break the Guinness World
12-
Record ([8825 by
9+
Hyperion is a **Minecraft game engine** that can have 170,000+ players in one world. Our pilot event hopes to break the PvP Guinness World
10+
Record of ([8825 by
1311
EVE Online](https://www.guinnessworldrecords.com/world-records/105603-largest-videogame-pvp-battle)). The
1412
architecture is ECS-driven using [Flecs Rust](https://github.com/Indra-db/Flecs-Rust).
1513

@@ -18,12 +16,32 @@ architecture is ECS-driven using [Flecs Rust](https://github.com/Indra-db/Flecs-
1816
1917
https://github.com/user-attachments/assets/64a4a8c7-f375-4821-a1c7-0efc69c1ae0b
2018

21-
## Event
2219

23-
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.
24-
25-
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.
20+
## Feature Status
2621

22+
| Feature | Status | Notes |
23+
|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
24+
| **Technical Infrastructure** | | |
25+
| 🧵 Multi-threading | ✅ Implemented | Vertical scaling |
26+
| 🔄 Proxy Layer | ✅ Implemented | Horizontal scaling |
27+
| 📊 Performance Tracing | ✅ Implemented | Using Tracy profiler |
28+
| 🛡️ Basic Anti-Cheat | ✅ Implemented | Core anti-cheat functionality |
29+
| 🔧 Moderator Tools | 🚧 WIP [#425](https://github.com/andrewgazelka/hyperion/issues/425), [@Kumpelinus](https://github.com/Kumpelinus) | Admin controls and monitoring |
30+
| 🔌 Plugin API | ✅ Implemented | Extensible plugin system; see [`events/tag`](https://github.com/andrewgazelka/hyperion/tree/main/events/tag) |
31+
| **Core Game Mechanics** | | |
32+
| 🧱 Block Breaking/Placing | ✅ Implemented | Including physics simulation |
33+
| 💫 Entity Collisions | ✅ Implemented | Both entity-entity and block-entity |
34+
| 💡 Lighting Engine | ✅ Implemented | Dynamic lighting updates |
35+
| 🌐 World Borders | ✅ Implemented | Configurable boundaries |
36+
| 🛠️ Block Edit API | ✅ Implemented | WorldEdit-like functionality |
37+
| ⚔️ PvP Combat | ✅ Implemented | Custom combat mechanics |
38+
| 🎒 Inventory System | ✅ Implemented | Full item management |
39+
| 🎯 Raycasting | ✅ Implemented | Required for ranged combat/arrows |
40+
| **Player Experience** | | |
41+
| ✨ Particle Effects | ✅ Implemented | Full particle support |
42+
| 💬 Chat System | ✅ Implemented | Global and proximity chat |
43+
| ⌨️ Commands | ✅ Implemented | Custom command framework |
44+
| 🎤 Proximity Voice | ✅ Implemented | Using Simple Voice Chat |
2745

2846
## Benchmarks
2947

@@ -39,8 +57,6 @@ We're partnering with [TheMisterEpic](https://www.youtube.com/channel/UCJiFgnnYp
3957
![performance](https://github.com/user-attachments/assets/d15f2e72-eeef-4cfd-af39-e90d72732968)
4058

4159

42-
*= with UNIX sockets, not TCP sockets. Once I get better tests, I will fill in core usage and CPU utilization.
43-
4460
**Test Environment:**
4561

4662
- Machine: 2023 MacBook Pro Max 16" (14-cores)
@@ -196,37 +212,6 @@ docker compose up --build
196212
- Proximity Voice: Simple Voice Chat
197213
- Max estimated player count: ~176,056
198214

199-
## Feature Status
200-
201-
| Feature | Status | Notes |
202-
|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
203-
| **Technical Infrastructure** | | |
204-
| 🧵 Multi-threading | ✅ Implemented | Vertical scaling |
205-
| 🔄 Proxy Layer | ✅ Implemented | Horizontal scaling |
206-
| 📊 Performance Tracing | ✅ Implemented | Using Tracy profiler |
207-
| 🛡️ Basic Anti-Cheat | ✅ Implemented | Core anti-cheat functionality |
208-
| 🔧 Moderator Tools | 🚧 WIP [#425](https://github.com/andrewgazelka/hyperion/issues/425), [@Kumpelinus](https://github.com/Kumpelinus) | Admin controls and monitoring |
209-
| 🔌 Plugin API | ✅ Implemented | Extensible plugin system; see [`events/tag`](https://github.com/andrewgazelka/hyperion/tree/main/events/tag) |
210-
| **Core Game Mechanics** | | |
211-
| 🧱 Block Breaking/Placing | ✅ Implemented | Including physics simulation |
212-
| 💫 Entity Collisions | ✅ Implemented | Both entity-entity and block-entity |
213-
| 💡 Lighting Engine | ✅ Implemented | Dynamic lighting updates |
214-
| 🌐 World Borders | ✅ Implemented | Configurable boundaries |
215-
| 🛠️ Block Edit API | ✅ Implemented | WorldEdit-like functionality |
216-
| ⚔️ PvP Combat | ✅ Implemented | Custom combat mechanics |
217-
| 🎒 Inventory System | ✅ Implemented | Full item management |
218-
| 🎯 Raycasting | 🚧 WIP [#580](https://github.com/andrewgazelka/hyperion/issues/580) [#584](https://github.com/andrewgazelka/hyperion/issues/584) [#598](https://github.com/andrewgazelka/hyperion/issues/598) | Required for ranged combat/arrows |
219-
| **Player Experience** | | |
220-
| ✨ Particle Effects | ✅ Implemented | Full particle support |
221-
| 💬 Chat System | ✅ Implemented | Global and proximity chat |
222-
| ⌨️ Commands | ✅ Implemented | Custom command framework |
223-
| 🎤 Proximity Voice | ✅ Implemented | Using Simple Voice Chat |
224-
225-
Legend:
226-
- ✅ Implemented
227-
- 🚧 WIP/Planned
228-
- ❌ Not Planned
229-
230215
**Note:** This feature list represents core functionality. Hyperion is designed to be modular meaning you can implement
231216
your own mechanics and replace the core mechanics with your own.
232217

@@ -235,4 +220,8 @@ your own mechanics and replace the core mechanics with your own.
235220
[![Star History Chart](https://api.star-history.com/svg?repos=andrewgazelka/hyperion&type=Date)](https://star-history.com/#andrewgazelka/hyperion&Date)
236221

237222

223+
Thank you for your hard work[^1] [@CuzImClicks](https://github.com/CuzImClicks), [@Indra-db](https://github.com/Indra-db), [@james-j-obrien](https://github.com/james-j-obrien), [@Ruben2424](https://github.com/Ruben2424), [@SanderMertens](https://github.com/SanderMertens), [@Tebarem](https://github.com/Tebarem), and [@TestingPlant](https://github.com/TestingPlant).
224+
225+
238226
[^1]: alphabetically ordered
227+

0 commit comments

Comments
 (0)