Skip to content

Commit d10c01c

Browse files
ItzKatzeItzKatze
committed
doc work
1 parent 74674ef commit d10c01c

9 files changed

Lines changed: 101 additions & 97 deletions

File tree

‎website/docs/docker/adding-servers.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ Add this template to your `docker-compose.yml`:
2828
2929
Replace the placeholders:
3030
31-
| Placeholder | Description | Example |
32-
|-------------|-------------|---------|
31+
| Placeholder | Description | Example |
32+
|-----------------|-----------------------|--------------------|
3333
| `<server_name>` | Unique container name | `hypixelcore_hub2` |
34-
| `<ServerType>` | Valid ServerType enum | `SKYBLOCK_HUB` |
34+
| `<ServerType>` | Valid ServerType enum | `SKYBLOCK_HUB` |
3535

3636
## Example: Adding a Second Hub
3737

‎website/docs/docker/setup.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -58,14 +58,14 @@ Or use the stop button in Docker Desktop.
5858

5959
The Docker Compose setup starts:
6060

61-
| Container | Purpose |
62-
|-----------|---------|
63-
| MongoDB | Database |
64-
| Redis | Caching & messaging |
65-
| Velocity Proxy | Player connections |
66-
| NanoLimbo | Connection queue |
67-
| Game Servers | Gameplay instances |
68-
| Services | Microservices |
61+
| Container | Purpose |
62+
|----------------|---------------------|
63+
| MongoDB | Database |
64+
| Redis | Caching & messaging |
65+
| Velocity Proxy | Player connections |
66+
| NanoLimbo | Connection queue |
67+
| Game Servers | Gameplay instances |
68+
| Services | Microservices |
6969

7070
## Logs and Debugging
7171

‎website/docs/introduction.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ This implementation is under active development and is not yet production-ready.
1919

2020
The project is organized into several module types:
2121

22-
| Module Type | Purpose |
23-
|-------------|---------|
24-
| `commons` | Shared enums, configs, and protocols |
25-
| `service.*` | Independent microservices (API, Auctions, Bazaar, etc.) |
26-
| `type.*` | Server type implementations (Hub, Island, Dungeons, etc.) |
27-
| `loader` | Main entry point (HypixelCore.jar) |
28-
| `velocity.extension` | Velocity proxy plugin |
29-
| `packer` | Resource pack builder |
22+
| Module Type | Purpose |
23+
|----------------------|-----------------------------------------------------------|
24+
| `commons` | Shared enums, configs, and protocols |
25+
| `service.*` | Independent microservices (API, Auctions, Bazaar, etc.) |
26+
| `type.*` | Server type implementations (Hub, Island, Dungeons, etc.) |
27+
| `loader` | Main entry point (HypixelCore.jar) |
28+
| `velocity.extension` | Velocity proxy plugin |
29+
| `packer` | Resource pack builder |
3030

3131
## Related Projects
3232

‎website/docs/reference/configuration.md‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ The main configuration file shared by all servers and services.
2020

2121
### Fields
2222

23-
| Field | Required | Description |
24-
|-------|----------|-------------|
25-
| `velocity-secret` | Yes | Must match `forwarding.secret` from Velocity |
26-
| `mongodb-uri` | Yes | MongoDB connection string |
27-
| `redis-uri` | Yes | Redis connection string |
28-
| `resource-pack-url` | No | URL to download resource pack |
29-
| `resource-pack-hash` | No | SHA1 hash for pack verification |
23+
| Field | Required | Description |
24+
|----------------------|----------|----------------------------------------------|
25+
| `velocity-secret` | Yes | Must match `forwarding.secret` from Velocity |
26+
| `mongodb-uri` | Yes | MongoDB connection string |
27+
| `redis-uri` | Yes | Redis connection string |
28+
| `resource-pack-url` | No | URL to download resource pack |
29+
| `resource-pack-hash` | No | SHA1 hash for pack verification |
3030

3131
### Docker Configuration
3232

