Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 54 additions & 33 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,65 @@
# SimpleCloud Docs
# docs.simplecloud.app

## Getting started
![Banner][banner]

To get started with this docs, first install the npm dependencies:
<div align="center">

[![Documentation Status][badge-docs]][docs]
[![License][badge-license]][license]
<br>

```bash
npm install
```
[![Discord][badge-discord]][social-discord]
[![Follow @simplecloudapp][badge-x]][social-x]
[![Follow @simplecloudapp][badge-bluesky]][social-bluesky]
[![Follow @simplecloudapp][badge-youtube]][social-youtube]
<br>

Next, run the development server:
[Report a Bug][issue-bug-report]
·
[Request Documentation][issue-docs-request]
<br>

```bash
npm run dev
```
🌟 Give us a star — your support means the world to us!
</div>
<br>

Finally, open [http://localhost:3000](http://localhost:3000) in your browser to view the website.
Official documentation for SimpleCloud, providing comprehensive guides, tutorials, and API references for managing and creating Minecraft server networks.

## Customizing
## Purpose

You can start editing this template by modifying the files in the `/src` folder. The site will auto-update as you edit these files.
- [x] **Comprehensive Guides**: Detailed documentation for all SimpleCloud components
- [x] **API References**: Complete API documentation for developers
- [x] **Integration Tutorials**: Step-by-step guides for plugins and droplets
- [x] **Best Practices**: Recommended patterns and configurations
- [x] **Troubleshooting**: Common issues and their solutions

## Global search

This template includes a global search that's powered by the [FlexSearch](https://github.com/nextapps-de/flexsearch) library. It's available by clicking the search input or by using the `⌘K` shortcut.

This feature requires no configuration, and works out of the box by automatically scanning your documentation pages to build its index. You can adjust the search parameters by editing the `/src/mdx/search.mjs` file.
## Contributing
Contributions to SimpleCloud are welcome and highly appreciated. However, before you jump right into it, we would like you to read our [Contribution Guide][docs-contribute].

## License

This site template is a commercial product and is licensed under the [Tailwind UI license](https://tailwindui.com/license).

## Learn more

To learn more about the technologies used in this site template, see the following resources:

- [Tailwind CSS](https://tailwindcss.com/docs) - the official Tailwind CSS documentation
- [Next.js](https://nextjs.org/docs) - the official Next.js documentation
- [Headless UI](https://headlessui.dev) - the official Headless UI documentation
- [Framer Motion](https://www.framer.com/docs/) - the official Framer Motion documentation
- [MDX](https://mdxjs.com/) - the official MDX documentation
- [Algolia Autocomplete](https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/what-is-autocomplete/) - the official Algolia Autocomplete documentation
- [FlexSearch](https://github.com/nextapps-de/flexsearch) - the official FlexSearch documentation
- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction) - the official Zustand documentation
This repository is licensed under [Apache 2.0][license].

<!-- LINK GROUP -->
[banner]: https://raw.githubusercontent.com/simplecloudapp/branding/refs/heads/main/readme/banner/docs.png
[docs]: https://docs.simplecloud.app
[issue-bug-report]: https://github.com/theSimpleCloud/docs/issues/new?labels=bug&projects=template=01_BUG-REPORT.yml&title=%5BBUG%5D+%3Ctitle%3E
[issue-docs-request]: https://github.com/theSimpleCloud/docs/discussions/new?category=documentation
[docs-contribute]: https://docs.simplecloud.app/contribute

[modrinth]: https://modrinth.com/organization/simplecloud

<!-- ⛔ DON'T TOUCH -->
[license]: https://opensource.org/licenses/Apache-2.0
[snapshots]: https://repo.simplecloud.app/#/snapshots

[social-x]: https://x.com/simplecloudapp
[social-bluesky]: https://bsky.app/profile/simplecloud.app
[social-youtube]: https://www.youtube.com/@thesimplecloud9075
[social-discord]: https://discord.simplecloud.app

[badge-docs]: https://img.shields.io/website?url=https%3A%2F%2Fdocs.simplecloud.app&style=flat-square&label=Documentation&labelColor=18181b&color=0ea5e9
[badge-license]: https://img.shields.io/badge/apache%202.0-blue.svg?style=flat-square&label=license&labelColor=18181b&style=flat-square&color=e11d48
[badge-discord]: https://img.shields.io/badge/Community_Discord-d95652.svg?style=flat-square&logo=discord&color=27272a
[badge-x]: https://img.shields.io/badge/Follow_@simplecloudapp-d95652.svg?style=flat-square&logo=x&color=27272a
[badge-bluesky]: https://img.shields.io/badge/Follow_@simplecloud.app-d95652.svg?style=flat-square&logo=bluesky&color=27272a
[badge-youtube]: https://img.shields.io/badge/youtube-d95652.svg?style=flat-square&logo=youtube&color=27272a
2 changes: 0 additions & 2 deletions src/app/droplet/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,8 +49,6 @@ Here is a list of our Tech-Stack:
- [Kotlin](https://kotlinlang.org/)
- [ProtoBuf](https://developers.google.com/protocol-buffers)
- [gRPC](https://grpc.io/)
- [RabbitMQ](https://www.rabbitmq.com/)
- [Redis](https://redis.io/)
- [SQLite](https://www.sqlite.org/index.html) or [PostgreSQL](https://www.postgresql.org/)
- [JOOQ](https://www.jooq.org/)

Expand Down
2 changes: 1 addition & 1 deletion src/app/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ Use SimpleCloud to manage and create your own Minecraft server (network) in a li
</Note>

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/header.png?raw=true"}
src={"https://github.com/simplecloudapp/branding/blob/main/images/header.png?raw=true"}
alt=""
className="w-full aspect-video object-cover"
/>
Expand Down
8 changes: 4 additions & 4 deletions src/app/plugin/cloud-command/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -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' }}

Expand DownExpand Up@@ -36,8 +36,8 @@ If you would like to add support for a missing server software, feel free to sub
| --------------------------------- | -------------------------------------------------------- |
| `/cloud start <group>` | Starts a server from a specified group |
| `/cloud stop <group> <id>` | 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 |

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/cloud-command.png?raw=true"}
Expand All@@ -49,4 +49,4 @@ If you would like to add support for a missing server software, feel free to sub

- [Server API Documentation](/api#server)
- [Proxy Configuration](/proxy)
- [Plugin Development](/plugins)
- [Plugin Development](/plugins)
4 changes: 2 additions & 2 deletions src/app/quickstart/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ export const metadata = {

# Quickstart

This guide will help you set up a basic SimpleCloud installation using the CLI, including a proxy and an initial server group functioning as a lobby. We'll cover the [CLI](/cli) and standardized official [Droplets](/droplets). {{ className: 'lead' }}
This guide will help you set up a basic SimpleCloud installation using the CLI, including a proxy and an initial server group functioning as a lobby. We'll cover the [CLI](/cli) and standardized official [Droplets](/droplet). {{ className: 'lead' }}

## System Requirements

Expand DownExpand Up@@ -46,7 +46,7 @@ After installing the [CLI](/cli), the setup process will automatically start. Yo

Select **New Installation** to install the complete bundle. This process includes setting up all core components needed for SimpleCloud.

If you already have a running SimpleCloud instance and want to add another Root Server, consider using the [Server Host Droplet](/droplet/serverhost) or [Server Host Docker Droplet](/droplet/serverhost-docker) if you're using Docker.
If you already have a running SimpleCloud instance and want to add another Root Server, consider using the [Server Host Droplet](/droplet/serverhost).

## Running SimpleCloud

Expand Down
2 changes: 1 addition & 1 deletion src/app/structure/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const metadata = {
SimpleCloud v3 has a new and more customizable structure. We have encapsulated all the core components to make it easier to extend your setup. This means you can easily replace all our [droplets](/droplet) and [plugins](/plugin) with your own implementations. {{ className: 'lead' }}

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/structure.png?raw=true"}
src={"https://github.com/simplecloudapp/branding/blob/main/images/structure.png?raw=true"}
alt=""
className="w-full aspect-video object-cover"
/>
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 54 additions & 33 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,65 @@
# SimpleCloud Docs
# docs.simplecloud.app

## Getting started
![Banner][banner]

To get started with this docs, first install the npm dependencies:
<div align="center">

[![Documentation Status][badge-docs]][docs]
[![License][badge-license]][license]
<br>

```bash
npm install
```
[![Discord][badge-discord]][social-discord]
[![Follow @simplecloudapp][badge-x]][social-x]
[![Follow @simplecloudapp][badge-bluesky]][social-bluesky]
[![Follow @simplecloudapp][badge-youtube]][social-youtube]
<br>

Next, run the development server:
[Report a Bug][issue-bug-report]
·
[Request Documentation][issue-docs-request]
<br>

```bash
npm run dev
```
🌟 Give us a star — your support means the world to us!
</div>
<br>

Finally, open [http://localhost:3000](http://localhost:3000) in your browser to view the website.
Official documentation for SimpleCloud, providing comprehensive guides, tutorials, and API references for managing and creating Minecraft server networks.

## Customizing
## Purpose

You can start editing this template by modifying the files in the `/src` folder. The site will auto-update as you edit these files.
- [x] **Comprehensive Guides**: Detailed documentation for all SimpleCloud components
- [x] **API References**: Complete API documentation for developers
- [x] **Integration Tutorials**: Step-by-step guides for plugins and droplets
- [x] **Best Practices**: Recommended patterns and configurations
- [x] **Troubleshooting**: Common issues and their solutions

## Global search

This template includes a global search that's powered by the [FlexSearch](https://github.com/nextapps-de/flexsearch) library. It's available by clicking the search input or by using the `⌘K` shortcut.

This feature requires no configuration, and works out of the box by automatically scanning your documentation pages to build its index. You can adjust the search parameters by editing the `/src/mdx/search.mjs` file.
## Contributing
Contributions to SimpleCloud are welcome and highly appreciated. However, before you jump right into it, we would like you to read our [Contribution Guide][docs-contribute].

## License

This site template is a commercial product and is licensed under the [Tailwind UI license](https://tailwindui.com/license).

## Learn more

To learn more about the technologies used in this site template, see the following resources:

- [Tailwind CSS](https://tailwindcss.com/docs) - the official Tailwind CSS documentation
- [Next.js](https://nextjs.org/docs) - the official Next.js documentation
- [Headless UI](https://headlessui.dev) - the official Headless UI documentation
- [Framer Motion](https://www.framer.com/docs/) - the official Framer Motion documentation
- [MDX](https://mdxjs.com/) - the official MDX documentation
- [Algolia Autocomplete](https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/what-is-autocomplete/) - the official Algolia Autocomplete documentation
- [FlexSearch](https://github.com/nextapps-de/flexsearch) - the official FlexSearch documentation
- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction) - the official Zustand documentation
This repository is licensed under [Apache 2.0][license].

<!-- LINK GROUP -->
[banner]: https://raw.githubusercontent.com/simplecloudapp/branding/refs/heads/main/readme/banner/docs.png
[docs]: https://docs.simplecloud.app
[issue-bug-report]: https://github.com/theSimpleCloud/docs/issues/new?labels=bug&projects=template=01_BUG-REPORT.yml&title=%5BBUG%5D+%3Ctitle%3E
[issue-docs-request]: https://github.com/theSimpleCloud/docs/discussions/new?category=documentation
[docs-contribute]: https://docs.simplecloud.app/contribute

[modrinth]: https://modrinth.com/organization/simplecloud

<!-- ⛔ DON'T TOUCH -->
[license]: https://opensource.org/licenses/Apache-2.0
[snapshots]: https://repo.simplecloud.app/#/snapshots

[social-x]: https://x.com/simplecloudapp
[social-bluesky]: https://bsky.app/profile/simplecloud.app
[social-youtube]: https://www.youtube.com/@thesimplecloud9075
[social-discord]: https://discord.simplecloud.app

[badge-docs]: https://img.shields.io/website?url=https%3A%2F%2Fdocs.simplecloud.app&style=flat-square&label=Documentation&labelColor=18181b&color=0ea5e9
[badge-license]: https://img.shields.io/badge/apache%202.0-blue.svg?style=flat-square&label=license&labelColor=18181b&style=flat-square&color=e11d48
[badge-discord]: https://img.shields.io/badge/Community_Discord-d95652.svg?style=flat-square&logo=discord&color=27272a
[badge-x]: https://img.shields.io/badge/Follow_@simplecloudapp-d95652.svg?style=flat-square&logo=x&color=27272a
[badge-bluesky]: https://img.shields.io/badge/Follow_@simplecloud.app-d95652.svg?style=flat-square&logo=bluesky&color=27272a
[badge-youtube]: https://img.shields.io/badge/youtube-d95652.svg?style=flat-square&logo=youtube&color=27272a
2 changes: 0 additions & 2 deletions src/app/droplet/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,8 +49,6 @@ Here is a list of our Tech-Stack:
- [Kotlin](https://kotlinlang.org/)
- [ProtoBuf](https://developers.google.com/protocol-buffers)
- [gRPC](https://grpc.io/)
- [RabbitMQ](https://www.rabbitmq.com/)
- [Redis](https://redis.io/)
- [SQLite](https://www.sqlite.org/index.html) or [PostgreSQL](https://www.postgresql.org/)
- [JOOQ](https://www.jooq.org/)

Expand Down
2 changes: 1 addition & 1 deletion src/app/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ Use SimpleCloud to manage and create your own Minecraft server (network) in a li
</Note>

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/header.png?raw=true"}
src={"https://github.com/simplecloudapp/branding/blob/main/images/header.png?raw=true"}
alt=""
className="w-full aspect-video object-cover"
/>
Expand Down
8 changes: 4 additions & 4 deletions src/app/plugin/cloud-command/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -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' }}

Expand DownExpand Up@@ -36,8 +36,8 @@ If you would like to add support for a missing server software, feel free to sub
| --------------------------------- | -------------------------------------------------------- |
| `/cloud start <group>` | Starts a server from a specified group |
| `/cloud stop <group> <id>` | 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 |

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/cloud-command.png?raw=true"}
Expand All@@ -49,4 +49,4 @@ If you would like to add support for a missing server software, feel free to sub

- [Server API Documentation](/api#server)
- [Proxy Configuration](/proxy)
- [Plugin Development](/plugins)
- [Plugin Development](/plugins)
4 changes: 2 additions & 2 deletions src/app/quickstart/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ export const metadata = {

# Quickstart

This guide will help you set up a basic SimpleCloud installation using the CLI, including a proxy and an initial server group functioning as a lobby. We'll cover the [CLI](/cli) and standardized official [Droplets](/droplets). {{ className: 'lead' }}
This guide will help you set up a basic SimpleCloud installation using the CLI, including a proxy and an initial server group functioning as a lobby. We'll cover the [CLI](/cli) and standardized official [Droplets](/droplet). {{ className: 'lead' }}

## System Requirements

Expand DownExpand Up@@ -46,7 +46,7 @@ After installing the [CLI](/cli), the setup process will automatically start. Yo

Select **New Installation** to install the complete bundle. This process includes setting up all core components needed for SimpleCloud.

If you already have a running SimpleCloud instance and want to add another Root Server, consider using the [Server Host Droplet](/droplet/serverhost) or [Server Host Docker Droplet](/droplet/serverhost-docker) if you're using Docker.
If you already have a running SimpleCloud instance and want to add another Root Server, consider using the [Server Host Droplet](/droplet/serverhost).

## Running SimpleCloud

Expand Down
2 changes: 1 addition & 1 deletion src/app/structure/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const metadata = {
SimpleCloud v3 has a new and more customizable structure. We have encapsulated all the core components to make it easier to extend your setup. This means you can easily replace all our [droplets](/droplet) and [plugins](/plugin) with your own implementations. {{ className: 'lead' }}

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/structure.png?raw=true"}
src={"https://github.com/simplecloudapp/branding/blob/main/images/structure.png?raw=true"}
alt=""
className="w-full aspect-video object-cover"
/>
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 54 additions & 33 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,65 @@
# SimpleCloud Docs
# docs.simplecloud.app

## Getting started
![Banner][banner]

To get started with this docs, first install the npm dependencies:
<div align="center">

[![Documentation Status][badge-docs]][docs]
[![License][badge-license]][license]
<br>

```bash
npm install
```
[![Discord][badge-discord]][social-discord]
[![Follow @simplecloudapp][badge-x]][social-x]
[![Follow @simplecloudapp][badge-bluesky]][social-bluesky]
[![Follow @simplecloudapp][badge-youtube]][social-youtube]
<br>

Next, run the development server:
[Report a Bug][issue-bug-report]
·
[Request Documentation][issue-docs-request]
<br>

```bash
npm run dev
```
🌟 Give us a star — your support means the world to us!
</div>
<br>

Finally, open [http://localhost:3000](http://localhost:3000) in your browser to view the website.
Official documentation for SimpleCloud, providing comprehensive guides, tutorials, and API references for managing and creating Minecraft server networks.

## Customizing
## Purpose

You can start editing this template by modifying the files in the `/src` folder. The site will auto-update as you edit these files.
- [x] **Comprehensive Guides**: Detailed documentation for all SimpleCloud components
- [x] **API References**: Complete API documentation for developers
- [x] **Integration Tutorials**: Step-by-step guides for plugins and droplets
- [x] **Best Practices**: Recommended patterns and configurations
- [x] **Troubleshooting**: Common issues and their solutions

## Global search

This template includes a global search that's powered by the [FlexSearch](https://github.com/nextapps-de/flexsearch) library. It's available by clicking the search input or by using the `⌘K` shortcut.

This feature requires no configuration, and works out of the box by automatically scanning your documentation pages to build its index. You can adjust the search parameters by editing the `/src/mdx/search.mjs` file.
## Contributing
Contributions to SimpleCloud are welcome and highly appreciated. However, before you jump right into it, we would like you to read our [Contribution Guide][docs-contribute].

## License

This site template is a commercial product and is licensed under the [Tailwind UI license](https://tailwindui.com/license).

## Learn more

To learn more about the technologies used in this site template, see the following resources:

- [Tailwind CSS](https://tailwindcss.com/docs) - the official Tailwind CSS documentation
- [Next.js](https://nextjs.org/docs) - the official Next.js documentation
- [Headless UI](https://headlessui.dev) - the official Headless UI documentation
- [Framer Motion](https://www.framer.com/docs/) - the official Framer Motion documentation
- [MDX](https://mdxjs.com/) - the official MDX documentation
- [Algolia Autocomplete](https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/what-is-autocomplete/) - the official Algolia Autocomplete documentation
- [FlexSearch](https://github.com/nextapps-de/flexsearch) - the official FlexSearch documentation
- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction) - the official Zustand documentation
This repository is licensed under [Apache 2.0][license].

<!-- LINK GROUP -->
[banner]: https://raw.githubusercontent.com/simplecloudapp/branding/refs/heads/main/readme/banner/docs.png
[docs]: https://docs.simplecloud.app
[issue-bug-report]: https://github.com/theSimpleCloud/docs/issues/new?labels=bug&projects=template=01_BUG-REPORT.yml&title=%5BBUG%5D+%3Ctitle%3E
[issue-docs-request]: https://github.com/theSimpleCloud/docs/discussions/new?category=documentation
[docs-contribute]: https://docs.simplecloud.app/contribute

[modrinth]: https://modrinth.com/organization/simplecloud

<!-- ⛔ DON'T TOUCH -->
[license]: https://opensource.org/licenses/Apache-2.0
[snapshots]: https://repo.simplecloud.app/#/snapshots

[social-x]: https://x.com/simplecloudapp
[social-bluesky]: https://bsky.app/profile/simplecloud.app
[social-youtube]: https://www.youtube.com/@thesimplecloud9075
[social-discord]: https://discord.simplecloud.app

[badge-docs]: https://img.shields.io/website?url=https%3A%2F%2Fdocs.simplecloud.app&style=flat-square&label=Documentation&labelColor=18181b&color=0ea5e9
[badge-license]: https://img.shields.io/badge/apache%202.0-blue.svg?style=flat-square&label=license&labelColor=18181b&style=flat-square&color=e11d48
[badge-discord]: https://img.shields.io/badge/Community_Discord-d95652.svg?style=flat-square&logo=discord&color=27272a
[badge-x]: https://img.shields.io/badge/Follow_@simplecloudapp-d95652.svg?style=flat-square&logo=x&color=27272a
[badge-bluesky]: https://img.shields.io/badge/Follow_@simplecloud.app-d95652.svg?style=flat-square&logo=bluesky&color=27272a
[badge-youtube]: https://img.shields.io/badge/youtube-d95652.svg?style=flat-square&logo=youtube&color=27272a
2 changes: 0 additions & 2 deletions src/app/droplet/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,8 +49,6 @@ Here is a list of our Tech-Stack:
- [Kotlin](https://kotlinlang.org/)
- [ProtoBuf](https://developers.google.com/protocol-buffers)
- [gRPC](https://grpc.io/)
- [RabbitMQ](https://www.rabbitmq.com/)
- [Redis](https://redis.io/)
- [SQLite](https://www.sqlite.org/index.html) or [PostgreSQL](https://www.postgresql.org/)
- [JOOQ](https://www.jooq.org/)

Expand Down
2 changes: 1 addition & 1 deletion src/app/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ Use SimpleCloud to manage and create your own Minecraft server (network) in a li
</Note>

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/header.png?raw=true"}
src={"https://github.com/simplecloudapp/branding/blob/main/images/header.png?raw=true"}
alt=""
className="w-full aspect-video object-cover"
/>
Expand Down
8 changes: 4 additions & 4 deletions src/app/plugin/cloud-command/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -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' }}

Expand DownExpand Up@@ -36,8 +36,8 @@ If you would like to add support for a missing server software, feel free to sub
| --------------------------------- | -------------------------------------------------------- |
| `/cloud start <group>` | Starts a server from a specified group |
| `/cloud stop <group> <id>` | 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 |

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/cloud-command.png?raw=true"}
Expand All@@ -49,4 +49,4 @@ If you would like to add support for a missing server software, feel free to sub

- [Server API Documentation](/api#server)
- [Proxy Configuration](/proxy)
- [Plugin Development](/plugins)
- [Plugin Development](/plugins)
4 changes: 2 additions & 2 deletions src/app/quickstart/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ export const metadata = {

# Quickstart

This guide will help you set up a basic SimpleCloud installation using the CLI, including a proxy and an initial server group functioning as a lobby. We'll cover the [CLI](/cli) and standardized official [Droplets](/droplets). {{ className: 'lead' }}
This guide will help you set up a basic SimpleCloud installation using the CLI, including a proxy and an initial server group functioning as a lobby. We'll cover the [CLI](/cli) and standardized official [Droplets](/droplet). {{ className: 'lead' }}

## System Requirements

Expand DownExpand Up@@ -46,7 +46,7 @@ After installing the [CLI](/cli), the setup process will automatically start. Yo

Select **New Installation** to install the complete bundle. This process includes setting up all core components needed for SimpleCloud.

If you already have a running SimpleCloud instance and want to add another Root Server, consider using the [Server Host Droplet](/droplet/serverhost) or [Server Host Docker Droplet](/droplet/serverhost-docker) if you're using Docker.
If you already have a running SimpleCloud instance and want to add another Root Server, consider using the [Server Host Droplet](/droplet/serverhost).

## Running SimpleCloud

Expand Down
2 changes: 1 addition & 1 deletion src/app/structure/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const metadata = {
SimpleCloud v3 has a new and more customizable structure. We have encapsulated all the core components to make it easier to extend your setup. This means you can easily replace all our [droplets](/droplet) and [plugins](/plugin) with your own implementations. {{ className: 'lead' }}

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/structure.png?raw=true"}
src={"https://github.com/simplecloudapp/branding/blob/main/images/structure.png?raw=true"}
alt=""
className="w-full aspect-video object-cover"
/>
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 54 additions & 33 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,65 @@
# SimpleCloud Docs
# docs.simplecloud.app

## Getting started
![Banner][banner]

To get started with this docs, first install the npm dependencies:
<div align="center">

[![Documentation Status][badge-docs]][docs]
[![License][badge-license]][license]
<br>

```bash
npm install
```
[![Discord][badge-discord]][social-discord]
[![Follow @simplecloudapp][badge-x]][social-x]
[![Follow @simplecloudapp][badge-bluesky]][social-bluesky]
[![Follow @simplecloudapp][badge-youtube]][social-youtube]
<br>

Next, run the development server:
[Report a Bug][issue-bug-report]
·
[Request Documentation][issue-docs-request]
<br>

```bash
npm run dev
```
🌟 Give us a star — your support means the world to us!
</div>
<br>

Finally, open [http://localhost:3000](http://localhost:3000) in your browser to view the website.
Official documentation for SimpleCloud, providing comprehensive guides, tutorials, and API references for managing and creating Minecraft server networks.

## Customizing
## Purpose

You can start editing this template by modifying the files in the `/src` folder. The site will auto-update as you edit these files.
- [x] **Comprehensive Guides**: Detailed documentation for all SimpleCloud components
- [x] **API References**: Complete API documentation for developers
- [x] **Integration Tutorials**: Step-by-step guides for plugins and droplets
- [x] **Best Practices**: Recommended patterns and configurations
- [x] **Troubleshooting**: Common issues and their solutions

## Global search

This template includes a global search that's powered by the [FlexSearch](https://github.com/nextapps-de/flexsearch) library. It's available by clicking the search input or by using the `⌘K` shortcut.

This feature requires no configuration, and works out of the box by automatically scanning your documentation pages to build its index. You can adjust the search parameters by editing the `/src/mdx/search.mjs` file.
## Contributing
Contributions to SimpleCloud are welcome and highly appreciated. However, before you jump right into it, we would like you to read our [Contribution Guide][docs-contribute].

## License

This site template is a commercial product and is licensed under the [Tailwind UI license](https://tailwindui.com/license).

## Learn more

To learn more about the technologies used in this site template, see the following resources:

- [Tailwind CSS](https://tailwindcss.com/docs) - the official Tailwind CSS documentation
- [Next.js](https://nextjs.org/docs) - the official Next.js documentation
- [Headless UI](https://headlessui.dev) - the official Headless UI documentation
- [Framer Motion](https://www.framer.com/docs/) - the official Framer Motion documentation
- [MDX](https://mdxjs.com/) - the official MDX documentation
- [Algolia Autocomplete](https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/what-is-autocomplete/) - the official Algolia Autocomplete documentation
- [FlexSearch](https://github.com/nextapps-de/flexsearch) - the official FlexSearch documentation
- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction) - the official Zustand documentation
This repository is licensed under [Apache 2.0][license].

<!-- LINK GROUP -->
[banner]: https://raw.githubusercontent.com/simplecloudapp/branding/refs/heads/main/readme/banner/docs.png
[docs]: https://docs.simplecloud.app
[issue-bug-report]: https://github.com/theSimpleCloud/docs/issues/new?labels=bug&projects=template=01_BUG-REPORT.yml&title=%5BBUG%5D+%3Ctitle%3E
[issue-docs-request]: https://github.com/theSimpleCloud/docs/discussions/new?category=documentation
[docs-contribute]: https://docs.simplecloud.app/contribute

[modrinth]: https://modrinth.com/organization/simplecloud

<!-- ⛔ DON'T TOUCH -->
[license]: https://opensource.org/licenses/Apache-2.0
[snapshots]: https://repo.simplecloud.app/#/snapshots

[social-x]: https://x.com/simplecloudapp
[social-bluesky]: https://bsky.app/profile/simplecloud.app
[social-youtube]: https://www.youtube.com/@thesimplecloud9075
[social-discord]: https://discord.simplecloud.app

[badge-docs]: https://img.shields.io/website?url=https%3A%2F%2Fdocs.simplecloud.app&style=flat-square&label=Documentation&labelColor=18181b&color=0ea5e9
[badge-license]: https://img.shields.io/badge/apache%202.0-blue.svg?style=flat-square&label=license&labelColor=18181b&style=flat-square&color=e11d48
[badge-discord]: https://img.shields.io/badge/Community_Discord-d95652.svg?style=flat-square&logo=discord&color=27272a
[badge-x]: https://img.shields.io/badge/Follow_@simplecloudapp-d95652.svg?style=flat-square&logo=x&color=27272a
[badge-bluesky]: https://img.shields.io/badge/Follow_@simplecloud.app-d95652.svg?style=flat-square&logo=bluesky&color=27272a
[badge-youtube]: https://img.shields.io/badge/youtube-d95652.svg?style=flat-square&logo=youtube&color=27272a
2 changes: 0 additions & 2 deletions src/app/droplet/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,8 +49,6 @@ Here is a list of our Tech-Stack:
- [Kotlin](https://kotlinlang.org/)
- [ProtoBuf](https://developers.google.com/protocol-buffers)
- [gRPC](https://grpc.io/)
- [RabbitMQ](https://www.rabbitmq.com/)
- [Redis](https://redis.io/)
- [SQLite](https://www.sqlite.org/index.html) or [PostgreSQL](https://www.postgresql.org/)
- [JOOQ](https://www.jooq.org/)

Expand Down
2 changes: 1 addition & 1 deletion src/app/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ Use SimpleCloud to manage and create your own Minecraft server (network) in a li
</Note>

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/header.png?raw=true"}
src={"https://github.com/simplecloudapp/branding/blob/main/images/header.png?raw=true"}
alt=""
className="w-full aspect-video object-cover"
/>
Expand Down
8 changes: 4 additions & 4 deletions src/app/plugin/cloud-command/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -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' }}

Expand DownExpand Up@@ -36,8 +36,8 @@ If you would like to add support for a missing server software, feel free to sub
| --------------------------------- | -------------------------------------------------------- |
| `/cloud start <group>` | Starts a server from a specified group |
| `/cloud stop <group> <id>` | 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 |

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/cloud-command.png?raw=true"}
Expand All@@ -49,4 +49,4 @@ If you would like to add support for a missing server software, feel free to sub

- [Server API Documentation](/api#server)
- [Proxy Configuration](/proxy)
- [Plugin Development](/plugins)
- [Plugin Development](/plugins)
4 changes: 2 additions & 2 deletions src/app/quickstart/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ export const metadata = {

# Quickstart

This guide will help you set up a basic SimpleCloud installation using the CLI, including a proxy and an initial server group functioning as a lobby. We'll cover the [CLI](/cli) and standardized official [Droplets](/droplets). {{ className: 'lead' }}
This guide will help you set up a basic SimpleCloud installation using the CLI, including a proxy and an initial server group functioning as a lobby. We'll cover the [CLI](/cli) and standardized official [Droplets](/droplet). {{ className: 'lead' }}

## System Requirements

Expand DownExpand Up@@ -46,7 +46,7 @@ After installing the [CLI](/cli), the setup process will automatically start. Yo

Select **New Installation** to install the complete bundle. This process includes setting up all core components needed for SimpleCloud.

If you already have a running SimpleCloud instance and want to add another Root Server, consider using the [Server Host Droplet](/droplet/serverhost) or [Server Host Docker Droplet](/droplet/serverhost-docker) if you're using Docker.
If you already have a running SimpleCloud instance and want to add another Root Server, consider using the [Server Host Droplet](/droplet/serverhost).

## Running SimpleCloud

Expand Down
2 changes: 1 addition & 1 deletion src/app/structure/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const metadata = {
SimpleCloud v3 has a new and more customizable structure. We have encapsulated all the core components to make it easier to extend your setup. This means you can easily replace all our [droplets](/droplet) and [plugins](/plugin) with your own implementations. {{ className: 'lead' }}

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/structure.png?raw=true"}
src={"https://github.com/simplecloudapp/branding/blob/main/images/structure.png?raw=true"}
alt=""
className="w-full aspect-video object-cover"
/>
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 54 additions & 33 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,65 @@
# SimpleCloud Docs
# docs.simplecloud.app

## Getting started
![Banner][banner]

To get started with this docs, first install the npm dependencies:
<div align="center">

[![Documentation Status][badge-docs]][docs]
[![License][badge-license]][license]
<br>

```bash
npm install
```
[![Discord][badge-discord]][social-discord]
[![Follow @simplecloudapp][badge-x]][social-x]
[![Follow @simplecloudapp][badge-bluesky]][social-bluesky]
[![Follow @simplecloudapp][badge-youtube]][social-youtube]
<br>

Next, run the development server:
[Report a Bug][issue-bug-report]
·
[Request Documentation][issue-docs-request]
<br>

```bash
npm run dev
```
🌟 Give us a star — your support means the world to us!
</div>
<br>

Finally, open [http://localhost:3000](http://localhost:3000) in your browser to view the website.
Official documentation for SimpleCloud, providing comprehensive guides, tutorials, and API references for managing and creating Minecraft server networks.

## Customizing
## Purpose

You can start editing this template by modifying the files in the `/src` folder. The site will auto-update as you edit these files.
- [x] **Comprehensive Guides**: Detailed documentation for all SimpleCloud components
- [x] **API References**: Complete API documentation for developers
- [x] **Integration Tutorials**: Step-by-step guides for plugins and droplets
- [x] **Best Practices**: Recommended patterns and configurations
- [x] **Troubleshooting**: Common issues and their solutions

## Global search

This template includes a global search that's powered by the [FlexSearch](https://github.com/nextapps-de/flexsearch) library. It's available by clicking the search input or by using the `⌘K` shortcut.

This feature requires no configuration, and works out of the box by automatically scanning your documentation pages to build its index. You can adjust the search parameters by editing the `/src/mdx/search.mjs` file.
## Contributing
Contributions to SimpleCloud are welcome and highly appreciated. However, before you jump right into it, we would like you to read our [Contribution Guide][docs-contribute].

## License

This site template is a commercial product and is licensed under the [Tailwind UI license](https://tailwindui.com/license).

## Learn more

To learn more about the technologies used in this site template, see the following resources:

- [Tailwind CSS](https://tailwindcss.com/docs) - the official Tailwind CSS documentation
- [Next.js](https://nextjs.org/docs) - the official Next.js documentation
- [Headless UI](https://headlessui.dev) - the official Headless UI documentation
- [Framer Motion](https://www.framer.com/docs/) - the official Framer Motion documentation
- [MDX](https://mdxjs.com/) - the official MDX documentation
- [Algolia Autocomplete](https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/what-is-autocomplete/) - the official Algolia Autocomplete documentation
- [FlexSearch](https://github.com/nextapps-de/flexsearch) - the official FlexSearch documentation
- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction) - the official Zustand documentation
This repository is licensed under [Apache 2.0][license].

<!-- LINK GROUP -->
[banner]: https://raw.githubusercontent.com/simplecloudapp/branding/refs/heads/main/readme/banner/docs.png
[docs]: https://docs.simplecloud.app
[issue-bug-report]: https://github.com/theSimpleCloud/docs/issues/new?labels=bug&projects=template=01_BUG-REPORT.yml&title=%5BBUG%5D+%3Ctitle%3E
[issue-docs-request]: https://github.com/theSimpleCloud/docs/discussions/new?category=documentation
[docs-contribute]: https://docs.simplecloud.app/contribute

[modrinth]: https://modrinth.com/organization/simplecloud

<!-- ⛔ DON'T TOUCH -->
[license]: https://opensource.org/licenses/Apache-2.0
[snapshots]: https://repo.simplecloud.app/#/snapshots

[social-x]: https://x.com/simplecloudapp
[social-bluesky]: https://bsky.app/profile/simplecloud.app
[social-youtube]: https://www.youtube.com/@thesimplecloud9075
[social-discord]: https://discord.simplecloud.app

[badge-docs]: https://img.shields.io/website?url=https%3A%2F%2Fdocs.simplecloud.app&style=flat-square&label=Documentation&labelColor=18181b&color=0ea5e9
[badge-license]: https://img.shields.io/badge/apache%202.0-blue.svg?style=flat-square&label=license&labelColor=18181b&style=flat-square&color=e11d48
[badge-discord]: https://img.shields.io/badge/Community_Discord-d95652.svg?style=flat-square&logo=discord&color=27272a
[badge-x]: https://img.shields.io/badge/Follow_@simplecloudapp-d95652.svg?style=flat-square&logo=x&color=27272a
[badge-bluesky]: https://img.shields.io/badge/Follow_@simplecloud.app-d95652.svg?style=flat-square&logo=bluesky&color=27272a
[badge-youtube]: https://img.shields.io/badge/youtube-d95652.svg?style=flat-square&logo=youtube&color=27272a
2 changes: 0 additions & 2 deletions src/app/droplet/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,8 +49,6 @@ Here is a list of our Tech-Stack:
- [Kotlin](https://kotlinlang.org/)
- [ProtoBuf](https://developers.google.com/protocol-buffers)
- [gRPC](https://grpc.io/)
- [RabbitMQ](https://www.rabbitmq.com/)
- [Redis](https://redis.io/)
- [SQLite](https://www.sqlite.org/index.html) or [PostgreSQL](https://www.postgresql.org/)
- [JOOQ](https://www.jooq.org/)

Expand Down
2 changes: 1 addition & 1 deletion src/app/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ Use SimpleCloud to manage and create your own Minecraft server (network) in a li
</Note>

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/header.png?raw=true"}
src={"https://github.com/simplecloudapp/branding/blob/main/images/header.png?raw=true"}
alt=""
className="w-full aspect-video object-cover"
/>
Expand Down
8 changes: 4 additions & 4 deletions src/app/plugin/cloud-command/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -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' }}

Expand DownExpand Up@@ -36,8 +36,8 @@ If you would like to add support for a missing server software, feel free to sub
| --------------------------------- | -------------------------------------------------------- |
| `/cloud start <group>` | Starts a server from a specified group |
| `/cloud stop <group> <id>` | 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 |

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/cloud-command.png?raw=true"}
Expand All@@ -49,4 +49,4 @@ If you would like to add support for a missing server software, feel free to sub

- [Server API Documentation](/api#server)
- [Proxy Configuration](/proxy)
- [Plugin Development](/plugins)
- [Plugin Development](/plugins)
4 changes: 2 additions & 2 deletions src/app/quickstart/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ export const metadata = {

# Quickstart

This guide will help you set up a basic SimpleCloud installation using the CLI, including a proxy and an initial server group functioning as a lobby. We'll cover the [CLI](/cli) and standardized official [Droplets](/droplets). {{ className: 'lead' }}
This guide will help you set up a basic SimpleCloud installation using the CLI, including a proxy and an initial server group functioning as a lobby. We'll cover the [CLI](/cli) and standardized official [Droplets](/droplet). {{ className: 'lead' }}

## System Requirements

Expand DownExpand Up@@ -46,7 +46,7 @@ After installing the [CLI](/cli), the setup process will automatically start. Yo

Select **New Installation** to install the complete bundle. This process includes setting up all core components needed for SimpleCloud.

If you already have a running SimpleCloud instance and want to add another Root Server, consider using the [Server Host Droplet](/droplet/serverhost) or [Server Host Docker Droplet](/droplet/serverhost-docker) if you're using Docker.
If you already have a running SimpleCloud instance and want to add another Root Server, consider using the [Server Host Droplet](/droplet/serverhost).

## Running SimpleCloud

Expand Down
2 changes: 1 addition & 1 deletion src/app/structure/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const metadata = {
SimpleCloud v3 has a new and more customizable structure. We have encapsulated all the core components to make it easier to extend your setup. This means you can easily replace all our [droplets](/droplet) and [plugins](/plugin) with your own implementations. {{ className: 'lead' }}

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/structure.png?raw=true"}
src={"https://github.com/simplecloudapp/branding/blob/main/images/structure.png?raw=true"}
alt=""
className="w-full aspect-video object-cover"
/>
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 54 additions & 33 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,65 @@
# SimpleCloud Docs
# docs.simplecloud.app

## Getting started
![Banner][banner]

To get started with this docs, first install the npm dependencies:
<div align="center">

[![Documentation Status][badge-docs]][docs]
[![License][badge-license]][license]
<br>

```bash
npm install
```
[![Discord][badge-discord]][social-discord]
[![Follow @simplecloudapp][badge-x]][social-x]
[![Follow @simplecloudapp][badge-bluesky]][social-bluesky]
[![Follow @simplecloudapp][badge-youtube]][social-youtube]
<br>

Next, run the development server:
[Report a Bug][issue-bug-report]
·
[Request Documentation][issue-docs-request]
<br>

```bash
npm run dev
```
🌟 Give us a star — your support means the world to us!
</div>
<br>

Finally, open [http://localhost:3000](http://localhost:3000) in your browser to view the website.
Official documentation for SimpleCloud, providing comprehensive guides, tutorials, and API references for managing and creating Minecraft server networks.

## Customizing
## Purpose

You can start editing this template by modifying the files in the `/src` folder. The site will auto-update as you edit these files.
- [x] **Comprehensive Guides**: Detailed documentation for all SimpleCloud components
- [x] **API References**: Complete API documentation for developers
- [x] **Integration Tutorials**: Step-by-step guides for plugins and droplets
- [x] **Best Practices**: Recommended patterns and configurations
- [x] **Troubleshooting**: Common issues and their solutions

## Global search

This template includes a global search that's powered by the [FlexSearch](https://github.com/nextapps-de/flexsearch) library. It's available by clicking the search input or by using the `⌘K` shortcut.

This feature requires no configuration, and works out of the box by automatically scanning your documentation pages to build its index. You can adjust the search parameters by editing the `/src/mdx/search.mjs` file.
## Contributing
Contributions to SimpleCloud are welcome and highly appreciated. However, before you jump right into it, we would like you to read our [Contribution Guide][docs-contribute].

## License

This site template is a commercial product and is licensed under the [Tailwind UI license](https://tailwindui.com/license).

## Learn more

To learn more about the technologies used in this site template, see the following resources:

- [Tailwind CSS](https://tailwindcss.com/docs) - the official Tailwind CSS documentation
- [Next.js](https://nextjs.org/docs) - the official Next.js documentation
- [Headless UI](https://headlessui.dev) - the official Headless UI documentation
- [Framer Motion](https://www.framer.com/docs/) - the official Framer Motion documentation
- [MDX](https://mdxjs.com/) - the official MDX documentation
- [Algolia Autocomplete](https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/what-is-autocomplete/) - the official Algolia Autocomplete documentation
- [FlexSearch](https://github.com/nextapps-de/flexsearch) - the official FlexSearch documentation
- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction) - the official Zustand documentation
This repository is licensed under [Apache 2.0][license].

<!-- LINK GROUP -->
[banner]: https://raw.githubusercontent.com/simplecloudapp/branding/refs/heads/main/readme/banner/docs.png
[docs]: https://docs.simplecloud.app
[issue-bug-report]: https://github.com/theSimpleCloud/docs/issues/new?labels=bug&projects=template=01_BUG-REPORT.yml&title=%5BBUG%5D+%3Ctitle%3E
[issue-docs-request]: https://github.com/theSimpleCloud/docs/discussions/new?category=documentation
[docs-contribute]: https://docs.simplecloud.app/contribute

[modrinth]: https://modrinth.com/organization/simplecloud

<!-- ⛔ DON'T TOUCH -->
[license]: https://opensource.org/licenses/Apache-2.0
[snapshots]: https://repo.simplecloud.app/#/snapshots

[social-x]: https://x.com/simplecloudapp
[social-bluesky]: https://bsky.app/profile/simplecloud.app
[social-youtube]: https://www.youtube.com/@thesimplecloud9075
[social-discord]: https://discord.simplecloud.app

[badge-docs]: https://img.shields.io/website?url=https%3A%2F%2Fdocs.simplecloud.app&style=flat-square&label=Documentation&labelColor=18181b&color=0ea5e9
[badge-license]: https://img.shields.io/badge/apache%202.0-blue.svg?style=flat-square&label=license&labelColor=18181b&style=flat-square&color=e11d48
[badge-discord]: https://img.shields.io/badge/Community_Discord-d95652.svg?style=flat-square&logo=discord&color=27272a
[badge-x]: https://img.shields.io/badge/Follow_@simplecloudapp-d95652.svg?style=flat-square&logo=x&color=27272a
[badge-bluesky]: https://img.shields.io/badge/Follow_@simplecloud.app-d95652.svg?style=flat-square&logo=bluesky&color=27272a
[badge-youtube]: https://img.shields.io/badge/youtube-d95652.svg?style=flat-square&logo=youtube&color=27272a
2 changes: 0 additions & 2 deletions src/app/droplet/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,8 +49,6 @@ Here is a list of our Tech-Stack:
- [Kotlin](https://kotlinlang.org/)
- [ProtoBuf](https://developers.google.com/protocol-buffers)
- [gRPC](https://grpc.io/)
- [RabbitMQ](https://www.rabbitmq.com/)
- [Redis](https://redis.io/)
- [SQLite](https://www.sqlite.org/index.html) or [PostgreSQL](https://www.postgresql.org/)
- [JOOQ](https://www.jooq.org/)

Expand Down
2 changes: 1 addition & 1 deletion src/app/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ Use SimpleCloud to manage and create your own Minecraft server (network) in a li
</Note>

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/header.png?raw=true"}
src={"https://github.com/simplecloudapp/branding/blob/main/images/header.png?raw=true"}
alt=""
className="w-full aspect-video object-cover"
/>
Expand Down
8 changes: 4 additions & 4 deletions src/app/plugin/cloud-command/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -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' }}

Expand DownExpand Up@@ -36,8 +36,8 @@ If you would like to add support for a missing server software, feel free to sub
| --------------------------------- | -------------------------------------------------------- |
| `/cloud start <group>` | Starts a server from a specified group |
| `/cloud stop <group> <id>` | 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 |

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/cloud-command.png?raw=true"}
Expand All@@ -49,4 +49,4 @@ If you would like to add support for a missing server software, feel free to sub

- [Server API Documentation](/api#server)
- [Proxy Configuration](/proxy)
- [Plugin Development](/plugins)
- [Plugin Development](/plugins)
4 changes: 2 additions & 2 deletions src/app/quickstart/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ export const metadata = {

# Quickstart

This guide will help you set up a basic SimpleCloud installation using the CLI, including a proxy and an initial server group functioning as a lobby. We'll cover the [CLI](/cli) and standardized official [Droplets](/droplets). {{ className: 'lead' }}
This guide will help you set up a basic SimpleCloud installation using the CLI, including a proxy and an initial server group functioning as a lobby. We'll cover the [CLI](/cli) and standardized official [Droplets](/droplet). {{ className: 'lead' }}

## System Requirements

Expand DownExpand Up@@ -46,7 +46,7 @@ After installing the [CLI](/cli), the setup process will automatically start. Yo

Select **New Installation** to install the complete bundle. This process includes setting up all core components needed for SimpleCloud.

If you already have a running SimpleCloud instance and want to add another Root Server, consider using the [Server Host Droplet](/droplet/serverhost) or [Server Host Docker Droplet](/droplet/serverhost-docker) if you're using Docker.
If you already have a running SimpleCloud instance and want to add another Root Server, consider using the [Server Host Droplet](/droplet/serverhost).

## Running SimpleCloud

Expand Down
2 changes: 1 addition & 1 deletion src/app/structure/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const metadata = {
SimpleCloud v3 has a new and more customizable structure. We have encapsulated all the core components to make it easier to extend your setup. This means you can easily replace all our [droplets](/droplet) and [plugins](/plugin) with your own implementations. {{ className: 'lead' }}

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/structure.png?raw=true"}
src={"https://github.com/simplecloudapp/branding/blob/main/images/structure.png?raw=true"}
alt=""
className="w-full aspect-video object-cover"
/>
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 54 additions & 33 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,65 @@
# SimpleCloud Docs
# docs.simplecloud.app

## Getting started
![Banner][banner]

To get started with this docs, first install the npm dependencies:
<div align="center">

[![Documentation Status][badge-docs]][docs]
[![License][badge-license]][license]
<br>

```bash
npm install
```
[![Discord][badge-discord]][social-discord]
[![Follow @simplecloudapp][badge-x]][social-x]
[![Follow @simplecloudapp][badge-bluesky]][social-bluesky]
[![Follow @simplecloudapp][badge-youtube]][social-youtube]
<br>

Next, run the development server:
[Report a Bug][issue-bug-report]
·
[Request Documentation][issue-docs-request]
<br>

```bash
npm run dev
```
🌟 Give us a star — your support means the world to us!
</div>
<br>

Finally, open [http://localhost:3000](http://localhost:3000) in your browser to view the website.
Official documentation for SimpleCloud, providing comprehensive guides, tutorials, and API references for managing and creating Minecraft server networks.

## Customizing
## Purpose

You can start editing this template by modifying the files in the `/src` folder. The site will auto-update as you edit these files.
- [x] **Comprehensive Guides**: Detailed documentation for all SimpleCloud components
- [x] **API References**: Complete API documentation for developers
- [x] **Integration Tutorials**: Step-by-step guides for plugins and droplets
- [x] **Best Practices**: Recommended patterns and configurations
- [x] **Troubleshooting**: Common issues and their solutions

## Global search

This template includes a global search that's powered by the [FlexSearch](https://github.com/nextapps-de/flexsearch) library. It's available by clicking the search input or by using the `⌘K` shortcut.

This feature requires no configuration, and works out of the box by automatically scanning your documentation pages to build its index. You can adjust the search parameters by editing the `/src/mdx/search.mjs` file.
## Contributing
Contributions to SimpleCloud are welcome and highly appreciated. However, before you jump right into it, we would like you to read our [Contribution Guide][docs-contribute].

## License

This site template is a commercial product and is licensed under the [Tailwind UI license](https://tailwindui.com/license).

## Learn more

To learn more about the technologies used in this site template, see the following resources:

- [Tailwind CSS](https://tailwindcss.com/docs) - the official Tailwind CSS documentation
- [Next.js](https://nextjs.org/docs) - the official Next.js documentation
- [Headless UI](https://headlessui.dev) - the official Headless UI documentation
- [Framer Motion](https://www.framer.com/docs/) - the official Framer Motion documentation
- [MDX](https://mdxjs.com/) - the official MDX documentation
- [Algolia Autocomplete](https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/what-is-autocomplete/) - the official Algolia Autocomplete documentation
- [FlexSearch](https://github.com/nextapps-de/flexsearch) - the official FlexSearch documentation
- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction) - the official Zustand documentation
This repository is licensed under [Apache 2.0][license].

<!-- LINK GROUP -->
[banner]: https://raw.githubusercontent.com/simplecloudapp/branding/refs/heads/main/readme/banner/docs.png
[docs]: https://docs.simplecloud.app
[issue-bug-report]: https://github.com/theSimpleCloud/docs/issues/new?labels=bug&projects=template=01_BUG-REPORT.yml&title=%5BBUG%5D+%3Ctitle%3E
[issue-docs-request]: https://github.com/theSimpleCloud/docs/discussions/new?category=documentation
[docs-contribute]: https://docs.simplecloud.app/contribute

[modrinth]: https://modrinth.com/organization/simplecloud

<!-- ⛔ DON'T TOUCH -->
[license]: https://opensource.org/licenses/Apache-2.0
[snapshots]: https://repo.simplecloud.app/#/snapshots

[social-x]: https://x.com/simplecloudapp
[social-bluesky]: https://bsky.app/profile/simplecloud.app
[social-youtube]: https://www.youtube.com/@thesimplecloud9075
[social-discord]: https://discord.simplecloud.app

[badge-docs]: https://img.shields.io/website?url=https%3A%2F%2Fdocs.simplecloud.app&style=flat-square&label=Documentation&labelColor=18181b&color=0ea5e9
[badge-license]: https://img.shields.io/badge/apache%202.0-blue.svg?style=flat-square&label=license&labelColor=18181b&style=flat-square&color=e11d48
[badge-discord]: https://img.shields.io/badge/Community_Discord-d95652.svg?style=flat-square&logo=discord&color=27272a
[badge-x]: https://img.shields.io/badge/Follow_@simplecloudapp-d95652.svg?style=flat-square&logo=x&color=27272a
[badge-bluesky]: https://img.shields.io/badge/Follow_@simplecloud.app-d95652.svg?style=flat-square&logo=bluesky&color=27272a
[badge-youtube]: https://img.shields.io/badge/youtube-d95652.svg?style=flat-square&logo=youtube&color=27272a
2 changes: 0 additions & 2 deletions src/app/droplet/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,8 +49,6 @@ Here is a list of our Tech-Stack:
- [Kotlin](https://kotlinlang.org/)
- [ProtoBuf](https://developers.google.com/protocol-buffers)
- [gRPC](https://grpc.io/)
- [RabbitMQ](https://www.rabbitmq.com/)
- [Redis](https://redis.io/)
- [SQLite](https://www.sqlite.org/index.html) or [PostgreSQL](https://www.postgresql.org/)
- [JOOQ](https://www.jooq.org/)

Expand Down
2 changes: 1 addition & 1 deletion src/app/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ Use SimpleCloud to manage and create your own Minecraft server (network) in a li
</Note>

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/header.png?raw=true"}
src={"https://github.com/simplecloudapp/branding/blob/main/images/header.png?raw=true"}
alt=""
className="w-full aspect-video object-cover"
/>
Expand Down
8 changes: 4 additions & 4 deletions src/app/plugin/cloud-command/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -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' }}

Expand DownExpand Up@@ -36,8 +36,8 @@ If you would like to add support for a missing server software, feel free to sub
| --------------------------------- | -------------------------------------------------------- |
| `/cloud start <group>` | Starts a server from a specified group |
| `/cloud stop <group> <id>` | 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 |

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/cloud-command.png?raw=true"}
Expand All@@ -49,4 +49,4 @@ If you would like to add support for a missing server software, feel free to sub

- [Server API Documentation](/api#server)
- [Proxy Configuration](/proxy)
- [Plugin Development](/plugins)
- [Plugin Development](/plugins)
4 changes: 2 additions & 2 deletions src/app/quickstart/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ export const metadata = {

# Quickstart

This guide will help you set up a basic SimpleCloud installation using the CLI, including a proxy and an initial server group functioning as a lobby. We'll cover the [CLI](/cli) and standardized official [Droplets](/droplets). {{ className: 'lead' }}
This guide will help you set up a basic SimpleCloud installation using the CLI, including a proxy and an initial server group functioning as a lobby. We'll cover the [CLI](/cli) and standardized official [Droplets](/droplet). {{ className: 'lead' }}

## System Requirements

Expand DownExpand Up@@ -46,7 +46,7 @@ After installing the [CLI](/cli), the setup process will automatically start. Yo

Select **New Installation** to install the complete bundle. This process includes setting up all core components needed for SimpleCloud.

If you already have a running SimpleCloud instance and want to add another Root Server, consider using the [Server Host Droplet](/droplet/serverhost) or [Server Host Docker Droplet](/droplet/serverhost-docker) if you're using Docker.
If you already have a running SimpleCloud instance and want to add another Root Server, consider using the [Server Host Droplet](/droplet/serverhost).

## Running SimpleCloud

Expand Down
2 changes: 1 addition & 1 deletion src/app/structure/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const metadata = {
SimpleCloud v3 has a new and more customizable structure. We have encapsulated all the core components to make it easier to extend your setup. This means you can easily replace all our [droplets](/droplet) and [plugins](/plugin) with your own implementations. {{ className: 'lead' }}

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/structure.png?raw=true"}
src={"https://github.com/simplecloudapp/branding/blob/main/images/structure.png?raw=true"}
alt=""
className="w-full aspect-video object-cover"
/>
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 54 additions & 33 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,65 @@
# SimpleCloud Docs
# docs.simplecloud.app

## Getting started
![Banner][banner]

To get started with this docs, first install the npm dependencies:
<div align="center">

[![Documentation Status][badge-docs]][docs]
[![License][badge-license]][license]
<br>

```bash
npm install
```
[![Discord][badge-discord]][social-discord]
[![Follow @simplecloudapp][badge-x]][social-x]
[![Follow @simplecloudapp][badge-bluesky]][social-bluesky]
[![Follow @simplecloudapp][badge-youtube]][social-youtube]
<br>

Next, run the development server:
[Report a Bug][issue-bug-report]
·
[Request Documentation][issue-docs-request]
<br>

```bash
npm run dev
```
🌟 Give us a star — your support means the world to us!
</div>
<br>

Finally, open [http://localhost:3000](http://localhost:3000) in your browser to view the website.
Official documentation for SimpleCloud, providing comprehensive guides, tutorials, and API references for managing and creating Minecraft server networks.

## Customizing
## Purpose

You can start editing this template by modifying the files in the `/src` folder. The site will auto-update as you edit these files.
- [x] **Comprehensive Guides**: Detailed documentation for all SimpleCloud components
- [x] **API References**: Complete API documentation for developers
- [x] **Integration Tutorials**: Step-by-step guides for plugins and droplets
- [x] **Best Practices**: Recommended patterns and configurations
- [x] **Troubleshooting**: Common issues and their solutions

## Global search

This template includes a global search that's powered by the [FlexSearch](https://github.com/nextapps-de/flexsearch) library. It's available by clicking the search input or by using the `⌘K` shortcut.

This feature requires no configuration, and works out of the box by automatically scanning your documentation pages to build its index. You can adjust the search parameters by editing the `/src/mdx/search.mjs` file.
## Contributing
Contributions to SimpleCloud are welcome and highly appreciated. However, before you jump right into it, we would like you to read our [Contribution Guide][docs-contribute].

## License

This site template is a commercial product and is licensed under the [Tailwind UI license](https://tailwindui.com/license).

## Learn more

To learn more about the technologies used in this site template, see the following resources:

- [Tailwind CSS](https://tailwindcss.com/docs) - the official Tailwind CSS documentation
- [Next.js](https://nextjs.org/docs) - the official Next.js documentation
- [Headless UI](https://headlessui.dev) - the official Headless UI documentation
- [Framer Motion](https://www.framer.com/docs/) - the official Framer Motion documentation
- [MDX](https://mdxjs.com/) - the official MDX documentation
- [Algolia Autocomplete](https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/what-is-autocomplete/) - the official Algolia Autocomplete documentation
- [FlexSearch](https://github.com/nextapps-de/flexsearch) - the official FlexSearch documentation
- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction) - the official Zustand documentation
This repository is licensed under [Apache 2.0][license].

<!-- LINK GROUP -->
[banner]: https://raw.githubusercontent.com/simplecloudapp/branding/refs/heads/main/readme/banner/docs.png
[docs]: https://docs.simplecloud.app
[issue-bug-report]: https://github.com/theSimpleCloud/docs/issues/new?labels=bug&projects=template=01_BUG-REPORT.yml&title=%5BBUG%5D+%3Ctitle%3E
[issue-docs-request]: https://github.com/theSimpleCloud/docs/discussions/new?category=documentation
[docs-contribute]: https://docs.simplecloud.app/contribute

[modrinth]: https://modrinth.com/organization/simplecloud

<!-- ⛔ DON'T TOUCH -->
[license]: https://opensource.org/licenses/Apache-2.0
[snapshots]: https://repo.simplecloud.app/#/snapshots

[social-x]: https://x.com/simplecloudapp
[social-bluesky]: https://bsky.app/profile/simplecloud.app
[social-youtube]: https://www.youtube.com/@thesimplecloud9075
[social-discord]: https://discord.simplecloud.app

[badge-docs]: https://img.shields.io/website?url=https%3A%2F%2Fdocs.simplecloud.app&style=flat-square&label=Documentation&labelColor=18181b&color=0ea5e9
[badge-license]: https://img.shields.io/badge/apache%202.0-blue.svg?style=flat-square&label=license&labelColor=18181b&style=flat-square&color=e11d48
[badge-discord]: https://img.shields.io/badge/Community_Discord-d95652.svg?style=flat-square&logo=discord&color=27272a
[badge-x]: https://img.shields.io/badge/Follow_@simplecloudapp-d95652.svg?style=flat-square&logo=x&color=27272a
[badge-bluesky]: https://img.shields.io/badge/Follow_@simplecloud.app-d95652.svg?style=flat-square&logo=bluesky&color=27272a
[badge-youtube]: https://img.shields.io/badge/youtube-d95652.svg?style=flat-square&logo=youtube&color=27272a
2 changes: 0 additions & 2 deletions src/app/droplet/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,8 +49,6 @@ Here is a list of our Tech-Stack:
- [Kotlin](https://kotlinlang.org/)
- [ProtoBuf](https://developers.google.com/protocol-buffers)
- [gRPC](https://grpc.io/)
- [RabbitMQ](https://www.rabbitmq.com/)
- [Redis](https://redis.io/)
- [SQLite](https://www.sqlite.org/index.html) or [PostgreSQL](https://www.postgresql.org/)
- [JOOQ](https://www.jooq.org/)

Expand Down
2 changes: 1 addition & 1 deletion src/app/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ Use SimpleCloud to manage and create your own Minecraft server (network) in a li
</Note>

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/header.png?raw=true"}
src={"https://github.com/simplecloudapp/branding/blob/main/images/header.png?raw=true"}
alt=""
className="w-full aspect-video object-cover"
/>
Expand Down
8 changes: 4 additions & 4 deletions src/app/plugin/cloud-command/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -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' }}

Expand DownExpand Up@@ -36,8 +36,8 @@ If you would like to add support for a missing server software, feel free to sub
| --------------------------------- | -------------------------------------------------------- |
| `/cloud start <group>` | Starts a server from a specified group |
| `/cloud stop <group> <id>` | 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 |

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/cloud-command.png?raw=true"}
Expand All@@ -49,4 +49,4 @@ If you would like to add support for a missing server software, feel free to sub

- [Server API Documentation](/api#server)
- [Proxy Configuration](/proxy)
- [Plugin Development](/plugins)
- [Plugin Development](/plugins)
4 changes: 2 additions & 2 deletions src/app/quickstart/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ export const metadata = {

# Quickstart

This guide will help you set up a basic SimpleCloud installation using the CLI, including a proxy and an initial server group functioning as a lobby. We'll cover the [CLI](/cli) and standardized official [Droplets](/droplets). {{ className: 'lead' }}
This guide will help you set up a basic SimpleCloud installation using the CLI, including a proxy and an initial server group functioning as a lobby. We'll cover the [CLI](/cli) and standardized official [Droplets](/droplet). {{ className: 'lead' }}

## System Requirements

Expand DownExpand Up@@ -46,7 +46,7 @@ After installing the [CLI](/cli), the setup process will automatically start. Yo

Select **New Installation** to install the complete bundle. This process includes setting up all core components needed for SimpleCloud.

If you already have a running SimpleCloud instance and want to add another Root Server, consider using the [Server Host Droplet](/droplet/serverhost) or [Server Host Docker Droplet](/droplet/serverhost-docker) if you're using Docker.
If you already have a running SimpleCloud instance and want to add another Root Server, consider using the [Server Host Droplet](/droplet/serverhost).

## Running SimpleCloud

Expand Down
2 changes: 1 addition & 1 deletion src/app/structure/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const metadata = {
SimpleCloud v3 has a new and more customizable structure. We have encapsulated all the core components to make it easier to extend your setup. This means you can easily replace all our [droplets](/droplet) and [plugins](/plugin) with your own implementations. {{ className: 'lead' }}

<img
src={"https://github.com/simplecloudapp/branding/blob/main/docs/images/structure.png?raw=true"}
src={"https://github.com/simplecloudapp/branding/blob/main/images/structure.png?raw=true"}
alt=""
className="w-full aspect-video object-cover"
/>
Expand Down