diff --git a/src/content/docs/guides/creating-a-game.md b/src/content/docs/guides/creating-a-game.md index 6b250f2..13e566c 100644 --- a/src/content/docs/guides/creating-a-game.md +++ b/src/content/docs/guides/creating-a-game.md @@ -1,3 +1,9 @@ --- title: Creating a New Game --- + +:::caution[Under Construction] +This page is under construction and may not be complete yet. +If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues) +or contact us on [Discord](https://bluedragonmc.com/discord). +::: diff --git a/src/content/docs/guides/dev-env.md b/src/content/docs/guides/dev-env.md index 7f6da45..ad67712 100644 --- a/src/content/docs/guides/dev-env.md +++ b/src/content/docs/guides/dev-env.md @@ -3,8 +3,8 @@ title: Development Environment Setup description: How to work on BlueDragon in development mode --- -## Limitations - -Working in development mode means that you cannot use or test any features that rely on messaging, like parties and matchmaking. - -## Setup +:::caution[Under Construction] +This page is under construction and may not be complete yet. +If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues) +or contact us on [Discord](https://bluedragonmc.com/discord). +::: diff --git a/src/content/docs/guides/production-env.md b/src/content/docs/guides/production-env.md deleted file mode 100644 index 1ee8a67..0000000 --- a/src/content/docs/guides/production-env.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Production Environment Setup ---- diff --git a/src/content/docs/modules/AnvilFileMapProviderModule.md b/src/content/docs/modules/AnvilFileMapProviderModule.md index d3a15db..446cbc8 100644 --- a/src/content/docs/modules/AnvilFileMapProviderModule.md +++ b/src/content/docs/modules/AnvilFileMapProviderModule.md @@ -1,3 +1,9 @@ --- title: AnvilFileMapProviderModule ---- \ No newline at end of file +--- + +:::caution[Under Construction] +This page is under construction and may not be complete yet. +If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues) +or contact us on [Discord](https://bluedragonmc.com/discord). +::: diff --git a/src/content/docs/modules/CombatZonesModule.md b/src/content/docs/modules/CombatZonesModule.md index fbcf1c1..a650bc8 100644 --- a/src/content/docs/modules/CombatZonesModule.md +++ b/src/content/docs/modules/CombatZonesModule.md @@ -1,3 +1,9 @@ --- title: CombatZonesModule ---- \ No newline at end of file +--- + +:::caution[Under Construction] +This page is under construction and may not be complete yet. +If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues) +or contact us on [Discord](https://bluedragonmc.com/discord). +::: diff --git a/src/content/docs/modules/CosmeticsModule.md b/src/content/docs/modules/CosmeticsModule.md index e18d13c..e67fa3e 100644 --- a/src/content/docs/modules/CosmeticsModule.md +++ b/src/content/docs/modules/CosmeticsModule.md @@ -1,3 +1,9 @@ --- title: CosmeticsModule ---- \ No newline at end of file +--- + +:::caution[Under Construction] +This page is under construction and may not be complete yet. +If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues) +or contact us on [Discord](https://bluedragonmc.com/discord). +::: diff --git a/src/content/docs/modules/CutsceneModule.md b/src/content/docs/modules/CutsceneModule.md index 8fb13b3..9677364 100644 --- a/src/content/docs/modules/CutsceneModule.md +++ b/src/content/docs/modules/CutsceneModule.md @@ -1,5 +1,9 @@ --- title: CutsceneModule --- -`CutsceneModule` allows cutscenes to be defined and played. A *cutscene* is a set of points that, when played, will smoothly animate the player's position between them. -> ⚠️ This module is **experimental**, and its behavior is likely to change over time. + +`CutsceneModule` allows cutscenes to be defined and played. A _cutscene_ is a set of points that, when played, will smoothly animate the player's position between them. + +:::caution[Experimental] +This module is **experimental**, and its behavior is likely to change over time. +::: diff --git a/src/content/docs/modules/DoubleJumpModule.md b/src/content/docs/modules/DoubleJumpModule.md index fca0fb7..2cd5f31 100644 --- a/src/content/docs/modules/DoubleJumpModule.md +++ b/src/content/docs/modules/DoubleJumpModule.md @@ -1,3 +1,9 @@ --- title: DoubleJumpModule ---- \ No newline at end of file +--- + +:::caution[Under Construction] +This page is under construction and may not be complete yet. +If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues) +or contact us on [Discord](https://bluedragonmc.com/discord). +::: diff --git a/src/content/docs/modules/FireworkRocketModule.md b/src/content/docs/modules/FireworkRocketModule.md index 168805c..b0083ff 100644 --- a/src/content/docs/modules/FireworkRocketModule.md +++ b/src/content/docs/modules/FireworkRocketModule.md @@ -1,3 +1,9 @@ --- title: FireworkRocketModule ---- \ No newline at end of file +--- + +:::caution[Under Construction] +This page is under construction and may not be complete yet. +If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues) +or contact us on [Discord](https://bluedragonmc.com/discord). +::: diff --git a/src/content/docs/modules/GlobalCosmeticModule.md b/src/content/docs/modules/GlobalCosmeticModule.md index 8d4c35a..dcdd29b 100644 --- a/src/content/docs/modules/GlobalCosmeticModule.md +++ b/src/content/docs/modules/GlobalCosmeticModule.md @@ -1,3 +1,9 @@ --- title: GlobalCosmeticModule ---- \ No newline at end of file +--- + +:::caution[Under Construction] +This page is under construction and may not be complete yet. +If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues) +or contact us on [Discord](https://bluedragonmc.com/discord). +::: diff --git a/src/content/docs/modules/GuiModule.md b/src/content/docs/modules/GuiModule.md index c356ff3..18757a7 100644 --- a/src/content/docs/modules/GuiModule.md +++ b/src/content/docs/modules/GuiModule.md @@ -1,3 +1,9 @@ --- title: GuiModule ---- \ No newline at end of file +--- + +:::caution[Under Construction] +This page is under construction and may not be complete yet. +If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues) +or contact us on [Discord](https://bluedragonmc.com/discord). +::: diff --git a/src/content/docs/modules/InstanceTimeModule.md b/src/content/docs/modules/InstanceTimeModule.md index 62f18a9..29cdeea 100644 --- a/src/content/docs/modules/InstanceTimeModule.md +++ b/src/content/docs/modules/InstanceTimeModule.md @@ -1,3 +1,9 @@ --- title: InstanceTimeModule ---- \ No newline at end of file +--- + +:::caution[Under Construction] +This page is under construction and may not be complete yet. +If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues) +or contact us on [Discord](https://bluedragonmc.com/discord). +::: diff --git a/src/content/docs/modules/InstantRespawnModule.md b/src/content/docs/modules/InstantRespawnModule.md index 761f434..9f5a0b0 100644 --- a/src/content/docs/modules/InstantRespawnModule.md +++ b/src/content/docs/modules/InstantRespawnModule.md @@ -1,3 +1,9 @@ --- title: InstantRespawnModule ---- \ No newline at end of file +--- + +:::caution[Under Construction] +This page is under construction and may not be complete yet. +If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues) +or contact us on [Discord](https://bluedragonmc.com/discord). +::: diff --git a/src/content/docs/modules/InventoryPermissionsModule.md b/src/content/docs/modules/InventoryPermissionsModule.md index 61e77a9..9a20a59 100644 --- a/src/content/docs/modules/InventoryPermissionsModule.md +++ b/src/content/docs/modules/InventoryPermissionsModule.md @@ -1,3 +1,9 @@ --- title: InventoryPermissionsModule ---- \ No newline at end of file +--- + +:::caution[Under Construction] +This page is under construction and may not be complete yet. +If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues) +or contact us on [Discord](https://bluedragonmc.com/discord). +::: diff --git a/src/content/docs/modules/KitsModule.md b/src/content/docs/modules/KitsModule.md index 23339a3..de5da74 100644 --- a/src/content/docs/modules/KitsModule.md +++ b/src/content/docs/modules/KitsModule.md @@ -1,3 +1,9 @@ --- title: KitsModule ---- \ No newline at end of file +--- + +:::caution[Under Construction] +This page is under construction and may not be complete yet. +If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues) +or contact us on [Discord](https://bluedragonmc.com/discord). +::: diff --git a/src/content/docs/modules/MapZonesModule.md b/src/content/docs/modules/MapZonesModule.md index 2fca807..134eb75 100644 --- a/src/content/docs/modules/MapZonesModule.md +++ b/src/content/docs/modules/MapZonesModule.md @@ -1,3 +1,9 @@ --- title: MapZonesModule ---- \ No newline at end of file +--- + +:::caution[Under Construction] +This page is under construction and may not be complete yet. +If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues) +or contact us on [Discord](https://bluedragonmc.com/discord). +::: diff --git a/src/content/docs/modules/NPCModule.md b/src/content/docs/modules/NPCModule.md index 49e1a3d..5f47a0f 100644 --- a/src/content/docs/modules/NPCModule.md +++ b/src/content/docs/modules/NPCModule.md @@ -1,3 +1,9 @@ --- title: NPCModule ---- \ No newline at end of file +--- + +:::caution[Under Construction] +This page is under construction and may not be complete yet. +If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues) +or contact us on [Discord](https://bluedragonmc.com/discord). +::: diff --git a/src/content/docs/modules/ShopModule.md b/src/content/docs/modules/ShopModule.md index ac4444f..d7cfd4e 100644 --- a/src/content/docs/modules/ShopModule.md +++ b/src/content/docs/modules/ShopModule.md @@ -1,3 +1,9 @@ --- title: ShopModule ---- \ No newline at end of file +--- + +:::caution[Under Construction] +This page is under construction and may not be complete yet. +If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues) +or contact us on [Discord](https://bluedragonmc.com/discord). +::: diff --git a/src/content/docs/modules/SidebarModule.md b/src/content/docs/modules/SidebarModule.md index 96dd058..a999654 100644 --- a/src/content/docs/modules/SidebarModule.md +++ b/src/content/docs/modules/SidebarModule.md @@ -1,3 +1,9 @@ --- title: SidebarModule ---- \ No newline at end of file +--- + +:::caution[Under Construction] +This page is under construction and may not be complete yet. +If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues) +or contact us on [Discord](https://bluedragonmc.com/discord). +::: diff --git a/src/content/docs/modules/StatisticsModule.md b/src/content/docs/modules/StatisticsModule.md index 1d09760..9a8fb91 100644 --- a/src/content/docs/modules/StatisticsModule.md +++ b/src/content/docs/modules/StatisticsModule.md @@ -1,3 +1,9 @@ --- title: StatisticsModule ---- \ No newline at end of file +--- + +:::caution[Under Construction] +This page is under construction and may not be complete yet. +If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues) +or contact us on [Discord](https://bluedragonmc.com/discord). +::: diff --git a/src/content/docs/modules/TeamModule.md b/src/content/docs/modules/TeamModule.md index 0ec8f83..6ff55d0 100644 --- a/src/content/docs/modules/TeamModule.md +++ b/src/content/docs/modules/TeamModule.md @@ -1,3 +1,9 @@ --- title: TeamModule ---- \ No newline at end of file +--- + +:::caution[Under Construction] +This page is under construction and may not be complete yet. +If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues) +or contact us on [Discord](https://bluedragonmc.com/discord). +::: diff --git a/src/content/docs/modules/TimedRespawnModule.md b/src/content/docs/modules/TimedRespawnModule.md index 542308e..3f70625 100644 --- a/src/content/docs/modules/TimedRespawnModule.md +++ b/src/content/docs/modules/TimedRespawnModule.md @@ -1,3 +1,9 @@ --- title: TimedRespawnModule ---- \ No newline at end of file +--- + +:::caution[Under Construction] +This page is under construction and may not be complete yet. +If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues) +or contact us on [Discord](https://bluedragonmc.com/discord). +::: diff --git a/src/content/docs/reference/environment.md b/src/content/docs/reference/environment.md index 59a4761..805949b 100644 --- a/src/content/docs/reference/environment.md +++ b/src/content/docs/reference/environment.md @@ -13,11 +13,11 @@ If the `BLUEDRAGON_ENV_TYPE` is not set, the fallback is to check for a director ## Environment Variable Reference | Environment variable | Defaults | Description | -| ------------------------------------ | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | --------------------------------- | +| ------------------------------------ | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | | `BLUEDRAGON_QUEUE_TYPE` | **Dev**: `TEST`
**Prod**: `IPC` | Use "IPC" to connect to Puffin for queueing, or "TEST" for a fully-local/single-instance queue | | `BLUEDRAGON_MONGO_CONNECTION_STRING` | **Dev**: `mongodb://localhost:27017`
**Prod**: `mongodb://mongo:27017` | The hostname that resolves to a MongoDB instance | | `BLUEDRAGON_PUFFIN_HOSTNAME` | **Dev**: `localhost`
**Prod**: `puffin` | The hostname that resolves to a Puffin instance | -| `BLUEDRAGON_PUFFIN_PORT` | 50051 | 50051 | The port of Puffin's gRPC server. | +| `BLUEDRAGON_PUFFIN_PORT` | 50051 | The port of Puffin's gRPC server. | | `BLUEDRAGON_LUCKPERMS_HOSTNAME` | **Dev**: `http://localhost:8080`
**Prod**: `http://luckperms:8080` | The hostname that resolves to a [standalone LuckPerms](https://luckperms.net/) instance | | `BLUEDRAGON_DEFAULT_GAME` | `lobby` | The game to automatically create on startup. Typically used to immediately initialize a lobby on each game server. | | `BLUEDRAGON_AGONES_DISABLED` | _Not set_ | If this environment variable is present with any value, Agones integration will be disabled. | diff --git a/src/content/docs/reference/lobby.md b/src/content/docs/reference/lobby.md index ccd1aef..e7424db 100644 --- a/src/content/docs/reference/lobby.md +++ b/src/content/docs/reference/lobby.md @@ -1,3 +1,9 @@ --- title: Lobby System ---- \ No newline at end of file +--- + +:::caution[Under Construction] +This page is under construction and may not be complete yet. +If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues) +or contact us on [Discord](https://bluedragonmc.com/discord). +::: diff --git a/src/content/docs/reference/queue.md b/src/content/docs/reference/queue.md index 9d065c6..a249939 100644 --- a/src/content/docs/reference/queue.md +++ b/src/content/docs/reference/queue.md @@ -1,3 +1,9 @@ --- title: Queue System ---- \ No newline at end of file +--- + +:::caution[Under Construction] +This page is under construction and may not be complete yet. +If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues) +or contact us on [Discord](https://bluedragonmc.com/discord). +::: diff --git a/src/content/docs/reference/worlds-folder.md b/src/content/docs/reference/worlds-folder.md index 8f6de06..504f9aa 100644 --- a/src/content/docs/reference/worlds-folder.md +++ b/src/content/docs/reference/worlds-folder.md @@ -2,3 +2,9 @@ title: Worlds Folder description: The file structure and required files in the server's worlds directory. --- + +:::caution[Under Construction] +This page is under construction and may not be complete yet. +If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues) +or contact us on [Discord](https://bluedragonmc.com/discord). +:::