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
25 changes: 25 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
"@next/mdx": "^14.0.4",
"@sindresorhus/slugify": "^2.1.1",
"@tailwindcss/typography": "^0.5.10",
"@tanstack/react-query": "^5.63.0",
"@types/mdx": "^2.0.8",
"@types/node": "^20.10.8",
"@types/react": "^18.2.47",
Expand Down
47 changes: 6 additions & 41 deletions src/app/api/controller/page.mdx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {CodeGroup, Note} from "../../../components/mdx";
import {DependencySnippet} from "../../../components/DependencySnippet";

export const metadata = {
title: 'Controller API',
Expand DownExpand Up@@ -34,47 +35,11 @@ The Controller API is the central interface for managing your SimpleCloud infras

## Installation

<CodeGroup>

```kotlin {{ title: 'Kotlin' }}
repositories {
maven("https://repo.simplecloud.app/snapshots/")
}

dependencies {
api("app.simplecloud.controller:controller-api:0.0.30-dev.e3e27fc")
}
```

```groovy {{ title: 'Groovy' }}
repositories {
maven {
url "https://repo.simplecloud.app/snapshots/"
}
}

dependencies {
api 'app.simplecloud.controller:controller-api:0.0.30-dev.e3e27fc'
}
```

```xml {{ title: 'Maven' }}
<repositories>
<repository>
<id>simplecloud-snapshots</id>
<url>https://repo.simplecloud.app/snapshots/</url>
</repository>
</repositories>

<dependency>
<groupId>app.simplecloud.controller</groupId>
<artifactId>controller-api</artifactId>
<version>0.0.30-dev.e3e27fc</version>
<scope>compile</scope>
</dependency>
```

</CodeGroup>
<DependencySnippet
groupId="app.simplecloud.controller"
artifactId="controller-api"
type="snapshot"
/>

<Note>
As soon as we release our first stable version, we'll publish the Maven package to Maven Central. Until then, you can use the snapshots repository to access the latest features.
Expand Down
46 changes: 7 additions & 39 deletions src/app/api/droplet/player/page.mdx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {CodeGroup, Note} from "../../../../components/mdx";
import {CodeGroup} from "../../../../components/mdx";
import {DependencySnippet} from "../../../../components/DependencySnippet";

export const metadata = {
title: 'Player Droplet API',
Expand All@@ -22,44 +23,11 @@ The Player Droplet API provides comprehensive player management and interaction

## Installation

<CodeGroup>
```kotlin {{ title: 'Kotlin' }}
repositories {
maven("https://repo.simplecloud.app/snapshots/")
}

dependencies {
api("app.simplecloud.droplet:player-api:0.0.0")
}
```

```groovy {{ title: 'Groovy' }}
repositories {
maven {
url "https://repo.simplecloud.app/snapshots/"
}
}

dependencies {
api 'app.simplecloud.droplet:player-api:0.0.0'
}
```

```xml {{ title: 'Maven' }}
<repositories>
<repository>
<id>simplecloud-snapshots</id>
<url>https://repo.simplecloud.app/snapshots/</url>
</repository>
</repositories>

<dependency>
<groupId>app.simplecloud.droplet</groupId>
<artifactId>player-api</artifactId>
<version>0.0.0</version>
</dependency>
```
</CodeGroup>
<DependencySnippet
groupId="app.simplecloud.droplet.player"
artifactId="player-api"
type="snapshot"
/>

Authentication
If you're using our Player Droplet API in a Minecraft server, the token is automatically provided via environment variables. For external applications, you'll need to use the master authentication token.
Expand Down
64 changes: 31 additions & 33 deletions src/app/plugin/npcs/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@ export const metadata = {

# NPCs Plugin
Create NPCs on your server that allow your players to access other subservers through the NPCs.
Perform various [actions](#understanding-actions) such as sending messages, titles, action bars, or sounds, or customize inventories with your items.
Perform various [actions](#understanding-actions) such as sending messages, titles, action bars, or sounds, or customize inventories with your items.
Use your [favourite NPC system](#usage-of-other-npc-plugins) or use the plugin as a standalone with its own NPC integration.
The all new NPC plugin opens up limitless creative possibilities.

Expand DownExpand Up@@ -38,11 +38,12 @@ No problem! Thanks to the new structure, you can also use other NPC plugins such
This allows you to use all the features of your NPC plugin together with the functions of SimpleCloud.
The following NPC plugins are supported:

| Plugin | Supported Versions | This Plugin |
|---------------------------------------------------------------------------------------|-------------------------|-------------|
| [Citizens](https://citizensnpcs.co) | 1.19 - latest version | Yes |
| [FancyNpcs](https://fancyplugins.de/FancyNpcs) | 1.19.4 - latest version | Yes |
| [PlayerNPC](https://www.spigotmc.org/resources/✅-api-player-npc-✅-1-17-1-20-1.93625/) | 1.17.1 - 1.20.1 | Yes |
| Plugin | Supported Versions | This Plugin |
|-------------------------------------------------------------------------------------------------------------|-------------------------|-------------|
| [FancyNpcs](https://fancyplugins.de/FancyNpcs) | 1.19.4 - latest version | Yes |
| [Citizens](https://citizensnpcs.co) | 1.19 - latest version | Yes |
| [MythicMobs](https://www.spigotmc.org/resources/⚔-mythicmobs-free-version-►the-1-custom-mob-creator◄.5702/) | 1.19 - latest version | Yes |
| [PlayerNPC](https://www.spigotmc.org/resources/✅-api-player-npc-✅-1-17-1-20-1.93625/) | 1.17.1 - 1.20.1 | Yes |

If you would like to add support for a missing npc plugin, feel free to submit a issue on [GitHub](https://github.com/simplecloudapp/npc-plugin/pulls).

Expand All@@ -68,16 +69,13 @@ Here you will find all available actions and their options:

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.

The first step is to create an NPC. If you're using a supported NPC system, refer to the documentation of the respective plugins.
- [Create a NPC using Citizens](https://wiki.citizensnpcs.co/Commands)
The first step is to create an NPC. If you're using a supported NPC system, refer to the documentation of the respective plugins.
- [Create a NPC using FancyNpcs](https://fancyplugins.de/docs/fn-getting-started.html#create-your-first-npc)
- [Create a NPC using Citizens](https://wiki.citizensnpcs.co/Commands)
- [Create a NPC using MythicMobs](https://git.mythiccraft.io/mythiccraft/MythicMobs#getting-started)
- [Create a NPC using PlayerNPC](https://www.spigotmc.org/resources/%E2%9C%85-api-player-npc-%E2%9C%85-1-17-1-20-1.93625/)

If you want to use our NPC plugin as a standalone, create an NPC with the following command:
```bash
/scnpc create <name>
```

If you have created an NPC with one of the supported plugins, you only need to execute the command `/scnpc apply <id>` to use the functions of SimpleCloud.

### NPC Configuration
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.
Expand DownExpand Up@@ -115,7 +113,7 @@ options:
send.title: title
send.subtitle: some cool subtitle
```
Configure the NPC either in the NPC configuration file or through commands.
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.
If you want to configure the NPC using commands, use either `/scnpc <id> interact <type> setAction <action>` or `/scnpc <id> interact <type> setOption <key> <value>`.

Expand All@@ -134,8 +132,8 @@ Options are sent as feedback when an action is performed. You can set the follow
alt=""
className="w-full"
style={{
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
}}
/>

Expand DownExpand Up@@ -226,15 +224,15 @@ items:
alt=""
className="w-full"
style={{
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
}}
/>

## Commands
| Command | Description |
|----------------------------------------------------------|-----------------------------------------------------------|
| `/scnpc apply <name>` | Create a NPC with our own NPC implementation |
| `/scnpc apply <name>` | Adds the support of simplecloud functions |
| `/scnpc <id> interact <type> setAction <action>` | Set Actions, type can be `right_click` or `left_click` |
| `/scnpc <id> interact <type> setOption <key> <value>` | Set options, type can be `right_click` or `left_click` |
| `/scnpc <id> interact <type> removeOption <key> <value>` | Remove options, type can be `right_click` or `left_click` |
Expand All@@ -253,20 +251,20 @@ You can use the parameters of the current server and the group to which the serv

### Hologram Placeholders

| Placeholder | Description |
|------------------------|-----------------------------------------------------|
| `<group_name>` | Name of the group |
| `<type>` | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| `<start_port>` | Start port of the Group |
| `<min_memory>` | Minimum RAM allocation in MB |
| `<max_memory>` | Maximum RAM allocation in MB |
| `<max_players>` | Maximum players per server |
| `<online_players>` | Current players count |
| `<min_online_count>` | Minimum online server count |
| `<max_online_count>` | Maximum online server count |
| `<property:NAME>` | Shows the property value |
| `<player_count:STATE>` | Shows the amount of player count by an Server state |
| `<server_count:STATE>` | Shows the amount of server count by an Server state |
| Placeholder | Description |
|------------------------------|-----------------------------------------------------|
| `<group_name>` | Name of the group |
| `<group_type>` | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| `<group_start_port>` | Start port of the Group |
| `<group_min_memory>` | Minimum RAM allocation in MB |
| `<group_max_memory>` | Maximum RAM allocation in MB |
| `<group_max_players>` | Maximum players per server |
| `<group_online_count>` | Current players count |
| `<group_min_online_count>` | Minimum online server count |
| `<group_max_online_count>` | Maximum online server count |
| `<group_property:NAME>` | Shows the property value |
| `<group_player_count:STATE>` | Shows the amount of player count by an Server state |
| `<group_server_count:STATE>` | Shows the amount of server count by an Server state |

### Inventory Placeholders

Expand Down
17 changes: 11 additions & 6 deletions src/app/providers.tsx
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
'use client'

import { useEffect } from 'react'
import { ThemeProvider, useTheme } from 'next-themes'
import {useEffect} from 'react'
import {ThemeProvider, useTheme} from 'next-themes'
import {QueryClient, QueryClientProvider} from "@tanstack/react-query";

function ThemeWatcher() {
let { resolvedTheme, setTheme } = useTheme()
Expand All@@ -27,11 +28,15 @@ function ThemeWatcher() {
return null
}

const queryClient = new QueryClient();

export function Providers({ children }: { children: React.ReactNode }) {
return (
<ThemeProvider attribute="class" disableTransitionOnChange>
<ThemeWatcher />
{children}
</ThemeProvider>
<QueryClientProvider client={queryClient}>
<ThemeProvider attribute="class" disableTransitionOnChange>
<ThemeWatcher />
{children}
</ThemeProvider>
</QueryClientProvider>
)
}
Loading
, '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
25 changes: 25 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
"@next/mdx": "^14.0.4",
"@sindresorhus/slugify": "^2.1.1",
"@tailwindcss/typography": "^0.5.10",
"@tanstack/react-query": "^5.63.0",
"@types/mdx": "^2.0.8",
"@types/node": "^20.10.8",
"@types/react": "^18.2.47",
Expand Down
47 changes: 6 additions & 41 deletions src/app/api/controller/page.mdx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {CodeGroup, Note} from "../../../components/mdx";
import {DependencySnippet} from "../../../components/DependencySnippet";

export const metadata = {
title: 'Controller API',
Expand DownExpand Up@@ -34,47 +35,11 @@ The Controller API is the central interface for managing your SimpleCloud infras

## Installation

<CodeGroup>

```kotlin {{ title: 'Kotlin' }}
repositories {
maven("https://repo.simplecloud.app/snapshots/")
}

dependencies {
api("app.simplecloud.controller:controller-api:0.0.30-dev.e3e27fc")
}
```

```groovy {{ title: 'Groovy' }}
repositories {
maven {
url "https://repo.simplecloud.app/snapshots/"
}
}

dependencies {
api 'app.simplecloud.controller:controller-api:0.0.30-dev.e3e27fc'
}
```

```xml {{ title: 'Maven' }}
<repositories>
<repository>
<id>simplecloud-snapshots</id>
<url>https://repo.simplecloud.app/snapshots/</url>
</repository>
</repositories>

<dependency>
<groupId>app.simplecloud.controller</groupId>
<artifactId>controller-api</artifactId>
<version>0.0.30-dev.e3e27fc</version>
<scope>compile</scope>
</dependency>
```

</CodeGroup>
<DependencySnippet
groupId="app.simplecloud.controller"
artifactId="controller-api"
type="snapshot"
/>

<Note>
As soon as we release our first stable version, we'll publish the Maven package to Maven Central. Until then, you can use the snapshots repository to access the latest features.
Expand Down
46 changes: 7 additions & 39 deletions src/app/api/droplet/player/page.mdx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {CodeGroup, Note} from "../../../../components/mdx";
import {CodeGroup} from "../../../../components/mdx";
import {DependencySnippet} from "../../../../components/DependencySnippet";

export const metadata = {
title: 'Player Droplet API',
Expand All@@ -22,44 +23,11 @@ The Player Droplet API provides comprehensive player management and interaction

## Installation

<CodeGroup>
```kotlin {{ title: 'Kotlin' }}
repositories {
maven("https://repo.simplecloud.app/snapshots/")
}

dependencies {
api("app.simplecloud.droplet:player-api:0.0.0")
}
```

```groovy {{ title: 'Groovy' }}
repositories {
maven {
url "https://repo.simplecloud.app/snapshots/"
}
}

dependencies {
api 'app.simplecloud.droplet:player-api:0.0.0'
}
```

```xml {{ title: 'Maven' }}
<repositories>
<repository>
<id>simplecloud-snapshots</id>
<url>https://repo.simplecloud.app/snapshots/</url>
</repository>
</repositories>

<dependency>
<groupId>app.simplecloud.droplet</groupId>
<artifactId>player-api</artifactId>
<version>0.0.0</version>
</dependency>
```
</CodeGroup>
<DependencySnippet
groupId="app.simplecloud.droplet.player"
artifactId="player-api"
type="snapshot"
/>

Authentication
If you're using our Player Droplet API in a Minecraft server, the token is automatically provided via environment variables. For external applications, you'll need to use the master authentication token.
Expand Down
64 changes: 31 additions & 33 deletions src/app/plugin/npcs/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@ export const metadata = {

# NPCs Plugin
Create NPCs on your server that allow your players to access other subservers through the NPCs.
Perform various [actions](#understanding-actions) such as sending messages, titles, action bars, or sounds, or customize inventories with your items.
Perform various [actions](#understanding-actions) such as sending messages, titles, action bars, or sounds, or customize inventories with your items.
Use your [favourite NPC system](#usage-of-other-npc-plugins) or use the plugin as a standalone with its own NPC integration.
The all new NPC plugin opens up limitless creative possibilities.

Expand DownExpand Up@@ -38,11 +38,12 @@ No problem! Thanks to the new structure, you can also use other NPC plugins such
This allows you to use all the features of your NPC plugin together with the functions of SimpleCloud.
The following NPC plugins are supported:

| Plugin | Supported Versions | This Plugin |
|---------------------------------------------------------------------------------------|-------------------------|-------------|
| [Citizens](https://citizensnpcs.co) | 1.19 - latest version | Yes |
| [FancyNpcs](https://fancyplugins.de/FancyNpcs) | 1.19.4 - latest version | Yes |
| [PlayerNPC](https://www.spigotmc.org/resources/✅-api-player-npc-✅-1-17-1-20-1.93625/) | 1.17.1 - 1.20.1 | Yes |
| Plugin | Supported Versions | This Plugin |
|-------------------------------------------------------------------------------------------------------------|-------------------------|-------------|
| [FancyNpcs](https://fancyplugins.de/FancyNpcs) | 1.19.4 - latest version | Yes |
| [Citizens](https://citizensnpcs.co) | 1.19 - latest version | Yes |
| [MythicMobs](https://www.spigotmc.org/resources/⚔-mythicmobs-free-version-►the-1-custom-mob-creator◄.5702/) | 1.19 - latest version | Yes |
| [PlayerNPC](https://www.spigotmc.org/resources/✅-api-player-npc-✅-1-17-1-20-1.93625/) | 1.17.1 - 1.20.1 | Yes |

If you would like to add support for a missing npc plugin, feel free to submit a issue on [GitHub](https://github.com/simplecloudapp/npc-plugin/pulls).

Expand All@@ -68,16 +69,13 @@ Here you will find all available actions and their options:

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.

The first step is to create an NPC. If you're using a supported NPC system, refer to the documentation of the respective plugins.
- [Create a NPC using Citizens](https://wiki.citizensnpcs.co/Commands)
The first step is to create an NPC. If you're using a supported NPC system, refer to the documentation of the respective plugins.
- [Create a NPC using FancyNpcs](https://fancyplugins.de/docs/fn-getting-started.html#create-your-first-npc)
- [Create a NPC using Citizens](https://wiki.citizensnpcs.co/Commands)
- [Create a NPC using MythicMobs](https://git.mythiccraft.io/mythiccraft/MythicMobs#getting-started)
- [Create a NPC using PlayerNPC](https://www.spigotmc.org/resources/%E2%9C%85-api-player-npc-%E2%9C%85-1-17-1-20-1.93625/)

If you want to use our NPC plugin as a standalone, create an NPC with the following command:
```bash
/scnpc create <name>
```

If you have created an NPC with one of the supported plugins, you only need to execute the command `/scnpc apply <id>` to use the functions of SimpleCloud.

### NPC Configuration
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.
Expand DownExpand Up@@ -115,7 +113,7 @@ options:
send.title: title
send.subtitle: some cool subtitle
```
Configure the NPC either in the NPC configuration file or through commands.
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.
If you want to configure the NPC using commands, use either `/scnpc <id> interact <type> setAction <action>` or `/scnpc <id> interact <type> setOption <key> <value>`.

Expand All@@ -134,8 +132,8 @@ Options are sent as feedback when an action is performed. You can set the follow
alt=""
className="w-full"
style={{
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
}}
/>

Expand DownExpand Up@@ -226,15 +224,15 @@ items:
alt=""
className="w-full"
style={{
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
}}
/>

## Commands
| Command | Description |
|----------------------------------------------------------|-----------------------------------------------------------|
| `/scnpc apply <name>` | Create a NPC with our own NPC implementation |
| `/scnpc apply <name>` | Adds the support of simplecloud functions |
| `/scnpc <id> interact <type> setAction <action>` | Set Actions, type can be `right_click` or `left_click` |
| `/scnpc <id> interact <type> setOption <key> <value>` | Set options, type can be `right_click` or `left_click` |
| `/scnpc <id> interact <type> removeOption <key> <value>` | Remove options, type can be `right_click` or `left_click` |
Expand All@@ -253,20 +251,20 @@ You can use the parameters of the current server and the group to which the serv

### Hologram Placeholders

| Placeholder | Description |
|------------------------|-----------------------------------------------------|
| `<group_name>` | Name of the group |
| `<type>` | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| `<start_port>` | Start port of the Group |
| `<min_memory>` | Minimum RAM allocation in MB |
| `<max_memory>` | Maximum RAM allocation in MB |
| `<max_players>` | Maximum players per server |
| `<online_players>` | Current players count |
| `<min_online_count>` | Minimum online server count |
| `<max_online_count>` | Maximum online server count |
| `<property:NAME>` | Shows the property value |
| `<player_count:STATE>` | Shows the amount of player count by an Server state |
| `<server_count:STATE>` | Shows the amount of server count by an Server state |
| Placeholder | Description |
|------------------------------|-----------------------------------------------------|
| `<group_name>` | Name of the group |
| `<group_type>` | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| `<group_start_port>` | Start port of the Group |
| `<group_min_memory>` | Minimum RAM allocation in MB |
| `<group_max_memory>` | Maximum RAM allocation in MB |
| `<group_max_players>` | Maximum players per server |
| `<group_online_count>` | Current players count |
| `<group_min_online_count>` | Minimum online server count |
| `<group_max_online_count>` | Maximum online server count |
| `<group_property:NAME>` | Shows the property value |
| `<group_player_count:STATE>` | Shows the amount of player count by an Server state |
| `<group_server_count:STATE>` | Shows the amount of server count by an Server state |

### Inventory Placeholders

Expand Down
17 changes: 11 additions & 6 deletions src/app/providers.tsx
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
'use client'

import { useEffect } from 'react'
import { ThemeProvider, useTheme } from 'next-themes'
import {useEffect} from 'react'
import {ThemeProvider, useTheme} from 'next-themes'
import {QueryClient, QueryClientProvider} from "@tanstack/react-query";

function ThemeWatcher() {
let { resolvedTheme, setTheme } = useTheme()
Expand All@@ -27,11 +28,15 @@ function ThemeWatcher() {
return null
}

const queryClient = new QueryClient();

export function Providers({ children }: { children: React.ReactNode }) {
return (
<ThemeProvider attribute="class" disableTransitionOnChange>
<ThemeWatcher />
{children}
</ThemeProvider>
<QueryClientProvider client={queryClient}>
<ThemeProvider attribute="class" disableTransitionOnChange>
<ThemeWatcher />
{children}
</ThemeProvider>
</QueryClientProvider>
)
}
Loading
, '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
25 changes: 25 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
"@next/mdx": "^14.0.4",
"@sindresorhus/slugify": "^2.1.1",
"@tailwindcss/typography": "^0.5.10",
"@tanstack/react-query": "^5.63.0",
"@types/mdx": "^2.0.8",
"@types/node": "^20.10.8",
"@types/react": "^18.2.47",
Expand Down
47 changes: 6 additions & 41 deletions src/app/api/controller/page.mdx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {CodeGroup, Note} from "../../../components/mdx";
import {DependencySnippet} from "../../../components/DependencySnippet";

export const metadata = {
title: 'Controller API',
Expand DownExpand Up@@ -34,47 +35,11 @@ The Controller API is the central interface for managing your SimpleCloud infras

## Installation

<CodeGroup>

```kotlin {{ title: 'Kotlin' }}
repositories {
maven("https://repo.simplecloud.app/snapshots/")
}

dependencies {
api("app.simplecloud.controller:controller-api:0.0.30-dev.e3e27fc")
}
```

```groovy {{ title: 'Groovy' }}
repositories {
maven {
url "https://repo.simplecloud.app/snapshots/"
}
}

dependencies {
api 'app.simplecloud.controller:controller-api:0.0.30-dev.e3e27fc'
}
```

```xml {{ title: 'Maven' }}
<repositories>
<repository>
<id>simplecloud-snapshots</id>
<url>https://repo.simplecloud.app/snapshots/</url>
</repository>
</repositories>

<dependency>
<groupId>app.simplecloud.controller</groupId>
<artifactId>controller-api</artifactId>
<version>0.0.30-dev.e3e27fc</version>
<scope>compile</scope>
</dependency>
```

</CodeGroup>
<DependencySnippet
groupId="app.simplecloud.controller"
artifactId="controller-api"
type="snapshot"
/>

<Note>
As soon as we release our first stable version, we'll publish the Maven package to Maven Central. Until then, you can use the snapshots repository to access the latest features.
Expand Down
46 changes: 7 additions & 39 deletions src/app/api/droplet/player/page.mdx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {CodeGroup, Note} from "../../../../components/mdx";
import {CodeGroup} from "../../../../components/mdx";
import {DependencySnippet} from "../../../../components/DependencySnippet";

export const metadata = {
title: 'Player Droplet API',
Expand All@@ -22,44 +23,11 @@ The Player Droplet API provides comprehensive player management and interaction

## Installation

<CodeGroup>
```kotlin {{ title: 'Kotlin' }}
repositories {
maven("https://repo.simplecloud.app/snapshots/")
}

dependencies {
api("app.simplecloud.droplet:player-api:0.0.0")
}
```

```groovy {{ title: 'Groovy' }}
repositories {
maven {
url "https://repo.simplecloud.app/snapshots/"
}
}

dependencies {
api 'app.simplecloud.droplet:player-api:0.0.0'
}
```

```xml {{ title: 'Maven' }}
<repositories>
<repository>
<id>simplecloud-snapshots</id>
<url>https://repo.simplecloud.app/snapshots/</url>
</repository>
</repositories>

<dependency>
<groupId>app.simplecloud.droplet</groupId>
<artifactId>player-api</artifactId>
<version>0.0.0</version>
</dependency>
```
</CodeGroup>
<DependencySnippet
groupId="app.simplecloud.droplet.player"
artifactId="player-api"
type="snapshot"
/>

Authentication
If you're using our Player Droplet API in a Minecraft server, the token is automatically provided via environment variables. For external applications, you'll need to use the master authentication token.
Expand Down
64 changes: 31 additions & 33 deletions src/app/plugin/npcs/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@ export const metadata = {

# NPCs Plugin
Create NPCs on your server that allow your players to access other subservers through the NPCs.
Perform various [actions](#understanding-actions) such as sending messages, titles, action bars, or sounds, or customize inventories with your items.
Perform various [actions](#understanding-actions) such as sending messages, titles, action bars, or sounds, or customize inventories with your items.
Use your [favourite NPC system](#usage-of-other-npc-plugins) or use the plugin as a standalone with its own NPC integration.
The all new NPC plugin opens up limitless creative possibilities.

Expand DownExpand Up@@ -38,11 +38,12 @@ No problem! Thanks to the new structure, you can also use other NPC plugins such
This allows you to use all the features of your NPC plugin together with the functions of SimpleCloud.
The following NPC plugins are supported:

| Plugin | Supported Versions | This Plugin |
|---------------------------------------------------------------------------------------|-------------------------|-------------|
| [Citizens](https://citizensnpcs.co) | 1.19 - latest version | Yes |
| [FancyNpcs](https://fancyplugins.de/FancyNpcs) | 1.19.4 - latest version | Yes |
| [PlayerNPC](https://www.spigotmc.org/resources/✅-api-player-npc-✅-1-17-1-20-1.93625/) | 1.17.1 - 1.20.1 | Yes |
| Plugin | Supported Versions | This Plugin |
|-------------------------------------------------------------------------------------------------------------|-------------------------|-------------|
| [FancyNpcs](https://fancyplugins.de/FancyNpcs) | 1.19.4 - latest version | Yes |
| [Citizens](https://citizensnpcs.co) | 1.19 - latest version | Yes |
| [MythicMobs](https://www.spigotmc.org/resources/⚔-mythicmobs-free-version-►the-1-custom-mob-creator◄.5702/) | 1.19 - latest version | Yes |
| [PlayerNPC](https://www.spigotmc.org/resources/✅-api-player-npc-✅-1-17-1-20-1.93625/) | 1.17.1 - 1.20.1 | Yes |

If you would like to add support for a missing npc plugin, feel free to submit a issue on [GitHub](https://github.com/simplecloudapp/npc-plugin/pulls).

Expand All@@ -68,16 +69,13 @@ Here you will find all available actions and their options:

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.

The first step is to create an NPC. If you're using a supported NPC system, refer to the documentation of the respective plugins.
- [Create a NPC using Citizens](https://wiki.citizensnpcs.co/Commands)
The first step is to create an NPC. If you're using a supported NPC system, refer to the documentation of the respective plugins.
- [Create a NPC using FancyNpcs](https://fancyplugins.de/docs/fn-getting-started.html#create-your-first-npc)
- [Create a NPC using Citizens](https://wiki.citizensnpcs.co/Commands)
- [Create a NPC using MythicMobs](https://git.mythiccraft.io/mythiccraft/MythicMobs#getting-started)
- [Create a NPC using PlayerNPC](https://www.spigotmc.org/resources/%E2%9C%85-api-player-npc-%E2%9C%85-1-17-1-20-1.93625/)

If you want to use our NPC plugin as a standalone, create an NPC with the following command:
```bash
/scnpc create <name>
```

If you have created an NPC with one of the supported plugins, you only need to execute the command `/scnpc apply <id>` to use the functions of SimpleCloud.

### NPC Configuration
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.
Expand DownExpand Up@@ -115,7 +113,7 @@ options:
send.title: title
send.subtitle: some cool subtitle
```
Configure the NPC either in the NPC configuration file or through commands.
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.
If you want to configure the NPC using commands, use either `/scnpc <id> interact <type> setAction <action>` or `/scnpc <id> interact <type> setOption <key> <value>`.

Expand All@@ -134,8 +132,8 @@ Options are sent as feedback when an action is performed. You can set the follow
alt=""
className="w-full"
style={{
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
}}
/>

Expand DownExpand Up@@ -226,15 +224,15 @@ items:
alt=""
className="w-full"
style={{
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
}}
/>

## Commands
| Command | Description |
|----------------------------------------------------------|-----------------------------------------------------------|
| `/scnpc apply <name>` | Create a NPC with our own NPC implementation |
| `/scnpc apply <name>` | Adds the support of simplecloud functions |
| `/scnpc <id> interact <type> setAction <action>` | Set Actions, type can be `right_click` or `left_click` |
| `/scnpc <id> interact <type> setOption <key> <value>` | Set options, type can be `right_click` or `left_click` |
| `/scnpc <id> interact <type> removeOption <key> <value>` | Remove options, type can be `right_click` or `left_click` |
Expand All@@ -253,20 +251,20 @@ You can use the parameters of the current server and the group to which the serv

### Hologram Placeholders

| Placeholder | Description |
|------------------------|-----------------------------------------------------|
| `<group_name>` | Name of the group |
| `<type>` | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| `<start_port>` | Start port of the Group |
| `<min_memory>` | Minimum RAM allocation in MB |
| `<max_memory>` | Maximum RAM allocation in MB |
| `<max_players>` | Maximum players per server |
| `<online_players>` | Current players count |
| `<min_online_count>` | Minimum online server count |
| `<max_online_count>` | Maximum online server count |
| `<property:NAME>` | Shows the property value |
| `<player_count:STATE>` | Shows the amount of player count by an Server state |
| `<server_count:STATE>` | Shows the amount of server count by an Server state |
| Placeholder | Description |
|------------------------------|-----------------------------------------------------|
| `<group_name>` | Name of the group |
| `<group_type>` | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| `<group_start_port>` | Start port of the Group |
| `<group_min_memory>` | Minimum RAM allocation in MB |
| `<group_max_memory>` | Maximum RAM allocation in MB |
| `<group_max_players>` | Maximum players per server |
| `<group_online_count>` | Current players count |
| `<group_min_online_count>` | Minimum online server count |
| `<group_max_online_count>` | Maximum online server count |
| `<group_property:NAME>` | Shows the property value |
| `<group_player_count:STATE>` | Shows the amount of player count by an Server state |
| `<group_server_count:STATE>` | Shows the amount of server count by an Server state |

### Inventory Placeholders

Expand Down
17 changes: 11 additions & 6 deletions src/app/providers.tsx
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
'use client'

import { useEffect } from 'react'
import { ThemeProvider, useTheme } from 'next-themes'
import {useEffect} from 'react'
import {ThemeProvider, useTheme} from 'next-themes'
import {QueryClient, QueryClientProvider} from "@tanstack/react-query";

function ThemeWatcher() {
let { resolvedTheme, setTheme } = useTheme()
Expand All@@ -27,11 +28,15 @@ function ThemeWatcher() {
return null
}

const queryClient = new QueryClient();

export function Providers({ children }: { children: React.ReactNode }) {
return (
<ThemeProvider attribute="class" disableTransitionOnChange>
<ThemeWatcher />
{children}
</ThemeProvider>
<QueryClientProvider client={queryClient}>
<ThemeProvider attribute="class" disableTransitionOnChange>
<ThemeWatcher />
{children}
</ThemeProvider>
</QueryClientProvider>
)
}
Loading
, '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
25 changes: 25 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
"@next/mdx": "^14.0.4",
"@sindresorhus/slugify": "^2.1.1",
"@tailwindcss/typography": "^0.5.10",
"@tanstack/react-query": "^5.63.0",
"@types/mdx": "^2.0.8",
"@types/node": "^20.10.8",
"@types/react": "^18.2.47",
Expand Down
47 changes: 6 additions & 41 deletions src/app/api/controller/page.mdx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {CodeGroup, Note} from "../../../components/mdx";
import {DependencySnippet} from "../../../components/DependencySnippet";

export const metadata = {
title: 'Controller API',
Expand DownExpand Up@@ -34,47 +35,11 @@ The Controller API is the central interface for managing your SimpleCloud infras

## Installation

<CodeGroup>

```kotlin {{ title: 'Kotlin' }}
repositories {
maven("https://repo.simplecloud.app/snapshots/")
}

dependencies {
api("app.simplecloud.controller:controller-api:0.0.30-dev.e3e27fc")
}
```

```groovy {{ title: 'Groovy' }}
repositories {
maven {
url "https://repo.simplecloud.app/snapshots/"
}
}

dependencies {
api 'app.simplecloud.controller:controller-api:0.0.30-dev.e3e27fc'
}
```

```xml {{ title: 'Maven' }}
<repositories>
<repository>
<id>simplecloud-snapshots</id>
<url>https://repo.simplecloud.app/snapshots/</url>
</repository>
</repositories>

<dependency>
<groupId>app.simplecloud.controller</groupId>
<artifactId>controller-api</artifactId>
<version>0.0.30-dev.e3e27fc</version>
<scope>compile</scope>
</dependency>
```

</CodeGroup>
<DependencySnippet
groupId="app.simplecloud.controller"
artifactId="controller-api"
type="snapshot"
/>

<Note>
As soon as we release our first stable version, we'll publish the Maven package to Maven Central. Until then, you can use the snapshots repository to access the latest features.
Expand Down
46 changes: 7 additions & 39 deletions src/app/api/droplet/player/page.mdx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {CodeGroup, Note} from "../../../../components/mdx";
import {CodeGroup} from "../../../../components/mdx";
import {DependencySnippet} from "../../../../components/DependencySnippet";

export const metadata = {
title: 'Player Droplet API',
Expand All@@ -22,44 +23,11 @@ The Player Droplet API provides comprehensive player management and interaction

## Installation

<CodeGroup>
```kotlin {{ title: 'Kotlin' }}
repositories {
maven("https://repo.simplecloud.app/snapshots/")
}

dependencies {
api("app.simplecloud.droplet:player-api:0.0.0")
}
```

```groovy {{ title: 'Groovy' }}
repositories {
maven {
url "https://repo.simplecloud.app/snapshots/"
}
}

dependencies {
api 'app.simplecloud.droplet:player-api:0.0.0'
}
```

```xml {{ title: 'Maven' }}
<repositories>
<repository>
<id>simplecloud-snapshots</id>
<url>https://repo.simplecloud.app/snapshots/</url>
</repository>
</repositories>

<dependency>
<groupId>app.simplecloud.droplet</groupId>
<artifactId>player-api</artifactId>
<version>0.0.0</version>
</dependency>
```
</CodeGroup>
<DependencySnippet
groupId="app.simplecloud.droplet.player"
artifactId="player-api"
type="snapshot"
/>

Authentication
If you're using our Player Droplet API in a Minecraft server, the token is automatically provided via environment variables. For external applications, you'll need to use the master authentication token.
Expand Down
64 changes: 31 additions & 33 deletions src/app/plugin/npcs/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@ export const metadata = {

# NPCs Plugin
Create NPCs on your server that allow your players to access other subservers through the NPCs.
Perform various [actions](#understanding-actions) such as sending messages, titles, action bars, or sounds, or customize inventories with your items.
Perform various [actions](#understanding-actions) such as sending messages, titles, action bars, or sounds, or customize inventories with your items.
Use your [favourite NPC system](#usage-of-other-npc-plugins) or use the plugin as a standalone with its own NPC integration.
The all new NPC plugin opens up limitless creative possibilities.

Expand DownExpand Up@@ -38,11 +38,12 @@ No problem! Thanks to the new structure, you can also use other NPC plugins such
This allows you to use all the features of your NPC plugin together with the functions of SimpleCloud.
The following NPC plugins are supported:

| Plugin | Supported Versions | This Plugin |
|---------------------------------------------------------------------------------------|-------------------------|-------------|
| [Citizens](https://citizensnpcs.co) | 1.19 - latest version | Yes |
| [FancyNpcs](https://fancyplugins.de/FancyNpcs) | 1.19.4 - latest version | Yes |
| [PlayerNPC](https://www.spigotmc.org/resources/✅-api-player-npc-✅-1-17-1-20-1.93625/) | 1.17.1 - 1.20.1 | Yes |
| Plugin | Supported Versions | This Plugin |
|-------------------------------------------------------------------------------------------------------------|-------------------------|-------------|
| [FancyNpcs](https://fancyplugins.de/FancyNpcs) | 1.19.4 - latest version | Yes |
| [Citizens](https://citizensnpcs.co) | 1.19 - latest version | Yes |
| [MythicMobs](https://www.spigotmc.org/resources/⚔-mythicmobs-free-version-►the-1-custom-mob-creator◄.5702/) | 1.19 - latest version | Yes |
| [PlayerNPC](https://www.spigotmc.org/resources/✅-api-player-npc-✅-1-17-1-20-1.93625/) | 1.17.1 - 1.20.1 | Yes |

If you would like to add support for a missing npc plugin, feel free to submit a issue on [GitHub](https://github.com/simplecloudapp/npc-plugin/pulls).

Expand All@@ -68,16 +69,13 @@ Here you will find all available actions and their options:

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.

The first step is to create an NPC. If you're using a supported NPC system, refer to the documentation of the respective plugins.
- [Create a NPC using Citizens](https://wiki.citizensnpcs.co/Commands)
The first step is to create an NPC. If you're using a supported NPC system, refer to the documentation of the respective plugins.
- [Create a NPC using FancyNpcs](https://fancyplugins.de/docs/fn-getting-started.html#create-your-first-npc)
- [Create a NPC using Citizens](https://wiki.citizensnpcs.co/Commands)
- [Create a NPC using MythicMobs](https://git.mythiccraft.io/mythiccraft/MythicMobs#getting-started)
- [Create a NPC using PlayerNPC](https://www.spigotmc.org/resources/%E2%9C%85-api-player-npc-%E2%9C%85-1-17-1-20-1.93625/)

If you want to use our NPC plugin as a standalone, create an NPC with the following command:
```bash
/scnpc create <name>
```

If you have created an NPC with one of the supported plugins, you only need to execute the command `/scnpc apply <id>` to use the functions of SimpleCloud.

### NPC Configuration
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.
Expand DownExpand Up@@ -115,7 +113,7 @@ options:
send.title: title
send.subtitle: some cool subtitle
```
Configure the NPC either in the NPC configuration file or through commands.
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.
If you want to configure the NPC using commands, use either `/scnpc <id> interact <type> setAction <action>` or `/scnpc <id> interact <type> setOption <key> <value>`.

Expand All@@ -134,8 +132,8 @@ Options are sent as feedback when an action is performed. You can set the follow
alt=""
className="w-full"
style={{
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
}}
/>

Expand DownExpand Up@@ -226,15 +224,15 @@ items:
alt=""
className="w-full"
style={{
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
}}
/>

## Commands
| Command | Description |
|----------------------------------------------------------|-----------------------------------------------------------|
| `/scnpc apply <name>` | Create a NPC with our own NPC implementation |
| `/scnpc apply <name>` | Adds the support of simplecloud functions |
| `/scnpc <id> interact <type> setAction <action>` | Set Actions, type can be `right_click` or `left_click` |
| `/scnpc <id> interact <type> setOption <key> <value>` | Set options, type can be `right_click` or `left_click` |
| `/scnpc <id> interact <type> removeOption <key> <value>` | Remove options, type can be `right_click` or `left_click` |
Expand All@@ -253,20 +251,20 @@ You can use the parameters of the current server and the group to which the serv

### Hologram Placeholders

| Placeholder | Description |
|------------------------|-----------------------------------------------------|
| `<group_name>` | Name of the group |
| `<type>` | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| `<start_port>` | Start port of the Group |
| `<min_memory>` | Minimum RAM allocation in MB |
| `<max_memory>` | Maximum RAM allocation in MB |
| `<max_players>` | Maximum players per server |
| `<online_players>` | Current players count |
| `<min_online_count>` | Minimum online server count |
| `<max_online_count>` | Maximum online server count |
| `<property:NAME>` | Shows the property value |
| `<player_count:STATE>` | Shows the amount of player count by an Server state |
| `<server_count:STATE>` | Shows the amount of server count by an Server state |
| Placeholder | Description |
|------------------------------|-----------------------------------------------------|
| `<group_name>` | Name of the group |
| `<group_type>` | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| `<group_start_port>` | Start port of the Group |
| `<group_min_memory>` | Minimum RAM allocation in MB |
| `<group_max_memory>` | Maximum RAM allocation in MB |
| `<group_max_players>` | Maximum players per server |
| `<group_online_count>` | Current players count |
| `<group_min_online_count>` | Minimum online server count |
| `<group_max_online_count>` | Maximum online server count |
| `<group_property:NAME>` | Shows the property value |
| `<group_player_count:STATE>` | Shows the amount of player count by an Server state |
| `<group_server_count:STATE>` | Shows the amount of server count by an Server state |

### Inventory Placeholders

Expand Down
17 changes: 11 additions & 6 deletions src/app/providers.tsx
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
'use client'

import { useEffect } from 'react'
import { ThemeProvider, useTheme } from 'next-themes'
import {useEffect} from 'react'
import {ThemeProvider, useTheme} from 'next-themes'
import {QueryClient, QueryClientProvider} from "@tanstack/react-query";

function ThemeWatcher() {
let { resolvedTheme, setTheme } = useTheme()
Expand All@@ -27,11 +28,15 @@ function ThemeWatcher() {
return null
}

const queryClient = new QueryClient();

export function Providers({ children }: { children: React.ReactNode }) {
return (
<ThemeProvider attribute="class" disableTransitionOnChange>
<ThemeWatcher />
{children}
</ThemeProvider>
<QueryClientProvider client={queryClient}>
<ThemeProvider attribute="class" disableTransitionOnChange>
<ThemeWatcher />
{children}
</ThemeProvider>
</QueryClientProvider>
)
}
Loading
, '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
25 changes: 25 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
"@next/mdx": "^14.0.4",
"@sindresorhus/slugify": "^2.1.1",
"@tailwindcss/typography": "^0.5.10",
"@tanstack/react-query": "^5.63.0",
"@types/mdx": "^2.0.8",
"@types/node": "^20.10.8",
"@types/react": "^18.2.47",
Expand Down
47 changes: 6 additions & 41 deletions src/app/api/controller/page.mdx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {CodeGroup, Note} from "../../../components/mdx";
import {DependencySnippet} from "../../../components/DependencySnippet";

export const metadata = {
title: 'Controller API',
Expand DownExpand Up@@ -34,47 +35,11 @@ The Controller API is the central interface for managing your SimpleCloud infras

## Installation

<CodeGroup>

```kotlin {{ title: 'Kotlin' }}
repositories {
maven("https://repo.simplecloud.app/snapshots/")
}

dependencies {
api("app.simplecloud.controller:controller-api:0.0.30-dev.e3e27fc")
}
```

```groovy {{ title: 'Groovy' }}
repositories {
maven {
url "https://repo.simplecloud.app/snapshots/"
}
}

dependencies {
api 'app.simplecloud.controller:controller-api:0.0.30-dev.e3e27fc'
}
```

```xml {{ title: 'Maven' }}
<repositories>
<repository>
<id>simplecloud-snapshots</id>
<url>https://repo.simplecloud.app/snapshots/</url>
</repository>
</repositories>

<dependency>
<groupId>app.simplecloud.controller</groupId>
<artifactId>controller-api</artifactId>
<version>0.0.30-dev.e3e27fc</version>
<scope>compile</scope>
</dependency>
```

</CodeGroup>
<DependencySnippet
groupId="app.simplecloud.controller"
artifactId="controller-api"
type="snapshot"
/>

<Note>
As soon as we release our first stable version, we'll publish the Maven package to Maven Central. Until then, you can use the snapshots repository to access the latest features.
Expand Down
46 changes: 7 additions & 39 deletions src/app/api/droplet/player/page.mdx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {CodeGroup, Note} from "../../../../components/mdx";
import {CodeGroup} from "../../../../components/mdx";
import {DependencySnippet} from "../../../../components/DependencySnippet";

export const metadata = {
title: 'Player Droplet API',
Expand All@@ -22,44 +23,11 @@ The Player Droplet API provides comprehensive player management and interaction

## Installation

<CodeGroup>
```kotlin {{ title: 'Kotlin' }}
repositories {
maven("https://repo.simplecloud.app/snapshots/")
}

dependencies {
api("app.simplecloud.droplet:player-api:0.0.0")
}
```

```groovy {{ title: 'Groovy' }}
repositories {
maven {
url "https://repo.simplecloud.app/snapshots/"
}
}

dependencies {
api 'app.simplecloud.droplet:player-api:0.0.0'
}
```

```xml {{ title: 'Maven' }}
<repositories>
<repository>
<id>simplecloud-snapshots</id>
<url>https://repo.simplecloud.app/snapshots/</url>
</repository>
</repositories>

<dependency>
<groupId>app.simplecloud.droplet</groupId>
<artifactId>player-api</artifactId>
<version>0.0.0</version>
</dependency>
```
</CodeGroup>
<DependencySnippet
groupId="app.simplecloud.droplet.player"
artifactId="player-api"
type="snapshot"
/>

Authentication
If you're using our Player Droplet API in a Minecraft server, the token is automatically provided via environment variables. For external applications, you'll need to use the master authentication token.
Expand Down
64 changes: 31 additions & 33 deletions src/app/plugin/npcs/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@ export const metadata = {

# NPCs Plugin
Create NPCs on your server that allow your players to access other subservers through the NPCs.
Perform various [actions](#understanding-actions) such as sending messages, titles, action bars, or sounds, or customize inventories with your items.
Perform various [actions](#understanding-actions) such as sending messages, titles, action bars, or sounds, or customize inventories with your items.
Use your [favourite NPC system](#usage-of-other-npc-plugins) or use the plugin as a standalone with its own NPC integration.
The all new NPC plugin opens up limitless creative possibilities.

Expand DownExpand Up@@ -38,11 +38,12 @@ No problem! Thanks to the new structure, you can also use other NPC plugins such
This allows you to use all the features of your NPC plugin together with the functions of SimpleCloud.
The following NPC plugins are supported:

| Plugin | Supported Versions | This Plugin |
|---------------------------------------------------------------------------------------|-------------------------|-------------|
| [Citizens](https://citizensnpcs.co) | 1.19 - latest version | Yes |
| [FancyNpcs](https://fancyplugins.de/FancyNpcs) | 1.19.4 - latest version | Yes |
| [PlayerNPC](https://www.spigotmc.org/resources/✅-api-player-npc-✅-1-17-1-20-1.93625/) | 1.17.1 - 1.20.1 | Yes |
| Plugin | Supported Versions | This Plugin |
|-------------------------------------------------------------------------------------------------------------|-------------------------|-------------|
| [FancyNpcs](https://fancyplugins.de/FancyNpcs) | 1.19.4 - latest version | Yes |
| [Citizens](https://citizensnpcs.co) | 1.19 - latest version | Yes |
| [MythicMobs](https://www.spigotmc.org/resources/⚔-mythicmobs-free-version-►the-1-custom-mob-creator◄.5702/) | 1.19 - latest version | Yes |
| [PlayerNPC](https://www.spigotmc.org/resources/✅-api-player-npc-✅-1-17-1-20-1.93625/) | 1.17.1 - 1.20.1 | Yes |

If you would like to add support for a missing npc plugin, feel free to submit a issue on [GitHub](https://github.com/simplecloudapp/npc-plugin/pulls).

Expand All@@ -68,16 +69,13 @@ Here you will find all available actions and their options:

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.

The first step is to create an NPC. If you're using a supported NPC system, refer to the documentation of the respective plugins.
- [Create a NPC using Citizens](https://wiki.citizensnpcs.co/Commands)
The first step is to create an NPC. If you're using a supported NPC system, refer to the documentation of the respective plugins.
- [Create a NPC using FancyNpcs](https://fancyplugins.de/docs/fn-getting-started.html#create-your-first-npc)
- [Create a NPC using Citizens](https://wiki.citizensnpcs.co/Commands)
- [Create a NPC using MythicMobs](https://git.mythiccraft.io/mythiccraft/MythicMobs#getting-started)
- [Create a NPC using PlayerNPC](https://www.spigotmc.org/resources/%E2%9C%85-api-player-npc-%E2%9C%85-1-17-1-20-1.93625/)

If you want to use our NPC plugin as a standalone, create an NPC with the following command:
```bash
/scnpc create <name>
```

If you have created an NPC with one of the supported plugins, you only need to execute the command `/scnpc apply <id>` to use the functions of SimpleCloud.

### NPC Configuration
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.
Expand DownExpand Up@@ -115,7 +113,7 @@ options:
send.title: title
send.subtitle: some cool subtitle
```
Configure the NPC either in the NPC configuration file or through commands.
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.
If you want to configure the NPC using commands, use either `/scnpc <id> interact <type> setAction <action>` or `/scnpc <id> interact <type> setOption <key> <value>`.

Expand All@@ -134,8 +132,8 @@ Options are sent as feedback when an action is performed. You can set the follow
alt=""
className="w-full"
style={{
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
}}
/>

Expand DownExpand Up@@ -226,15 +224,15 @@ items:
alt=""
className="w-full"
style={{
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
}}
/>

## Commands
| Command | Description |
|----------------------------------------------------------|-----------------------------------------------------------|
| `/scnpc apply <name>` | Create a NPC with our own NPC implementation |
| `/scnpc apply <name>` | Adds the support of simplecloud functions |
| `/scnpc <id> interact <type> setAction <action>` | Set Actions, type can be `right_click` or `left_click` |
| `/scnpc <id> interact <type> setOption <key> <value>` | Set options, type can be `right_click` or `left_click` |
| `/scnpc <id> interact <type> removeOption <key> <value>` | Remove options, type can be `right_click` or `left_click` |
Expand All@@ -253,20 +251,20 @@ You can use the parameters of the current server and the group to which the serv

### Hologram Placeholders

| Placeholder | Description |
|------------------------|-----------------------------------------------------|
| `<group_name>` | Name of the group |
| `<type>` | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| `<start_port>` | Start port of the Group |
| `<min_memory>` | Minimum RAM allocation in MB |
| `<max_memory>` | Maximum RAM allocation in MB |
| `<max_players>` | Maximum players per server |
| `<online_players>` | Current players count |
| `<min_online_count>` | Minimum online server count |
| `<max_online_count>` | Maximum online server count |
| `<property:NAME>` | Shows the property value |
| `<player_count:STATE>` | Shows the amount of player count by an Server state |
| `<server_count:STATE>` | Shows the amount of server count by an Server state |
| Placeholder | Description |
|------------------------------|-----------------------------------------------------|
| `<group_name>` | Name of the group |
| `<group_type>` | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| `<group_start_port>` | Start port of the Group |
| `<group_min_memory>` | Minimum RAM allocation in MB |
| `<group_max_memory>` | Maximum RAM allocation in MB |
| `<group_max_players>` | Maximum players per server |
| `<group_online_count>` | Current players count |
| `<group_min_online_count>` | Minimum online server count |
| `<group_max_online_count>` | Maximum online server count |
| `<group_property:NAME>` | Shows the property value |
| `<group_player_count:STATE>` | Shows the amount of player count by an Server state |
| `<group_server_count:STATE>` | Shows the amount of server count by an Server state |

### Inventory Placeholders

Expand Down
17 changes: 11 additions & 6 deletions src/app/providers.tsx
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
'use client'

import { useEffect } from 'react'
import { ThemeProvider, useTheme } from 'next-themes'
import {useEffect} from 'react'
import {ThemeProvider, useTheme} from 'next-themes'
import {QueryClient, QueryClientProvider} from "@tanstack/react-query";

function ThemeWatcher() {
let { resolvedTheme, setTheme } = useTheme()
Expand All@@ -27,11 +28,15 @@ function ThemeWatcher() {
return null
}

const queryClient = new QueryClient();

export function Providers({ children }: { children: React.ReactNode }) {
return (
<ThemeProvider attribute="class" disableTransitionOnChange>
<ThemeWatcher />
{children}
</ThemeProvider>
<QueryClientProvider client={queryClient}>
<ThemeProvider attribute="class" disableTransitionOnChange>
<ThemeWatcher />
{children}
</ThemeProvider>
</QueryClientProvider>
)
}
Loading
, '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
25 changes: 25 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
"@next/mdx": "^14.0.4",
"@sindresorhus/slugify": "^2.1.1",
"@tailwindcss/typography": "^0.5.10",
"@tanstack/react-query": "^5.63.0",
"@types/mdx": "^2.0.8",
"@types/node": "^20.10.8",
"@types/react": "^18.2.47",
Expand Down
47 changes: 6 additions & 41 deletions src/app/api/controller/page.mdx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {CodeGroup, Note} from "../../../components/mdx";
import {DependencySnippet} from "../../../components/DependencySnippet";

export const metadata = {
title: 'Controller API',
Expand DownExpand Up@@ -34,47 +35,11 @@ The Controller API is the central interface for managing your SimpleCloud infras

## Installation

<CodeGroup>

```kotlin {{ title: 'Kotlin' }}
repositories {
maven("https://repo.simplecloud.app/snapshots/")
}

dependencies {
api("app.simplecloud.controller:controller-api:0.0.30-dev.e3e27fc")
}
```

```groovy {{ title: 'Groovy' }}
repositories {
maven {
url "https://repo.simplecloud.app/snapshots/"
}
}

dependencies {
api 'app.simplecloud.controller:controller-api:0.0.30-dev.e3e27fc'
}
```

```xml {{ title: 'Maven' }}
<repositories>
<repository>
<id>simplecloud-snapshots</id>
<url>https://repo.simplecloud.app/snapshots/</url>
</repository>
</repositories>

<dependency>
<groupId>app.simplecloud.controller</groupId>
<artifactId>controller-api</artifactId>
<version>0.0.30-dev.e3e27fc</version>
<scope>compile</scope>
</dependency>
```

</CodeGroup>
<DependencySnippet
groupId="app.simplecloud.controller"
artifactId="controller-api"
type="snapshot"
/>

<Note>
As soon as we release our first stable version, we'll publish the Maven package to Maven Central. Until then, you can use the snapshots repository to access the latest features.
Expand Down
46 changes: 7 additions & 39 deletions src/app/api/droplet/player/page.mdx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {CodeGroup, Note} from "../../../../components/mdx";
import {CodeGroup} from "../../../../components/mdx";
import {DependencySnippet} from "../../../../components/DependencySnippet";

export const metadata = {
title: 'Player Droplet API',
Expand All@@ -22,44 +23,11 @@ The Player Droplet API provides comprehensive player management and interaction

## Installation

<CodeGroup>
```kotlin {{ title: 'Kotlin' }}
repositories {
maven("https://repo.simplecloud.app/snapshots/")
}

dependencies {
api("app.simplecloud.droplet:player-api:0.0.0")
}
```

```groovy {{ title: 'Groovy' }}
repositories {
maven {
url "https://repo.simplecloud.app/snapshots/"
}
}

dependencies {
api 'app.simplecloud.droplet:player-api:0.0.0'
}
```

```xml {{ title: 'Maven' }}
<repositories>
<repository>
<id>simplecloud-snapshots</id>
<url>https://repo.simplecloud.app/snapshots/</url>
</repository>
</repositories>

<dependency>
<groupId>app.simplecloud.droplet</groupId>
<artifactId>player-api</artifactId>
<version>0.0.0</version>
</dependency>
```
</CodeGroup>
<DependencySnippet
groupId="app.simplecloud.droplet.player"
artifactId="player-api"
type="snapshot"
/>

Authentication
If you're using our Player Droplet API in a Minecraft server, the token is automatically provided via environment variables. For external applications, you'll need to use the master authentication token.
Expand Down
64 changes: 31 additions & 33 deletions src/app/plugin/npcs/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@ export const metadata = {

# NPCs Plugin
Create NPCs on your server that allow your players to access other subservers through the NPCs.
Perform various [actions](#understanding-actions) such as sending messages, titles, action bars, or sounds, or customize inventories with your items.
Perform various [actions](#understanding-actions) such as sending messages, titles, action bars, or sounds, or customize inventories with your items.
Use your [favourite NPC system](#usage-of-other-npc-plugins) or use the plugin as a standalone with its own NPC integration.
The all new NPC plugin opens up limitless creative possibilities.

Expand DownExpand Up@@ -38,11 +38,12 @@ No problem! Thanks to the new structure, you can also use other NPC plugins such
This allows you to use all the features of your NPC plugin together with the functions of SimpleCloud.
The following NPC plugins are supported:

| Plugin | Supported Versions | This Plugin |
|---------------------------------------------------------------------------------------|-------------------------|-------------|
| [Citizens](https://citizensnpcs.co) | 1.19 - latest version | Yes |
| [FancyNpcs](https://fancyplugins.de/FancyNpcs) | 1.19.4 - latest version | Yes |
| [PlayerNPC](https://www.spigotmc.org/resources/✅-api-player-npc-✅-1-17-1-20-1.93625/) | 1.17.1 - 1.20.1 | Yes |
| Plugin | Supported Versions | This Plugin |
|-------------------------------------------------------------------------------------------------------------|-------------------------|-------------|
| [FancyNpcs](https://fancyplugins.de/FancyNpcs) | 1.19.4 - latest version | Yes |
| [Citizens](https://citizensnpcs.co) | 1.19 - latest version | Yes |
| [MythicMobs](https://www.spigotmc.org/resources/⚔-mythicmobs-free-version-►the-1-custom-mob-creator◄.5702/) | 1.19 - latest version | Yes |
| [PlayerNPC](https://www.spigotmc.org/resources/✅-api-player-npc-✅-1-17-1-20-1.93625/) | 1.17.1 - 1.20.1 | Yes |

If you would like to add support for a missing npc plugin, feel free to submit a issue on [GitHub](https://github.com/simplecloudapp/npc-plugin/pulls).

Expand All@@ -68,16 +69,13 @@ Here you will find all available actions and their options:

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.

The first step is to create an NPC. If you're using a supported NPC system, refer to the documentation of the respective plugins.
- [Create a NPC using Citizens](https://wiki.citizensnpcs.co/Commands)
The first step is to create an NPC. If you're using a supported NPC system, refer to the documentation of the respective plugins.
- [Create a NPC using FancyNpcs](https://fancyplugins.de/docs/fn-getting-started.html#create-your-first-npc)
- [Create a NPC using Citizens](https://wiki.citizensnpcs.co/Commands)
- [Create a NPC using MythicMobs](https://git.mythiccraft.io/mythiccraft/MythicMobs#getting-started)
- [Create a NPC using PlayerNPC](https://www.spigotmc.org/resources/%E2%9C%85-api-player-npc-%E2%9C%85-1-17-1-20-1.93625/)

If you want to use our NPC plugin as a standalone, create an NPC with the following command:
```bash
/scnpc create <name>
```

If you have created an NPC with one of the supported plugins, you only need to execute the command `/scnpc apply <id>` to use the functions of SimpleCloud.

### NPC Configuration
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.
Expand DownExpand Up@@ -115,7 +113,7 @@ options:
send.title: title
send.subtitle: some cool subtitle
```
Configure the NPC either in the NPC configuration file or through commands.
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.
If you want to configure the NPC using commands, use either `/scnpc <id> interact <type> setAction <action>` or `/scnpc <id> interact <type> setOption <key> <value>`.

Expand All@@ -134,8 +132,8 @@ Options are sent as feedback when an action is performed. You can set the follow
alt=""
className="w-full"
style={{
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
}}
/>

Expand DownExpand Up@@ -226,15 +224,15 @@ items:
alt=""
className="w-full"
style={{
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
}}
/>

## Commands
| Command | Description |
|----------------------------------------------------------|-----------------------------------------------------------|
| `/scnpc apply <name>` | Create a NPC with our own NPC implementation |
| `/scnpc apply <name>` | Adds the support of simplecloud functions |
| `/scnpc <id> interact <type> setAction <action>` | Set Actions, type can be `right_click` or `left_click` |
| `/scnpc <id> interact <type> setOption <key> <value>` | Set options, type can be `right_click` or `left_click` |
| `/scnpc <id> interact <type> removeOption <key> <value>` | Remove options, type can be `right_click` or `left_click` |
Expand All@@ -253,20 +251,20 @@ You can use the parameters of the current server and the group to which the serv

### Hologram Placeholders

| Placeholder | Description |
|------------------------|-----------------------------------------------------|
| `<group_name>` | Name of the group |
| `<type>` | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| `<start_port>` | Start port of the Group |
| `<min_memory>` | Minimum RAM allocation in MB |
| `<max_memory>` | Maximum RAM allocation in MB |
| `<max_players>` | Maximum players per server |
| `<online_players>` | Current players count |
| `<min_online_count>` | Minimum online server count |
| `<max_online_count>` | Maximum online server count |
| `<property:NAME>` | Shows the property value |
| `<player_count:STATE>` | Shows the amount of player count by an Server state |
| `<server_count:STATE>` | Shows the amount of server count by an Server state |
| Placeholder | Description |
|------------------------------|-----------------------------------------------------|
| `<group_name>` | Name of the group |
| `<group_type>` | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| `<group_start_port>` | Start port of the Group |
| `<group_min_memory>` | Minimum RAM allocation in MB |
| `<group_max_memory>` | Maximum RAM allocation in MB |
| `<group_max_players>` | Maximum players per server |
| `<group_online_count>` | Current players count |
| `<group_min_online_count>` | Minimum online server count |
| `<group_max_online_count>` | Maximum online server count |
| `<group_property:NAME>` | Shows the property value |
| `<group_player_count:STATE>` | Shows the amount of player count by an Server state |
| `<group_server_count:STATE>` | Shows the amount of server count by an Server state |

### Inventory Placeholders

Expand Down
17 changes: 11 additions & 6 deletions src/app/providers.tsx
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
'use client'

import { useEffect } from 'react'
import { ThemeProvider, useTheme } from 'next-themes'
import {useEffect} from 'react'
import {ThemeProvider, useTheme} from 'next-themes'
import {QueryClient, QueryClientProvider} from "@tanstack/react-query";

function ThemeWatcher() {
let { resolvedTheme, setTheme } = useTheme()
Expand All@@ -27,11 +28,15 @@ function ThemeWatcher() {
return null
}

const queryClient = new QueryClient();

export function Providers({ children }: { children: React.ReactNode }) {
return (
<ThemeProvider attribute="class" disableTransitionOnChange>
<ThemeWatcher />
{children}
</ThemeProvider>
<QueryClientProvider client={queryClient}>
<ThemeProvider attribute="class" disableTransitionOnChange>
<ThemeWatcher />
{children}
</ThemeProvider>
</QueryClientProvider>
)
}
Loading
, '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
25 changes: 25 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
"@next/mdx": "^14.0.4",
"@sindresorhus/slugify": "^2.1.1",
"@tailwindcss/typography": "^0.5.10",
"@tanstack/react-query": "^5.63.0",
"@types/mdx": "^2.0.8",
"@types/node": "^20.10.8",
"@types/react": "^18.2.47",
Expand Down
47 changes: 6 additions & 41 deletions src/app/api/controller/page.mdx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {CodeGroup, Note} from "../../../components/mdx";
import {DependencySnippet} from "../../../components/DependencySnippet";

export const metadata = {
title: 'Controller API',
Expand DownExpand Up@@ -34,47 +35,11 @@ The Controller API is the central interface for managing your SimpleCloud infras

## Installation

<CodeGroup>

```kotlin {{ title: 'Kotlin' }}
repositories {
maven("https://repo.simplecloud.app/snapshots/")
}

dependencies {
api("app.simplecloud.controller:controller-api:0.0.30-dev.e3e27fc")
}
```

```groovy {{ title: 'Groovy' }}
repositories {
maven {
url "https://repo.simplecloud.app/snapshots/"
}
}

dependencies {
api 'app.simplecloud.controller:controller-api:0.0.30-dev.e3e27fc'
}
```

```xml {{ title: 'Maven' }}
<repositories>
<repository>
<id>simplecloud-snapshots</id>
<url>https://repo.simplecloud.app/snapshots/</url>
</repository>
</repositories>

<dependency>
<groupId>app.simplecloud.controller</groupId>
<artifactId>controller-api</artifactId>
<version>0.0.30-dev.e3e27fc</version>
<scope>compile</scope>
</dependency>
```

</CodeGroup>
<DependencySnippet
groupId="app.simplecloud.controller"
artifactId="controller-api"
type="snapshot"
/>

<Note>
As soon as we release our first stable version, we'll publish the Maven package to Maven Central. Until then, you can use the snapshots repository to access the latest features.
Expand Down
46 changes: 7 additions & 39 deletions src/app/api/droplet/player/page.mdx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {CodeGroup, Note} from "../../../../components/mdx";
import {CodeGroup} from "../../../../components/mdx";
import {DependencySnippet} from "../../../../components/DependencySnippet";

export const metadata = {
title: 'Player Droplet API',
Expand All@@ -22,44 +23,11 @@ The Player Droplet API provides comprehensive player management and interaction

## Installation

<CodeGroup>
```kotlin {{ title: 'Kotlin' }}
repositories {
maven("https://repo.simplecloud.app/snapshots/")
}

dependencies {
api("app.simplecloud.droplet:player-api:0.0.0")
}
```

```groovy {{ title: 'Groovy' }}
repositories {
maven {
url "https://repo.simplecloud.app/snapshots/"
}
}

dependencies {
api 'app.simplecloud.droplet:player-api:0.0.0'
}
```

```xml {{ title: 'Maven' }}
<repositories>
<repository>
<id>simplecloud-snapshots</id>
<url>https://repo.simplecloud.app/snapshots/</url>
</repository>
</repositories>

<dependency>
<groupId>app.simplecloud.droplet</groupId>
<artifactId>player-api</artifactId>
<version>0.0.0</version>
</dependency>
```
</CodeGroup>
<DependencySnippet
groupId="app.simplecloud.droplet.player"
artifactId="player-api"
type="snapshot"
/>

Authentication
If you're using our Player Droplet API in a Minecraft server, the token is automatically provided via environment variables. For external applications, you'll need to use the master authentication token.
Expand Down
64 changes: 31 additions & 33 deletions src/app/plugin/npcs/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@ export const metadata = {

# NPCs Plugin
Create NPCs on your server that allow your players to access other subservers through the NPCs.
Perform various [actions](#understanding-actions) such as sending messages, titles, action bars, or sounds, or customize inventories with your items.
Perform various [actions](#understanding-actions) such as sending messages, titles, action bars, or sounds, or customize inventories with your items.
Use your [favourite NPC system](#usage-of-other-npc-plugins) or use the plugin as a standalone with its own NPC integration.
The all new NPC plugin opens up limitless creative possibilities.

Expand DownExpand Up@@ -38,11 +38,12 @@ No problem! Thanks to the new structure, you can also use other NPC plugins such
This allows you to use all the features of your NPC plugin together with the functions of SimpleCloud.
The following NPC plugins are supported:

| Plugin | Supported Versions | This Plugin |
|---------------------------------------------------------------------------------------|-------------------------|-------------|
| [Citizens](https://citizensnpcs.co) | 1.19 - latest version | Yes |
| [FancyNpcs](https://fancyplugins.de/FancyNpcs) | 1.19.4 - latest version | Yes |
| [PlayerNPC](https://www.spigotmc.org/resources/✅-api-player-npc-✅-1-17-1-20-1.93625/) | 1.17.1 - 1.20.1 | Yes |
| Plugin | Supported Versions | This Plugin |
|-------------------------------------------------------------------------------------------------------------|-------------------------|-------------|
| [FancyNpcs](https://fancyplugins.de/FancyNpcs) | 1.19.4 - latest version | Yes |
| [Citizens](https://citizensnpcs.co) | 1.19 - latest version | Yes |
| [MythicMobs](https://www.spigotmc.org/resources/⚔-mythicmobs-free-version-►the-1-custom-mob-creator◄.5702/) | 1.19 - latest version | Yes |
| [PlayerNPC](https://www.spigotmc.org/resources/✅-api-player-npc-✅-1-17-1-20-1.93625/) | 1.17.1 - 1.20.1 | Yes |

If you would like to add support for a missing npc plugin, feel free to submit a issue on [GitHub](https://github.com/simplecloudapp/npc-plugin/pulls).

Expand All@@ -68,16 +69,13 @@ Here you will find all available actions and their options:

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.

The first step is to create an NPC. If you're using a supported NPC system, refer to the documentation of the respective plugins.
- [Create a NPC using Citizens](https://wiki.citizensnpcs.co/Commands)
The first step is to create an NPC. If you're using a supported NPC system, refer to the documentation of the respective plugins.
- [Create a NPC using FancyNpcs](https://fancyplugins.de/docs/fn-getting-started.html#create-your-first-npc)
- [Create a NPC using Citizens](https://wiki.citizensnpcs.co/Commands)
- [Create a NPC using MythicMobs](https://git.mythiccraft.io/mythiccraft/MythicMobs#getting-started)
- [Create a NPC using PlayerNPC](https://www.spigotmc.org/resources/%E2%9C%85-api-player-npc-%E2%9C%85-1-17-1-20-1.93625/)

If you want to use our NPC plugin as a standalone, create an NPC with the following command:
```bash
/scnpc create <name>
```

If you have created an NPC with one of the supported plugins, you only need to execute the command `/scnpc apply <id>` to use the functions of SimpleCloud.

### NPC Configuration
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.
Expand DownExpand Up@@ -115,7 +113,7 @@ options:
send.title: title
send.subtitle: some cool subtitle
```
Configure the NPC either in the NPC configuration file or through commands.
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.
If you want to configure the NPC using commands, use either `/scnpc <id> interact <type> setAction <action>` or `/scnpc <id> interact <type> setOption <key> <value>`.

Expand All@@ -134,8 +132,8 @@ Options are sent as feedback when an action is performed. You can set the follow
alt=""
className="w-full"
style={{
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
}}
/>

Expand DownExpand Up@@ -226,15 +224,15 @@ items:
alt=""
className="w-full"
style={{
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
}}
/>

## Commands
| Command | Description |
|----------------------------------------------------------|-----------------------------------------------------------|
| `/scnpc apply <name>` | Create a NPC with our own NPC implementation |
| `/scnpc apply <name>` | Adds the support of simplecloud functions |
| `/scnpc <id> interact <type> setAction <action>` | Set Actions, type can be `right_click` or `left_click` |
| `/scnpc <id> interact <type> setOption <key> <value>` | Set options, type can be `right_click` or `left_click` |
| `/scnpc <id> interact <type> removeOption <key> <value>` | Remove options, type can be `right_click` or `left_click` |
Expand All@@ -253,20 +251,20 @@ You can use the parameters of the current server and the group to which the serv

### Hologram Placeholders

| Placeholder | Description |
|------------------------|-----------------------------------------------------|
| `<group_name>` | Name of the group |
| `<type>` | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| `<start_port>` | Start port of the Group |
| `<min_memory>` | Minimum RAM allocation in MB |
| `<max_memory>` | Maximum RAM allocation in MB |
| `<max_players>` | Maximum players per server |
| `<online_players>` | Current players count |
| `<min_online_count>` | Minimum online server count |
| `<max_online_count>` | Maximum online server count |
| `<property:NAME>` | Shows the property value |
| `<player_count:STATE>` | Shows the amount of player count by an Server state |
| `<server_count:STATE>` | Shows the amount of server count by an Server state |
| Placeholder | Description |
|------------------------------|-----------------------------------------------------|
| `<group_name>` | Name of the group |
| `<group_type>` | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| `<group_start_port>` | Start port of the Group |
| `<group_min_memory>` | Minimum RAM allocation in MB |
| `<group_max_memory>` | Maximum RAM allocation in MB |
| `<group_max_players>` | Maximum players per server |
| `<group_online_count>` | Current players count |
| `<group_min_online_count>` | Minimum online server count |
| `<group_max_online_count>` | Maximum online server count |
| `<group_property:NAME>` | Shows the property value |
| `<group_player_count:STATE>` | Shows the amount of player count by an Server state |
| `<group_server_count:STATE>` | Shows the amount of server count by an Server state |

### Inventory Placeholders

Expand Down
17 changes: 11 additions & 6 deletions src/app/providers.tsx
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
'use client'

import { useEffect } from 'react'
import { ThemeProvider, useTheme } from 'next-themes'
import {useEffect} from 'react'
import {ThemeProvider, useTheme} from 'next-themes'
import {QueryClient, QueryClientProvider} from "@tanstack/react-query";

function ThemeWatcher() {
let { resolvedTheme, setTheme } = useTheme()
Expand All@@ -27,11 +28,15 @@ function ThemeWatcher() {
return null
}

const queryClient = new QueryClient();

export function Providers({ children }: { children: React.ReactNode }) {
return (
<ThemeProvider attribute="class" disableTransitionOnChange>
<ThemeWatcher />
{children}
</ThemeProvider>
<QueryClientProvider client={queryClient}>
<ThemeProvider attribute="class" disableTransitionOnChange>
<ThemeWatcher />
{children}
</ThemeProvider>
</QueryClientProvider>
)
}
Loading
, '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
25 changes: 25 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
"@next/mdx": "^14.0.4",
"@sindresorhus/slugify": "^2.1.1",
"@tailwindcss/typography": "^0.5.10",
"@tanstack/react-query": "^5.63.0",
"@types/mdx": "^2.0.8",
"@types/node": "^20.10.8",
"@types/react": "^18.2.47",
Expand Down
47 changes: 6 additions & 41 deletions src/app/api/controller/page.mdx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {CodeGroup, Note} from "../../../components/mdx";
import {DependencySnippet} from "../../../components/DependencySnippet";

export const metadata = {
title: 'Controller API',
Expand DownExpand Up@@ -34,47 +35,11 @@ The Controller API is the central interface for managing your SimpleCloud infras

## Installation

<CodeGroup>

```kotlin {{ title: 'Kotlin' }}
repositories {
maven("https://repo.simplecloud.app/snapshots/")
}

dependencies {
api("app.simplecloud.controller:controller-api:0.0.30-dev.e3e27fc")
}
```

```groovy {{ title: 'Groovy' }}
repositories {
maven {
url "https://repo.simplecloud.app/snapshots/"
}
}

dependencies {
api 'app.simplecloud.controller:controller-api:0.0.30-dev.e3e27fc'
}
```

```xml {{ title: 'Maven' }}
<repositories>
<repository>
<id>simplecloud-snapshots</id>
<url>https://repo.simplecloud.app/snapshots/</url>
</repository>
</repositories>

<dependency>
<groupId>app.simplecloud.controller</groupId>
<artifactId>controller-api</artifactId>
<version>0.0.30-dev.e3e27fc</version>
<scope>compile</scope>
</dependency>
```

</CodeGroup>
<DependencySnippet
groupId="app.simplecloud.controller"
artifactId="controller-api"
type="snapshot"
/>

<Note>
As soon as we release our first stable version, we'll publish the Maven package to Maven Central. Until then, you can use the snapshots repository to access the latest features.
Expand Down
46 changes: 7 additions & 39 deletions src/app/api/droplet/player/page.mdx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {CodeGroup, Note} from "../../../../components/mdx";
import {CodeGroup} from "../../../../components/mdx";
import {DependencySnippet} from "../../../../components/DependencySnippet";

export const metadata = {
title: 'Player Droplet API',
Expand All@@ -22,44 +23,11 @@ The Player Droplet API provides comprehensive player management and interaction

## Installation

<CodeGroup>
```kotlin {{ title: 'Kotlin' }}
repositories {
maven("https://repo.simplecloud.app/snapshots/")
}

dependencies {
api("app.simplecloud.droplet:player-api:0.0.0")
}
```

```groovy {{ title: 'Groovy' }}
repositories {
maven {
url "https://repo.simplecloud.app/snapshots/"
}
}

dependencies {
api 'app.simplecloud.droplet:player-api:0.0.0'
}
```

```xml {{ title: 'Maven' }}
<repositories>
<repository>
<id>simplecloud-snapshots</id>
<url>https://repo.simplecloud.app/snapshots/</url>
</repository>
</repositories>

<dependency>
<groupId>app.simplecloud.droplet</groupId>
<artifactId>player-api</artifactId>
<version>0.0.0</version>
</dependency>
```
</CodeGroup>
<DependencySnippet
groupId="app.simplecloud.droplet.player"
artifactId="player-api"
type="snapshot"
/>

Authentication
If you're using our Player Droplet API in a Minecraft server, the token is automatically provided via environment variables. For external applications, you'll need to use the master authentication token.
Expand Down
64 changes: 31 additions & 33 deletions src/app/plugin/npcs/page.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@ export const metadata = {

# NPCs Plugin
Create NPCs on your server that allow your players to access other subservers through the NPCs.
Perform various [actions](#understanding-actions) such as sending messages, titles, action bars, or sounds, or customize inventories with your items.
Perform various [actions](#understanding-actions) such as sending messages, titles, action bars, or sounds, or customize inventories with your items.
Use your [favourite NPC system](#usage-of-other-npc-plugins) or use the plugin as a standalone with its own NPC integration.
The all new NPC plugin opens up limitless creative possibilities.

Expand DownExpand Up@@ -38,11 +38,12 @@ No problem! Thanks to the new structure, you can also use other NPC plugins such
This allows you to use all the features of your NPC plugin together with the functions of SimpleCloud.
The following NPC plugins are supported:

| Plugin | Supported Versions | This Plugin |
|---------------------------------------------------------------------------------------|-------------------------|-------------|
| [Citizens](https://citizensnpcs.co) | 1.19 - latest version | Yes |
| [FancyNpcs](https://fancyplugins.de/FancyNpcs) | 1.19.4 - latest version | Yes |
| [PlayerNPC](https://www.spigotmc.org/resources/✅-api-player-npc-✅-1-17-1-20-1.93625/) | 1.17.1 - 1.20.1 | Yes |
| Plugin | Supported Versions | This Plugin |
|-------------------------------------------------------------------------------------------------------------|-------------------------|-------------|
| [FancyNpcs](https://fancyplugins.de/FancyNpcs) | 1.19.4 - latest version | Yes |
| [Citizens](https://citizensnpcs.co) | 1.19 - latest version | Yes |
| [MythicMobs](https://www.spigotmc.org/resources/⚔-mythicmobs-free-version-►the-1-custom-mob-creator◄.5702/) | 1.19 - latest version | Yes |
| [PlayerNPC](https://www.spigotmc.org/resources/✅-api-player-npc-✅-1-17-1-20-1.93625/) | 1.17.1 - 1.20.1 | Yes |

If you would like to add support for a missing npc plugin, feel free to submit a issue on [GitHub](https://github.com/simplecloudapp/npc-plugin/pulls).

Expand All@@ -68,16 +69,13 @@ Here you will find all available actions and their options:

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.

The first step is to create an NPC. If you're using a supported NPC system, refer to the documentation of the respective plugins.
- [Create a NPC using Citizens](https://wiki.citizensnpcs.co/Commands)
The first step is to create an NPC. If you're using a supported NPC system, refer to the documentation of the respective plugins.
- [Create a NPC using FancyNpcs](https://fancyplugins.de/docs/fn-getting-started.html#create-your-first-npc)
- [Create a NPC using Citizens](https://wiki.citizensnpcs.co/Commands)
- [Create a NPC using MythicMobs](https://git.mythiccraft.io/mythiccraft/MythicMobs#getting-started)
- [Create a NPC using PlayerNPC](https://www.spigotmc.org/resources/%E2%9C%85-api-player-npc-%E2%9C%85-1-17-1-20-1.93625/)

If you want to use our NPC plugin as a standalone, create an NPC with the following command:
```bash
/scnpc create <name>
```

If you have created an NPC with one of the supported plugins, you only need to execute the command `/scnpc apply <id>` to use the functions of SimpleCloud.

### NPC Configuration
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.
Expand DownExpand Up@@ -115,7 +113,7 @@ options:
send.title: title
send.subtitle: some cool subtitle
```
Configure the NPC either in the NPC configuration file or through commands.
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.
If you want to configure the NPC using commands, use either `/scnpc <id> interact <type> setAction <action>` or `/scnpc <id> interact <type> setOption <key> <value>`.

Expand All@@ -134,8 +132,8 @@ Options are sent as feedback when an action is performed. You can set the follow
alt=""
className="w-full"
style={{
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
}}
/>

Expand DownExpand Up@@ -226,15 +224,15 @@ items:
alt=""
className="w-full"
style={{
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
}}
/>

## Commands
| Command | Description |
|----------------------------------------------------------|-----------------------------------------------------------|
| `/scnpc apply <name>` | Create a NPC with our own NPC implementation |
| `/scnpc apply <name>` | Adds the support of simplecloud functions |
| `/scnpc <id> interact <type> setAction <action>` | Set Actions, type can be `right_click` or `left_click` |
| `/scnpc <id> interact <type> setOption <key> <value>` | Set options, type can be `right_click` or `left_click` |
| `/scnpc <id> interact <type> removeOption <key> <value>` | Remove options, type can be `right_click` or `left_click` |
Expand All@@ -253,20 +251,20 @@ You can use the parameters of the current server and the group to which the serv

### Hologram Placeholders

| Placeholder | Description |
|------------------------|-----------------------------------------------------|
| `<group_name>` | Name of the group |
| `<type>` | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| `<start_port>` | Start port of the Group |
| `<min_memory>` | Minimum RAM allocation in MB |
| `<max_memory>` | Maximum RAM allocation in MB |
| `<max_players>` | Maximum players per server |
| `<online_players>` | Current players count |
| `<min_online_count>` | Minimum online server count |
| `<max_online_count>` | Maximum online server count |
| `<property:NAME>` | Shows the property value |
| `<player_count:STATE>` | Shows the amount of player count by an Server state |
| `<server_count:STATE>` | Shows the amount of server count by an Server state |
| Placeholder | Description |
|------------------------------|-----------------------------------------------------|
| `<group_name>` | Name of the group |
| `<group_type>` | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| `<group_start_port>` | Start port of the Group |
| `<group_min_memory>` | Minimum RAM allocation in MB |
| `<group_max_memory>` | Maximum RAM allocation in MB |
| `<group_max_players>` | Maximum players per server |
| `<group_online_count>` | Current players count |
| `<group_min_online_count>` | Minimum online server count |
| `<group_max_online_count>` | Maximum online server count |
| `<group_property:NAME>` | Shows the property value |
| `<group_player_count:STATE>` | Shows the amount of player count by an Server state |
| `<group_server_count:STATE>` | Shows the amount of server count by an Server state |

### Inventory Placeholders

Expand Down
17 changes: 11 additions & 6 deletions src/app/providers.tsx
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
'use client'

import { useEffect } from 'react'
import { ThemeProvider, useTheme } from 'next-themes'
import {useEffect} from 'react'
import {ThemeProvider, useTheme} from 'next-themes'
import {QueryClient, QueryClientProvider} from "@tanstack/react-query";

function ThemeWatcher() {
let { resolvedTheme, setTheme } = useTheme()
Expand All@@ -27,11 +28,15 @@ function ThemeWatcher() {
return null
}

const queryClient = new QueryClient();

export function Providers({ children }: { children: React.ReactNode }) {
return (
<ThemeProvider attribute="class" disableTransitionOnChange>
<ThemeWatcher />
{children}
</ThemeProvider>
<QueryClientProvider client={queryClient}>
<ThemeProvider attribute="class" disableTransitionOnChange>
<ThemeWatcher />
{children}
</ThemeProvider>
</QueryClientProvider>
)
}
Loading