diff --git a/src/app/cli/page.mdx b/src/app/cli/page.mdx index f92e286..bbe153c 100644 --- a/src/app/cli/page.mdx +++ b/src/app/cli/page.mdx @@ -238,8 +238,11 @@ These flags are available for all commands: - `-c, --connection string`: Specify the connection name for the current session. - `-h, --help`: Show help information. -## What's Next? +## What's next? -- [Controller Setup](/controller) -- [Group Configuration](/groups) -- [Server Management](/resources/server) +Here are a few links that might be helpful as you continue to explore SimpleCloud: + +- [Learn about the structure](/structure) +- [Learn about the Controller](/controller) +- [Learn about the Dashboard](/dashboard) +- [Understand the Server Host Droplet](/droplet/serverhost) diff --git a/src/app/contribute/page.mdx b/src/app/contribute/page.mdx new file mode 100644 index 0000000..7b29cfe --- /dev/null +++ b/src/app/contribute/page.mdx @@ -0,0 +1,2 @@ +# Contribute + diff --git a/src/app/controller/page.mdx b/src/app/controller/page.mdx index 74ffb7e..82a28a6 100644 --- a/src/app/controller/page.mdx +++ b/src/app/controller/page.mdx @@ -60,3 +60,12 @@ But like the old v2 Manager, the controller is the heart of SimpleCloud. Without The controller does not start droplets. This is the job of the [CLI](/cli) + +## What's next? + +Here are a few links that might be helpful as you continue to explore SimpleCloud: + +- [Learn about the structure](/structure) +- [Learn about the CLI](/cli) +- [Learn about the Dashboard](/dashboard) +- [Understand the Server Host Droplet](/droplet/serverhost) \ No newline at end of file diff --git a/src/app/dashboard/page.mdx b/src/app/dashboard/page.mdx index 7ad7030..797327a 100644 --- a/src/app/dashboard/page.mdx +++ b/src/app/dashboard/page.mdx @@ -37,3 +37,11 @@ Upcoming Features: Self-hosting won’t be available during the Public Beta, as we want to squash all major bugs first. That way, you won’t have to deal with constant updates right after launch. Don't miss any updates on our [Community Discord](https://discord.simplecloud.com). +## What's next? + +Here are a few links that might be helpful as you continue to explore SimpleCloud: + +- [Learn about the structure](/structure) +- [Learn about the Controller](/controller) +- [Learn about the CLI](/cli) +- [Understand the Server Host Droplet](/droplet/serverhost) \ No newline at end of file diff --git a/src/app/droplet/metrics/page.mdx b/src/app/droplet/metrics/page.mdx new file mode 100644 index 0000000..5189b5b --- /dev/null +++ b/src/app/droplet/metrics/page.mdx @@ -0,0 +1,17 @@ +import {CodeGroup, Note} from "../../../components/mdx"; +export const metadata = { + title: 'Metrics Droplet', + description: + " ", +} + +# Metrics Droplet + +## Understanding the Metrics Droplet + +## Features + +## API Documentation + +For detailed information about using the Metrics Droplet API, including code examples and implementation details, see our [Metrics API documentation](/api/droplet/metrics). + diff --git a/src/app/page.mdx b/src/app/page.mdx index 33f7297..b097219 100644 --- a/src/app/page.mdx +++ b/src/app/page.mdx @@ -36,6 +36,10 @@ Use SimpleCloud to manage and create your own Minecraft server (network) in a li src={"https://github.com/simplecloudapp/branding/blob/main/images/header.png?raw=true"} alt="" className="w-full aspect-video object-cover" + style={{ + borderRadius: '1rem', + border: '1px solid rgba(255, 255, 255, 0.1)', + }} /> ## Key Features diff --git a/src/app/plugin/cloud-command/page.mdx b/src/app/plugin/cloud-command/page.mdx index fcd0f0e..16c3c7d 100644 --- a/src/app/plugin/cloud-command/page.mdx +++ b/src/app/plugin/cloud-command/page.mdx @@ -4,7 +4,7 @@ export const metadata = { description: "Manage your server network with powerful in-game proxy commands" } -# Command Plugin +# Cloud Command Plugin The Cloud Command Plugin empowers your network with in-game proxy commands, enabling efficient cloud management directly from within the game. Easily start, stop, and manage servers using commands. {{ className: 'lead' }} @@ -36,17 +36,21 @@ If you would like to add support for a missing server software, feel free to sub | --------------------------------- | -------------------------------------------------------- | | `/cloud start ` | Starts a server from a specified group | | `/cloud stop ` | Stops a specific server from a specified group | -| `/cloud get servers [group] [id]` | Retrieves one or multiple servers from a specified group | -| `/cloud get groups [group]` | Retrieves one or all groups | +| `/cloud info servers [group] [id]` | Retrieves one or multiple servers from a specified group | +| `/cloud info groups [group]` | Retrieves one or all groups | ## What's Next? - [Server API Documentation](/api#server) - [Proxy Configuration](/proxy) -- [Plugin Development](/plugins) \ No newline at end of file +- [Plugin Development](/plugins) diff --git a/src/app/plugin/npcs/page.mdx b/src/app/plugin/npcs/page.mdx index 6239c60..fab5782 100644 --- a/src/app/plugin/npcs/page.mdx +++ b/src/app/plugin/npcs/page.mdx @@ -1,4 +1,4 @@ -import {Button, DangerNote, Note} from "../../../components/mdx"; +import {Button, CodeGroup, Note} from "../../../components/mdx"; export const metadata = { title: 'NPCs Plugin', @@ -64,22 +64,6 @@ Here you will find all available actions and their options: | `transfer_to_server` | server.ip, server.port | Send a player to an external server with the transfer method | -## Commands -| Command | Description | -|----------------------------------------------------------|-----------------------------------------------------------| -| `/scnpc create ` | Create a NPC with our own NPC implementation | -| `/scnpc interact setAction ` | Set Actions, type can be `right_click` or `left_click` | -| `/scnpc interact setOption ` | Set options, type can be `right_click` or `left_click` | -| `/scnpc interact removeOption ` | Remove options, type can be `right_click` or `left_click` | -| `/scnpc setOption ` | Set global options | -| `/scnpc removeOption ` | Remove global options | -| `/scnpc setHologramGroup ` | Set the Group for the Hologram Placeholders | - -## Permissions -| Permission | Description | -| ------------------------- | -------------------- | -| `simplecloud.command.npc` | For `/scnps` Command | - ## Creating a NPC First, make sure that the NPC plugin is installed on your server, and if you want to use a supported NPC system, ensure that it is also installed on the server. @@ -99,10 +83,10 @@ If you want to use our NPC plugin as a standalone, create an NPC with the follow When you create an NPC using our plugin or another plugin, a separate configuration for each new NPC will be generated in the plugin folder. ```yaml +version: '1.0' id: bedwars holograms: - default: - start-height: 2.073 + - start-height: 2.073 lores: - text: - billboard: CENTER @@ -115,32 +99,21 @@ actions: - player-interaction: LEFT_CLICK action: OPEN_INVENTORY options: - - key: inventory.name - value: quickjoin.bedwars - - key: play.sound - value: block.chest.open - - key: sound.pitch - value: "3" - - key: sound.volume - value: "2" + inventory.name: bedwars + play.sound: block.chest.open + sound.pitch: 3 + sound.volume: 2 - player-interaction: RIGHT_CLICK action: TRANSFER_TO_SERVER options: - - key: server.ip - value: demo-server.com - - key: server.port - value: "25565" - - key: send.actionbar - value: abda + server.ip: demo-server.com + server.port: 25565 + send.actionbar: abda options: - - key: hologram.placeholder.group - value: lobby - - key: send.message - value: Some cool text here - - key: send.title - value: title text - - key: send.subtitle - value: subtitle text + hologram.placeholder.group: lobby + send.message: Some cool text here + send.title: title + send.subtitle: some cool subtitle ``` Configure the NPC either in the NPC configuration file or through commands. The configuration will be automatically reloaded if any changes are made to the file. @@ -156,20 +129,124 @@ Options are sent as feedback when an action is performed. You can set the follow | `send.subtitle` | Sends a subtitle | | `play.sound` | Plays a sound | -// Gif + ### Configure Inventories If you specify the action `OPEN_INVENTORY`, you need to reference an inventory from the plugin folder under `inventories/`. Configure inventories in the configuration file as follows: ```yaml -// Inventory Config +version: '1.0' +id: quickjoin.bedwars +title: <#ffffff>Bedwars +rows: 6 +pagination: + listed-group-name: bedwars + server-name-pattern: - + state-items: + PREPARING: starting_pagination_item + STARTING: starting_pagination_item + AVAILABLE: available_pagination_item + INGAME: ingame_pagination_item + from-slot: + row: 1 + column: 1 + to-slot: + row: 3 + column: 7 + excluded-slots: + - row: 1 + column: 8 + - row: 2 + column: 0 + - row: 2 + column: 8 + - row: 3 + column: 0 + next-page-item: + item: next_pagination_item + slot: + row: 4 + column: 0 + increments: + LEFT: 1 + previous-page-item: + item: previous_pagination_item + slot: + row: 4 + column: 0 + increments: + LEFT: -1 +static-slots: + - item: red_previous_pagination_item + slots: + - row: 5 + column: 0 + - item: red_next_pagination_item + slots: + - row: 5 + column: 8 +items: + - id: next_pagination_item + material: LIME_STAINED_GLASS_PANE + display-name: Next Page + - id: previous_pagination_item + material: LIME_STAINED_GLASS_PANE + display-name: Previous Page + - id: red_next_pagination_item + material: RED_STAINED_GLASS_PANE + display-name: Next Page + - id: red_previous_pagination_item + material: RED_STAINED_GLASS_PANE + display-name: Previous Page + - id: starting_pagination_item + material: ORANGE_BANNER + display-name: + - id: available_pagination_item + material: LIME_BANNER + display-name: + lores: + - "Players: <#38bdf8>/<#38bdf8>" + - "" + - "Version: <#a3a3a3> " + - "Template: <#a3a3a3>" + - id: ingame_pagination_item + material: BROWN_BANNER + display-name: ``` -// Image Inventory + -### Configure Holograms -If you want to create a hologram above the NPC, use our [Placeholders plugin](/plugin/placeholder). +## Commands +| Command | Description | +|----------------------------------------------------------|-----------------------------------------------------------| +| `/scnpc create ` | Create a NPC with our own NPC implementation | +| `/scnpc interact setAction ` | Set Actions, type can be `right_click` or `left_click` | +| `/scnpc interact setOption ` | Set options, type can be `right_click` or `left_click` | +| `/scnpc interact removeOption ` | Remove options, type can be `right_click` or `left_click` | +| `/scnpc setOption ` | Set global options | +| `/scnpc removeOption ` | Remove global options | +| `/scnpc setHologramGroup ` | Set the Group for the Hologram Placeholders | +| `/scnpc createInventory ` | Create a new Inventory Configuration | -// Gif Preview +## Permissions +| Permission | Description | +| ------------------------- | -------------------- | +| `simplecloud.command.npc` | For `/scnps` Command | ## What's Next? diff --git a/src/app/plugin/proxy-essentials/page.mdx b/src/app/plugin/proxy-essentials/page.mdx index e94ba57..97a36dd 100644 --- a/src/app/plugin/proxy-essentials/page.mdx +++ b/src/app/plugin/proxy-essentials/page.mdx @@ -6,9 +6,9 @@ export const metadata = { description: 'Enhance your server network with customizable MOTD and Tablist features' } -# Proxy Plugin +# Proxy Essentials Plugin -The Proxy Plugin enhances your server network with customizable MOTD (Server Info) and Tablist features, offering extensive customization options through simple configuration files. All settings are synchronized across all proxies. {{ className: 'lead' }} +This Plugin enhances your server network with customizable MOTD (Server Info) & Tablist and Joinstates, offering extensive customization options through simple configuration files. All settings are synchronized across all proxies. {{ className: 'lead' }}