From d10c01c16aa07b533577e5fb758380da39bedfad Mon Sep 17 00:00:00 2001 From: ItzKatze <136186750+ItzKatze@users.noreply.github.com> Date: Fri, 26 Dec 2025 16:38:47 +0100 Subject: [PATCH] doc work --- website/docs/docker/adding-servers.md | 6 +-- website/docs/docker/setup.md | 16 +++---- website/docs/introduction.md | 16 +++---- website/docs/reference/configuration.md | 44 +++++++++---------- website/docs/reference/server-types.md | 56 +++++++++++++------------ website/docs/reference/services.md | 22 +++++----- website/docs/requirements.md | 10 ++--- website/docs/setup/game-servers.md | 8 ++-- website/docs/setup/services.md | 20 ++++----- 9 files changed, 101 insertions(+), 97 deletions(-) diff --git a/website/docs/docker/adding-servers.md b/website/docs/docker/adding-servers.md index 47f0c2e1d..509bbfd92 100644 --- a/website/docs/docker/adding-servers.md +++ b/website/docs/docker/adding-servers.md @@ -28,10 +28,10 @@ Add this template to your `docker-compose.yml`: Replace the placeholders: -| Placeholder | Description | Example | -|-------------|-------------|---------| +| Placeholder | Description | Example | +|-----------------|-----------------------|--------------------| | `` | Unique container name | `hypixelcore_hub2` | -| `` | Valid ServerType enum | `SKYBLOCK_HUB` | +| `` | Valid ServerType enum | `SKYBLOCK_HUB` | ## Example: Adding a Second Hub diff --git a/website/docs/docker/setup.md b/website/docs/docker/setup.md index 9111279ab..20c37e232 100644 --- a/website/docs/docker/setup.md +++ b/website/docs/docker/setup.md @@ -58,14 +58,14 @@ Or use the stop button in Docker Desktop. The Docker Compose setup starts: -| Container | Purpose | -|-----------|---------| -| MongoDB | Database | -| Redis | Caching & messaging | -| Velocity Proxy | Player connections | -| NanoLimbo | Connection queue | -| Game Servers | Gameplay instances | -| Services | Microservices | +| Container | Purpose | +|----------------|---------------------| +| MongoDB | Database | +| Redis | Caching & messaging | +| Velocity Proxy | Player connections | +| NanoLimbo | Connection queue | +| Game Servers | Gameplay instances | +| Services | Microservices | ## Logs and Debugging diff --git a/website/docs/introduction.md b/website/docs/introduction.md index 413f7dbbf..11a50b007 100644 --- a/website/docs/introduction.md +++ b/website/docs/introduction.md @@ -19,14 +19,14 @@ This implementation is under active development and is not yet production-ready. The project is organized into several module types: -| Module Type | Purpose | -|-------------|---------| -| `commons` | Shared enums, configs, and protocols | -| `service.*` | Independent microservices (API, Auctions, Bazaar, etc.) | -| `type.*` | Server type implementations (Hub, Island, Dungeons, etc.) | -| `loader` | Main entry point (HypixelCore.jar) | -| `velocity.extension` | Velocity proxy plugin | -| `packer` | Resource pack builder | +| Module Type | Purpose | +|----------------------|-----------------------------------------------------------| +| `commons` | Shared enums, configs, and protocols | +| `service.*` | Independent microservices (API, Auctions, Bazaar, etc.) | +| `type.*` | Server type implementations (Hub, Island, Dungeons, etc.) | +| `loader` | Main entry point (HypixelCore.jar) | +| `velocity.extension` | Velocity proxy plugin | +| `packer` | Resource pack builder | ## Related Projects diff --git a/website/docs/reference/configuration.md b/website/docs/reference/configuration.md index a96960fbb..ceaa27c7a 100644 --- a/website/docs/reference/configuration.md +++ b/website/docs/reference/configuration.md @@ -20,13 +20,13 @@ The main configuration file shared by all servers and services. ### Fields -| Field | Required | Description | -|-------|----------|-------------| -| `velocity-secret` | Yes | Must match `forwarding.secret` from Velocity | -| `mongodb-uri` | Yes | MongoDB connection string | -| `redis-uri` | Yes | Redis connection string | -| `resource-pack-url` | No | URL to download resource pack | -| `resource-pack-hash` | No | SHA1 hash for pack verification | +| Field | Required | Description | +|----------------------|----------|----------------------------------------------| +| `velocity-secret` | Yes | Must match `forwarding.secret` from Velocity | +| `mongodb-uri` | Yes | MongoDB connection string | +| `redis-uri` | Yes | Redis connection string | +| `resource-pack-url` | No | URL to download resource pack | +| `resource-pack-hash` | No | SHA1 hash for pack verification | ### Docker Configuration @@ -140,24 +140,24 @@ services/ Some settings can be overridden via environment variables: -| Variable | Description | -|----------|-------------| +| Variable | Description | +|---------------|-----------------------------| | `MONGODB_URI` | Override MongoDB connection | -| `REDIS_URI` | Override Redis connection | -| `API_PORT` | Override API service port | +| `REDIS_URI` | Override Redis connection | +| `API_PORT` | Override API service port | ## Database Collections MongoDB collections created automatically: -| Collection | Purpose | -|------------|---------| -| `profiles` | Player profiles and data | -| `users` | User accounts | -| `auction_active` | Active auctions | -| `auction_inactive` | Completed auctions | -| `orders` | Bazaar orders | -| `tracked_items` | Item tracking | -| `regions` | World regions | -| `fairysouls` | Fairy soul locations | -| `crystals` | Hub crystal locations | +| Collection | Purpose | +|--------------------|--------------------------| +| `profiles` | Player profiles and data | +| `users` | User accounts | +| `auction_active` | Active auctions | +| `auction_inactive` | Completed auctions | +| `orders` | Bazaar orders | +| `tracked_items` | Item tracking | +| `regions` | World regions | +| `fairysouls` | Fairy soul locations | +| `crystals` | Hub crystal locations | diff --git a/website/docs/reference/server-types.md b/website/docs/reference/server-types.md index b74ccf48d..9b5aee576 100644 --- a/website/docs/reference/server-types.md +++ b/website/docs/reference/server-types.md @@ -6,23 +6,27 @@ ServerTypes define the different game modes and locations that can be run as sep These server types are part of the SkyBlock gamemode and share SkyBlock-specific functionality. -| ServerType | Description | World Required | -|------------|-------------|----------------| -| `SKYBLOCK_ISLAND` | Player personal islands | `hypixel_skyblock_island_template` | -| `SKYBLOCK_HUB` | Main SkyBlock hub | `hypixel_skyblock_hub` | -| `SKYBLOCK_SPIDERS_DEN` | Spider's Den area | Custom world | -| `SKYBLOCK_THE_END` | The End dimension | Custom world | -| `SKYBLOCK_DUNGEON_HUB` | Dungeon hub area | Custom world | -| `SKYBLOCK_THE_FARMING_ISLANDS` | Farming Islands | Custom world | -| `SKYBLOCK_GOLD_MINE` | Gold Mine location | Custom world | -| `SKYBLOCK_DEEP_CAVERNS` | Deep Caverns area | Custom world | -| `SKYBLOCK_DWARVEN_MINES` | Dwarven Mines | Custom world | +| ServerType | Description | World Required | +|--------------------------------|-----------------|------------------------------------| +| `SKYBLOCK_ISLAND` | Personal Island | `hypixel_skyblock_island_template` | +| `SKYBLOCK_HUB` | Hub | `hypixel_skyblock_hub` | +| `SKYBLOCK_SPIDERS_DEN` | Spider's Den | `hypixel_skyblock_spiders_den` | +| `SKYBLOCK_THE_END` | The End | `hypixel_skyblock_the_end` | +| `SKYBLOCK_CRIMSON_ISLE` | Crimson isle | `hypixel_skyblock_crimson_isle` | +| `SKYBLOCK_DUNGEON_HUB` | Dungeon hub | `hypixel_skyblock_dungeon_hub` | +| `SKYBLOCK_THE_FARMING_ISLANDS` | Farming Islands | `hypixel_skyblock_hub` | +| `SKYBLOCK_GOLD_MINE` | Gold Mine | `hypixel_skyblock_gold_mine` | +| `SKYBLOCK_DEEP_CAVERNS` | Deep Caverns | `hypixel_skyblock_deep_caverns` | +| `SKYBLOCK_DWARVEN_MINES` | Dwarven Mines | `hypixel_skyblock_dwarven_mines` | +| `SKYBLOCK_THE_PARK` | The Park | `hypixel_skyblock_the_park` | +| `SKYBLOCK_GALATEA` | Galatea | `hypixel_skyblock_galatea` | +| `SKYBLOCK_BACKWATER_BAYOU` | Backwater Bayou | `hypixel_skyblock_galatea` | ### Starting a SkyBlock Server ```bash -java -jar HypixelCore.jar SKYBLOCK_HUB java -jar HypixelCore.jar SKYBLOCK_ISLAND +java -jar HypixelCore.jar SKYBLOCK_HUB java -jar HypixelCore.jar SKYBLOCK_SPIDERS_DEN ``` @@ -30,11 +34,11 @@ java -jar HypixelCore.jar SKYBLOCK_SPIDERS_DEN These server types run independently of SkyBlock features. -| ServerType | Description | -|------------|-------------| -| `PROTOTYPE_LOBBY` | Prototype/testing lobby | -| `BEDWARS_LOBBY` | BedWars lobby server | -| `BEDWARS_GAME` | Active BedWars game server | +| ServerType | Description | +|------------------------|--------------------------------| +| `PROTOTYPE_LOBBY` | Prototype/testing lobby | +| `BEDWARS_LOBBY` | BedWars lobby server | +| `BEDWARS_GAME` | Active BedWars game server | | `BEDWARS_CONFIGURATOR` | BedWars map configuration tool | ### Starting Non-SkyBlock Servers @@ -106,11 +110,11 @@ The proxy will distribute players across all available instances. ### Required Worlds -| World | Location | Used By | -|-------|----------|---------| -| `hypixel_skyblock_hub` | `configuration/skyblock/islands/` | SKYBLOCK_HUB | +| World | Location | Used By | +|------------------------------------|-----------------------------------|-----------------| +| `hypixel_skyblock_hub` | `configuration/skyblock/islands/` | SKYBLOCK_HUB | | `hypixel_skyblock_island_template` | `configuration/skyblock/islands/` | SKYBLOCK_ISLAND | -| `hypixel_prototype_lobby` | `configuration/` | PROTOTYPE_LOBBY | +| `hypixel_prototype_lobby` | `configuration/` | PROTOTYPE_LOBBY | ### Custom Worlds @@ -119,16 +123,16 @@ Other locations require their own world files. These can be created or obtained ## Docker Reference ```yaml -# SkyBlock Hub -hypixelcore_hub: - environment: - SERVICE_CMD: java -jar HypixelCore.jar SKYBLOCK_HUB - # SkyBlock Island hypixelcore_island: environment: SERVICE_CMD: java -jar HypixelCore.jar SKYBLOCK_ISLAND +# SkyBlock Hub +hypixelcore_hub: + environment: + SERVICE_CMD: java -jar HypixelCore.jar SKYBLOCK_HUB + # Spider's Den hypixelcore_spiders: environment: diff --git a/website/docs/reference/services.md b/website/docs/reference/services.md index b51970060..e285d480a 100644 --- a/website/docs/reference/services.md +++ b/website/docs/reference/services.md @@ -1,6 +1,6 @@ # Services Reference -Services are microservices that handle specific features independently from game servers. +Services are microservices that handle specific features independently of game servers. ## Architecture Overview @@ -237,16 +237,16 @@ ServiceInitializer.register( ## Memory Requirements -| Service | Minimum RAM | Recommended RAM | -|---------|-------------|-----------------| -| API | 256 MB | 512 MB | -| Auction House | 256 MB | 512 MB | -| Bazaar | 256 MB | 512 MB | -| Party | 128 MB | 256 MB | -| Item Tracker | 128 MB | 256 MB | -| Data Mutex | 128 MB | 256 MB | -| Dark Auction | 128 MB | 256 MB | -| Orchestrator | 128 MB | 256 MB | +| Service | Minimum RAM | Recommended RAM | +|---------------|-------------|-----------------| +| API | 256 MB | 512 MB | +| Auction House | 256 MB | 512 MB | +| Bazaar | 256 MB | 512 MB | +| Party | 128 MB | 256 MB | +| Item Tracker | 128 MB | 256 MB | +| Data Mutex | 128 MB | 256 MB | +| Dark Auction | 128 MB | 256 MB | +| Orchestrator | 128 MB | 256 MB | ## Docker Reference diff --git a/website/docs/requirements.md b/website/docs/requirements.md index 6a8e62805..b333d497b 100644 --- a/website/docs/requirements.md +++ b/website/docs/requirements.md @@ -40,12 +40,12 @@ This project requires substantial resources to run properly. Make sure your syst The following ports are used by default: -| Port | Service | -|------|---------| +| Port | Service | +|-------|-------------------------------------| | 25565 | Velocity Proxy (player connections) | -| 27017 | MongoDB | -| 6379 | Redis | -| 8080 | API Service | +| 27017 | MongoDB | +| 6379 | Redis | +| 8080 | API Service | :::alert warning Ensure these ports are available and not blocked by your firewall when running locally. diff --git a/website/docs/setup/game-servers.md b/website/docs/setup/game-servers.md index a52739bd7..f6f7dcd17 100644 --- a/website/docs/setup/game-servers.md +++ b/website/docs/setup/game-servers.md @@ -50,11 +50,11 @@ Copy the `forwarding.secret` from your Velocity proxy directory and add it to `r Extract the world files download and place them: -| World | Location | -|-------|----------| -| SkyBlock Hub | `configuration/skyblock/islands/hypixel_skyblock_hub/` | +| World | Location | +|-----------------|--------------------------------------------------------------------| +| SkyBlock Hub | `configuration/skyblock/islands/hypixel_skyblock_hub/` | | Island Template | `configuration/skyblock/islands/hypixel_skyblock_island_template/` | -| Prototype Lobby | `configuration/hypixel_prototype_lobby/` | +| Prototype Lobby | `configuration/hypixel_prototype_lobby/` | ### 4. Install Data Files diff --git a/website/docs/setup/services.md b/website/docs/setup/services.md index 185386efc..c128a80dd 100644 --- a/website/docs/setup/services.md +++ b/website/docs/setup/services.md @@ -4,16 +4,16 @@ Services are independent microservices that handle specific features. They commu ## Overview -| Service | JAR Name | Purpose | -|---------|----------|---------| -| API | `ServiceAPI.jar` | REST API for external access | -| Auction House | `ServiceAuctionHouse.jar` | Manages auction listings | -| Bazaar | `ServiceBazaar.jar` | Market/trading operations | -| Party | `ServiceParty.jar` | Player party management | -| Item Tracker | `ServiceItemTracker.jar` | Tracks items across servers | -| Data Mutex | `ServiceDataMutex.jar` | Distributed data locking | -| Dark Auction | `ServiceDarkAuction.jar` | Dark auction events | -| Orchestrator | `ServiceOrchestrator.jar` | Game server orchestration | +| Service | JAR Name | Purpose | +|---------------|---------------------------|------------------------------| +| API | `ServiceAPI.jar` | REST API for external access | +| Auction House | `ServiceAuctionHouse.jar` | Manages auction listings | +| Bazaar | `ServiceBazaar.jar` | Market/trading operations | +| Party | `ServiceParty.jar` | Player party management | +| Item Tracker | `ServiceItemTracker.jar` | Tracks items across servers | +| Data Mutex | `ServiceDataMutex.jar` | Distributed data locking | +| Dark Auction | `ServiceDarkAuction.jar` | Dark auction events | +| Orchestrator | `ServiceOrchestrator.jar` | Game server orchestration | ## Download