@@ -140,24 +140,24 @@ services/
140140
141141
Some settings can be overridden via environment variables:
142142
143-
| Variable | Description |
144-
|----------|-------------|
143+
| Variable | Description |
144+
|---------------|-----------------------------|
145145
| `MONGODB_URI` | Override MongoDB connection |
146-
| `REDIS_URI` | Override Redis connection |
147-
| `API_PORT` | Override API service port |
146+
| `REDIS_URI` | Override Redis connection |
147+
| `API_PORT` | Override API service port |
148148
149149
## Database Collections
150150
151151
MongoDB collections created automatically:
152152
153-
| Collection | Purpose |
154-
|------------|---------|
155-
| `profiles` | Player profiles and data |
156-
| `users` | User accounts |
157-
| `auction_active` | Active auctions |
158-
| `auction_inactive` | Completed auctions |
159-
| `orders` | Bazaar orders |
160-
| `tracked_items` | Item tracking |
161-
| `regions` | World regions |
162-
| `fairysouls` | Fairy soul locations |
163-
| `crystals` | Hub crystal locations |
153+
| Collection | Purpose |
154+
|--------------------|--------------------------|
155+
| `profiles` | Player profiles and data |
156+
| `users` | User accounts |
157+
| `auction_active` | Active auctions |
158+
| `auction_inactive` | Completed auctions |
159+
| `orders` | Bazaar orders |
160+
| `tracked_items` | Item tracking |
161+
| `regions` | World regions |
162+
| `fairysouls` | Fairy soul locations |
163+
| `crystals` | Hub crystal locations |

‎website/docs/reference/server-types.md‎

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6,35 +6,39 @@ ServerTypes define the different game modes and locations that can be run as sep
66

77
These server types are part of the SkyBlock gamemode and share SkyBlock-specific functionality.
88

9-
| ServerType | Description | World Required |
10-
|------------|-------------|----------------|
11-
| `SKYBLOCK_ISLAND` | Player personal islands | `hypixel_skyblock_island_template` |
12-
| `SKYBLOCK_HUB` | Main SkyBlock hub | `hypixel_skyblock_hub` |
13-
| `SKYBLOCK_SPIDERS_DEN` | Spider's Den area | Custom world |
14-
| `SKYBLOCK_THE_END` | The End dimension | Custom world |
15-
| `SKYBLOCK_DUNGEON_HUB` | Dungeon hub area | Custom world |
16-
| `SKYBLOCK_THE_FARMING_ISLANDS` | Farming Islands | Custom world |
17-
| `SKYBLOCK_GOLD_MINE` | Gold Mine location | Custom world |
18-
| `SKYBLOCK_DEEP_CAVERNS` | Deep Caverns area | Custom world |
19-
| `SKYBLOCK_DWARVEN_MINES` | Dwarven Mines | Custom world |
9+
| ServerType | Description | World Required |
10+
|--------------------------------|-----------------|------------------------------------|
11+
| `SKYBLOCK_ISLAND` | Personal Island | `hypixel_skyblock_island_template` |
12+
| `SKYBLOCK_HUB` | Hub | `hypixel_skyblock_hub` |
13+
| `SKYBLOCK_SPIDERS_DEN` | Spider's Den | `hypixel_skyblock_spiders_den` |
14+
| `SKYBLOCK_THE_END` | The End | `hypixel_skyblock_the_end` |
15+
| `SKYBLOCK_CRIMSON_ISLE` | Crimson isle | `hypixel_skyblock_crimson_isle` |
16+
| `SKYBLOCK_DUNGEON_HUB` | Dungeon hub | `hypixel_skyblock_dungeon_hub` |
17+
| `SKYBLOCK_THE_FARMING_ISLANDS` | Farming Islands | `hypixel_skyblock_hub` |
18+
| `SKYBLOCK_GOLD_MINE` | Gold Mine | `hypixel_skyblock_gold_mine` |
19+
| `SKYBLOCK_DEEP_CAVERNS` | Deep Caverns | `hypixel_skyblock_deep_caverns` |
20+
| `SKYBLOCK_DWARVEN_MINES` | Dwarven Mines | `hypixel_skyblock_dwarven_mines` |
21+
| `SKYBLOCK_THE_PARK` | The Park | `hypixel_skyblock_the_park` |
22+
| `SKYBLOCK_GALATEA` | Galatea | `hypixel_skyblock_galatea` |
23+
| `SKYBLOCK_BACKWATER_BAYOU` | Backwater Bayou | `hypixel_skyblock_galatea` |
2024

2125
### Starting a SkyBlock Server
2226

2327
```bash
24-
java -jar HypixelCore.jar SKYBLOCK_HUB
2528
java -jar HypixelCore.jar SKYBLOCK_ISLAND
29+
java -jar HypixelCore.jar SKYBLOCK_HUB
2630
java -jar HypixelCore.jar SKYBLOCK_SPIDERS_DEN
2731
```
2832

2933
## Non-SkyBlock Server Types
3034

3135
These server types run independently of SkyBlock features.
3236

33-
| ServerType | Description |
34-
|------------|-------------|
35-
| `PROTOTYPE_LOBBY` | Prototype/testing lobby |
36-
| `BEDWARS_LOBBY` | BedWars lobby server |
37-
| `BEDWARS_GAME` | Active BedWars game server |
37+
| ServerType | Description |
38+
|------------------------|--------------------------------|
39+
| `PROTOTYPE_LOBBY` | Prototype/testing lobby |
40+
| `BEDWARS_LOBBY` | BedWars lobby server |
41+
| `BEDWARS_GAME` | Active BedWars game server |
3842
| `BEDWARS_CONFIGURATOR` | BedWars map configuration tool |
3943

4044
### Starting Non-SkyBlock Servers
@@ -106,11 +110,11 @@ The proxy will distribute players across all available instances.
106110

107111
### Required Worlds
108112

109-
| World | Location | Used By |
110-
|-------|----------|---------|
111-
| `hypixel_skyblock_hub` | `configuration/skyblock/islands/` | SKYBLOCK_HUB |
113+
| World | Location | Used By |
114+
|------------------------------------|-----------------------------------|-----------------|
115+
| `hypixel_skyblock_hub` | `configuration/skyblock/islands/` | SKYBLOCK_HUB |
112116
| `hypixel_skyblock_island_template` | `configuration/skyblock/islands/` | SKYBLOCK_ISLAND |
113-
| `hypixel_prototype_lobby` | `configuration/` | PROTOTYPE_LOBBY |
117+
| `hypixel_prototype_lobby` | `configuration/` | PROTOTYPE_LOBBY |
114118

115119
### Custom Worlds
116120

@@ -119,16 +123,16 @@ Other locations require their own world files. These can be created or obtained
119123
## Docker Reference
120124

121125
```yaml
122-
# SkyBlock Hub
123-
hypixelcore_hub:
124-
environment:
125-
SERVICE_CMD: java -jar HypixelCore.jar SKYBLOCK_HUB
126-
127126
# SkyBlock Island
128127
hypixelcore_island:
129128
environment:
130129
SERVICE_CMD: java -jar HypixelCore.jar SKYBLOCK_ISLAND
131130

131+
# SkyBlock Hub
132+
hypixelcore_hub:
133+
environment:
134+
SERVICE_CMD: java -jar HypixelCore.jar SKYBLOCK_HUB
135+
132136
# Spider's Den
133137
hypixelcore_spiders:
134138
environment:

‎website/docs/reference/services.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Services Reference
22

3-
Services are microservices that handle specific features independently from game servers.
3+
Services are microservices that handle specific features independently of game servers.
44

55
## Architecture Overview
66

@@ -237,16 +237,16 @@ ServiceInitializer.register(
237237

238238
## Memory Requirements
239239

240-
| Service | Minimum RAM | Recommended RAM |
241-
|---------|-------------|-----------------|
242-
| API | 256 MB | 512 MB |
243-
| Auction House | 256 MB | 512 MB |
244-
| Bazaar | 256 MB | 512 MB |
245-
| Party | 128 MB | 256 MB |
246-
| Item Tracker | 128 MB | 256 MB |
247-
| Data Mutex | 128 MB | 256 MB |
248-
| Dark Auction | 128 MB | 256 MB |
249-
| Orchestrator | 128 MB | 256 MB |
240+
| Service | Minimum RAM | Recommended RAM |
241+
|---------------|-------------|-----------------|
242+
| API | 256 MB | 512 MB |
243+
| Auction House | 256 MB | 512 MB |
244+
| Bazaar | 256 MB | 512 MB |
245+
| Party | 128 MB | 256 MB |
246+
| Item Tracker | 128 MB | 256 MB |
247+
| Data Mutex | 128 MB | 256 MB |
248+
| Dark Auction | 128 MB | 256 MB |
249+
| Orchestrator | 128 MB | 256 MB |
250250

251251
## Docker Reference
252252

‎website/docs/requirements.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,12 @@ This project requires substantial resources to run properly. Make sure your syst
4040

4141
The following ports are used by default:
4242

43-
| Port | Service |
44-
|------|---------|
43+
| Port | Service |
44+
|-------|-------------------------------------|
4545
| 25565 | Velocity Proxy (player connections) |
46-
| 27017 | MongoDB |
47-
| 6379 | Redis |
48-
| 8080 | API Service |
46+
| 27017 | MongoDB |
47+
| 6379 | Redis |
48+
| 8080 | API Service |
4949

5050
:::alert warning
5151
Ensure these ports are available and not blocked by your firewall when running locally.

‎website/docs/setup/game-servers.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,11 @@ Copy the `forwarding.secret` from your Velocity proxy directory and add it to `r
5050

5151
Extract the world files download and place them:
5252

53-
| World | Location |
54-
|-------|----------|
55-
| SkyBlock Hub | `configuration/skyblock/islands/hypixel_skyblock_hub/` |
53+
| World | Location |
54+
|-----------------|--------------------------------------------------------------------|
55+
| SkyBlock Hub | `configuration/skyblock/islands/hypixel_skyblock_hub/` |
5656
| Island Template | `configuration/skyblock/islands/hypixel_skyblock_island_template/` |
57-
| Prototype Lobby | `configuration/hypixel_prototype_lobby/` |
57+
| Prototype Lobby | `configuration/hypixel_prototype_lobby/` |
5858

5959
### 4. Install Data Files
6060

‎website/docs/setup/services.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ Services are independent microservices that handle specific features. They commu
44

55
## Overview
66

7-
| Service | JAR Name | Purpose |
8-
|---------|----------|---------|
9-
| API | `ServiceAPI.jar` | REST API for external access |
10-
| Auction House | `ServiceAuctionHouse.jar` | Manages auction listings |
11-
| Bazaar | `ServiceBazaar.jar` | Market/trading operations |
12-
| Party | `ServiceParty.jar` | Player party management |
13-
| Item Tracker | `ServiceItemTracker.jar` | Tracks items across servers |
14-
| Data Mutex | `ServiceDataMutex.jar` | Distributed data locking |
15-
| Dark Auction | `ServiceDarkAuction.jar` | Dark auction events |
16-
| Orchestrator | `ServiceOrchestrator.jar` | Game server orchestration |
7+
| Service | JAR Name | Purpose |
8+
|---------------|---------------------------|------------------------------|
9+
| API | `ServiceAPI.jar` | REST API for external access |
10+
| Auction House | `ServiceAuctionHouse.jar` | Manages auction listings |
11+
| Bazaar | `ServiceBazaar.jar` | Market/trading operations |
12+
| Party | `ServiceParty.jar` | Player party management |
13+
| Item Tracker | `ServiceItemTracker.jar` | Tracks items across servers |
14+
| Data Mutex | `ServiceDataMutex.jar` | Distributed data locking |
15+
| Dark Auction | `ServiceDarkAuction.jar` | Dark auction events |
16+
| Orchestrator | `ServiceOrchestrator.jar` | Game server orchestration |
1717

1818
## Download
1919

0 commit comments

Comments
 (0)