feat: update documentation#15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Dominic-Kaemereit merged 1 commit into from
Dec 22, 2024
Merged

feat: update documentation #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
120 changes: 74 additions & 46 deletions src/app/plugin/proxy-info/page.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import {Button} from "../../../components/Button";
import {CodeGroup} from "../../../components/Code";

export const metadata = {
title: 'Proxy Plugin',
title: 'Proxy Info Plugin',
description: 'Enhance your server network with customizable MOTD and Tablist features'
}

Expand DownExpand Up@@ -30,7 +30,6 @@ If you would like to add support for a missing server software, feel free to sub
1. Download the plugin for your proxy software
2. Place it in your proxy template's plugins folder
3. Start your proxy server
4. Configure using `messages.yml`, `tablist.yml` the layouts in `layout/your-layout.yml`

## Features

Expand All@@ -39,14 +38,11 @@ Our MOTD system supports multiple layouts that you can create in the `layout/` f

```yaml
first-lines:
- <gradient:#00fcff:#0da1a3><bold>SimpleCloud</bold></gradient> <dark_gray>»<gray>
Simplify your network <dark_gray>|<bold><#4595ff> 1.12<#545454> - <#4595ff>1.20</bold>
- <color:#0ea5e9>A simplecloud.app network
second-lines:
- '<dark_gray>× <#178fff>Status<dark_gray>: <bold><#22cc22>Online</bold> <dark_gray>-
<#ffffff>%PROXY%'
- ' '
player-info: []
version-name: ''
server-icon: server-icon.png
max-player-display-type: REAL #or DYNAMIC
dynamic-player-range: 1 #Only enabled if max-player-display-type is DYNAMIC
```
Expand All@@ -58,70 +54,102 @@ dynamic-player-range: 1 #Only enabled if max-player-display-type is DYNAMIC

Create engaging tablist headers and footers that update automatically. The plugin supports both static and animated content, with configurable update intervals. You can display real-time information like player counts, server status, or custom messages. All text supports MiniMessage formatting for advanced styling.

#### Configuration for static tablist
```yaml
groups:

- group-or-service: '*'
tab-lists:
- header:
- <dark_gray> <dark_gray>
- <aqua>SimpleCloud <dark_gray>» <gray>Simplify <white><italic>your</italic>
<gray>network
- <dark_aqua>Online <dark_gray>» <gray><online_players><dark_gray>/<gray><max_players>
<dark_gray>┃ <dark_aqua>Server <dark_gray>» <gray><server_name>
- <dark_gray>
- ''
- <color:#0ea5e9>SimpleCloud v3
- ''
footer:
- <dark_gray>
- <dark_aqua>Twitter <dark_gray>» <gray>@theSimpleCloud
- <dark_aqua>Discord <dark_gray>» <gray>discord.simplecloud.app
- <dark_gray>
- group-or-service: 'lobby'
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
tab-list-update-time: 0 #If set to 0, the tablist will not update, otherwise it will update every x milliseconds
```

#### Configuration for dynamic tablist
```yaml
groups:
- group-or-service: '*'
tab-lists:
- header:
- <white>Welcome back on %SERVER_NAME%
- ''
- <color:#0ea5e9>SimpleCloud v3
- 'Frame 1'
footer:
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
- header:
- ''
- <color:#0ea5e9>SimpleCloud v3
- 'Frame 2'
footer:
- <gray>%ONLINE_PLAYERS%<dark_gray>/<gray>%MAX_PLAYERS%
tab-list-update-time: 3000 #When 0, the tablist will no longer be updated afterward.
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
tab-list-update-time: 1000 #The 1000 is the update interval in milliseconds
```

### Joinstates

<DangerNote>
Documentation will be available in the coming days.
</DangerNote>
You can use joinstates to define which user groups are allowed to join the network. You can create or adjust the joinstates in the `joinstate.yml` file.
Depending on which joinstate is currently active for a group, the corresponding authorizations that you have defined in the configuration are applied.
You can define different joinstates for each server or group. The plugin supports MiniMessage formatting for the display of rich text content.

```yaml
default-state: public
join-states:
- name: public
join-permission: ''
full-join-permission: simplecloud.join.full.public
motd-layout-by-proxy: public
- name: closedBeta
join-permission: simplecloud.join.closedbeta
full-join-permission: simplecloud.join.full.closedbeta
motd-layout-by-proxy: closed_beta
- name: maintenance
join-permission: simplecloud.join.maintenance
full-join-permission: simplecloud.join.full.maintenance
motd-layout-by-proxy: maintenance
```

## Placeholders

| Placeholder | MOTD | Tablist | Description |
|-------------------|------|----------|--------------------------------|
| %ONLINE_PLAYERS% | Yes | Yes | Current online players |
| %MAX_PLAYERS% | Yes | Yes | Maximum network players |
| %SERVER_NAME%| No | Yes | Player's current server |
| %CURRENT_TIME%| No | Yes | Current time |
| %CURRENT_DATE% | No | Yes | Current date |
| %PING% | No | Yes | Player's ping |
| \<online_players\> | Yes | Yes | Current online players |
| \<max_players\> | Yes | Yes | Maximum network players |
| \<date\>| Yes | Yes | Current date |
| \<env:NAME\> | Yes | Yes | Show the value |
| \<server_name\>| No | Yes | Player's current server |
| \<ping\> | No | Yes | Player's ping |

## API Integration

The plugin provides events for custom modifications:

<CodeGroup>
```java {{title: 'Tablist Event Example'}}
@Subscribe
public void onTablistConfiguration(TablistConfigurationEvent event) {
TablistConfiguration config = event.getTablistConfiguration();
<DangerNote>
The documentation will be available as soon as the API is ready and public
</DangerNote>

// Modify header
Component header = config.getHeader()
.replaceText(TextReplacementConfig.builder()
.match("%CUSTOM_PLACEHOLDER%")
.replacement("<red>Custom Text</red>")
.build());

config.setHeader(header);
}
```
</CodeGroup>
## Permissions
| **Permission** | **Description** |
|------------------------------|----------------------------------------------------------------------------------------------------|
| `simplecloud.command.joinstate.*` | Allows the user to use all joinstate commands. |
| `simplecloud.command.joinstate.help` | Allows the user to see the joinstate command help. |
| `simplecloud.command.joinstate.server` | Allows the user to set the joinstate for a server. |
| `simplecloud.command.joinstate.group.` | Allows the user to set the joinstate for a group and all servers in the group. |

## What's Next?

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e 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

feat: update documentation#15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Dominic-Kaemereit merged 1 commit into from
Dec 22, 2024
Merged

feat: update documentation #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
120 changes: 74 additions & 46 deletions src/app/plugin/proxy-info/page.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import {Button} from "../../../components/Button";
import {CodeGroup} from "../../../components/Code";

export const metadata = {
title: 'Proxy Plugin',
title: 'Proxy Info Plugin',
description: 'Enhance your server network with customizable MOTD and Tablist features'
}

Expand DownExpand Up@@ -30,7 +30,6 @@ If you would like to add support for a missing server software, feel free to sub
1. Download the plugin for your proxy software
2. Place it in your proxy template's plugins folder
3. Start your proxy server
4. Configure using `messages.yml`, `tablist.yml` the layouts in `layout/your-layout.yml`

## Features

Expand All@@ -39,14 +38,11 @@ Our MOTD system supports multiple layouts that you can create in the `layout/` f

```yaml
first-lines:
- <gradient:#00fcff:#0da1a3><bold>SimpleCloud</bold></gradient> <dark_gray>»<gray>
Simplify your network <dark_gray>|<bold><#4595ff> 1.12<#545454> - <#4595ff>1.20</bold>
- <color:#0ea5e9>A simplecloud.app network
second-lines:
- '<dark_gray>× <#178fff>Status<dark_gray>: <bold><#22cc22>Online</bold> <dark_gray>-
<#ffffff>%PROXY%'
- ' '
player-info: []
version-name: ''
server-icon: server-icon.png
max-player-display-type: REAL #or DYNAMIC
dynamic-player-range: 1 #Only enabled if max-player-display-type is DYNAMIC
```
Expand All@@ -58,70 +54,102 @@ dynamic-player-range: 1 #Only enabled if max-player-display-type is DYNAMIC

Create engaging tablist headers and footers that update automatically. The plugin supports both static and animated content, with configurable update intervals. You can display real-time information like player counts, server status, or custom messages. All text supports MiniMessage formatting for advanced styling.

#### Configuration for static tablist
```yaml
groups:

- group-or-service: '*'
tab-lists:
- header:
- <dark_gray> <dark_gray>
- <aqua>SimpleCloud <dark_gray>» <gray>Simplify <white><italic>your</italic>
<gray>network
- <dark_aqua>Online <dark_gray>» <gray><online_players><dark_gray>/<gray><max_players>
<dark_gray>┃ <dark_aqua>Server <dark_gray>» <gray><server_name>
- <dark_gray>
- ''
- <color:#0ea5e9>SimpleCloud v3
- ''
footer:
- <dark_gray>
- <dark_aqua>Twitter <dark_gray>» <gray>@theSimpleCloud
- <dark_aqua>Discord <dark_gray>» <gray>discord.simplecloud.app
- <dark_gray>
- group-or-service: 'lobby'
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
tab-list-update-time: 0 #If set to 0, the tablist will not update, otherwise it will update every x milliseconds
```

#### Configuration for dynamic tablist
```yaml
groups:
- group-or-service: '*'
tab-lists:
- header:
- <white>Welcome back on %SERVER_NAME%
- ''
- <color:#0ea5e9>SimpleCloud v3
- 'Frame 1'
footer:
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
- header:
- ''
- <color:#0ea5e9>SimpleCloud v3
- 'Frame 2'
footer:
- <gray>%ONLINE_PLAYERS%<dark_gray>/<gray>%MAX_PLAYERS%
tab-list-update-time: 3000 #When 0, the tablist will no longer be updated afterward.
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
tab-list-update-time: 1000 #The 1000 is the update interval in milliseconds
```

### Joinstates

<DangerNote>
Documentation will be available in the coming days.
</DangerNote>
You can use joinstates to define which user groups are allowed to join the network. You can create or adjust the joinstates in the `joinstate.yml` file.
Depending on which joinstate is currently active for a group, the corresponding authorizations that you have defined in the configuration are applied.
You can define different joinstates for each server or group. The plugin supports MiniMessage formatting for the display of rich text content.

```yaml
default-state: public
join-states:
- name: public
join-permission: ''
full-join-permission: simplecloud.join.full.public
motd-layout-by-proxy: public
- name: closedBeta
join-permission: simplecloud.join.closedbeta
full-join-permission: simplecloud.join.full.closedbeta
motd-layout-by-proxy: closed_beta
- name: maintenance
join-permission: simplecloud.join.maintenance
full-join-permission: simplecloud.join.full.maintenance
motd-layout-by-proxy: maintenance
```

## Placeholders

| Placeholder | MOTD | Tablist | Description |
|-------------------|------|----------|--------------------------------|
| %ONLINE_PLAYERS% | Yes | Yes | Current online players |
| %MAX_PLAYERS% | Yes | Yes | Maximum network players |
| %SERVER_NAME%| No | Yes | Player's current server |
| %CURRENT_TIME%| No | Yes | Current time |
| %CURRENT_DATE% | No | Yes | Current date |
| %PING% | No | Yes | Player's ping |
| \<online_players\> | Yes | Yes | Current online players |
| \<max_players\> | Yes | Yes | Maximum network players |
| \<date\>| Yes | Yes | Current date |
| \<env:NAME\> | Yes | Yes | Show the value |
| \<server_name\>| No | Yes | Player's current server |
| \<ping\> | No | Yes | Player's ping |

## API Integration

The plugin provides events for custom modifications:

<CodeGroup>
```java {{title: 'Tablist Event Example'}}
@Subscribe
public void onTablistConfiguration(TablistConfigurationEvent event) {
TablistConfiguration config = event.getTablistConfiguration();
<DangerNote>
The documentation will be available as soon as the API is ready and public
</DangerNote>

// Modify header
Component header = config.getHeader()
.replaceText(TextReplacementConfig.builder()
.match("%CUSTOM_PLACEHOLDER%")
.replacement("<red>Custom Text</red>")
.build());

config.setHeader(header);
}
```
</CodeGroup>
## Permissions
| **Permission** | **Description** |
|------------------------------|----------------------------------------------------------------------------------------------------|
| `simplecloud.command.joinstate.*` | Allows the user to use all joinstate commands. |
| `simplecloud.command.joinstate.help` | Allows the user to see the joinstate command help. |
| `simplecloud.command.joinstate.server` | Allows the user to set the joinstate for a server. |
| `simplecloud.command.joinstate.group.` | Allows the user to set the joinstate for a group and all servers in the group. |

## What's Next?

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat: update documentation#15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Dominic-Kaemereit merged 1 commit into from
Dec 22, 2024
Merged

feat: update documentation #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
120 changes: 74 additions & 46 deletions src/app/plugin/proxy-info/page.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import {Button} from "../../../components/Button";
import {CodeGroup} from "../../../components/Code";

export const metadata = {
title: 'Proxy Plugin',
title: 'Proxy Info Plugin',
description: 'Enhance your server network with customizable MOTD and Tablist features'
}

Expand DownExpand Up@@ -30,7 +30,6 @@ If you would like to add support for a missing server software, feel free to sub
1. Download the plugin for your proxy software
2. Place it in your proxy template's plugins folder
3. Start your proxy server
4. Configure using `messages.yml`, `tablist.yml` the layouts in `layout/your-layout.yml`

## Features

Expand All@@ -39,14 +38,11 @@ Our MOTD system supports multiple layouts that you can create in the `layout/` f

```yaml
first-lines:
- <gradient:#00fcff:#0da1a3><bold>SimpleCloud</bold></gradient> <dark_gray>»<gray>
Simplify your network <dark_gray>|<bold><#4595ff> 1.12<#545454> - <#4595ff>1.20</bold>
- <color:#0ea5e9>A simplecloud.app network
second-lines:
- '<dark_gray>× <#178fff>Status<dark_gray>: <bold><#22cc22>Online</bold> <dark_gray>-
<#ffffff>%PROXY%'
- ' '
player-info: []
version-name: ''
server-icon: server-icon.png
max-player-display-type: REAL #or DYNAMIC
dynamic-player-range: 1 #Only enabled if max-player-display-type is DYNAMIC
```
Expand All@@ -58,70 +54,102 @@ dynamic-player-range: 1 #Only enabled if max-player-display-type is DYNAMIC

Create engaging tablist headers and footers that update automatically. The plugin supports both static and animated content, with configurable update intervals. You can display real-time information like player counts, server status, or custom messages. All text supports MiniMessage formatting for advanced styling.

#### Configuration for static tablist
```yaml
groups:

- group-or-service: '*'
tab-lists:
- header:
- <dark_gray> <dark_gray>
- <aqua>SimpleCloud <dark_gray>» <gray>Simplify <white><italic>your</italic>
<gray>network
- <dark_aqua>Online <dark_gray>» <gray><online_players><dark_gray>/<gray><max_players>
<dark_gray>┃ <dark_aqua>Server <dark_gray>» <gray><server_name>
- <dark_gray>
- ''
- <color:#0ea5e9>SimpleCloud v3
- ''
footer:
- <dark_gray>
- <dark_aqua>Twitter <dark_gray>» <gray>@theSimpleCloud
- <dark_aqua>Discord <dark_gray>» <gray>discord.simplecloud.app
- <dark_gray>
- group-or-service: 'lobby'
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
tab-list-update-time: 0 #If set to 0, the tablist will not update, otherwise it will update every x milliseconds
```

#### Configuration for dynamic tablist
```yaml
groups:
- group-or-service: '*'
tab-lists:
- header:
- <white>Welcome back on %SERVER_NAME%
- ''
- <color:#0ea5e9>SimpleCloud v3
- 'Frame 1'
footer:
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
- header:
- ''
- <color:#0ea5e9>SimpleCloud v3
- 'Frame 2'
footer:
- <gray>%ONLINE_PLAYERS%<dark_gray>/<gray>%MAX_PLAYERS%
tab-list-update-time: 3000 #When 0, the tablist will no longer be updated afterward.
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
tab-list-update-time: 1000 #The 1000 is the update interval in milliseconds
```

### Joinstates

<DangerNote>
Documentation will be available in the coming days.
</DangerNote>
You can use joinstates to define which user groups are allowed to join the network. You can create or adjust the joinstates in the `joinstate.yml` file.
Depending on which joinstate is currently active for a group, the corresponding authorizations that you have defined in the configuration are applied.
You can define different joinstates for each server or group. The plugin supports MiniMessage formatting for the display of rich text content.

```yaml
default-state: public
join-states:
- name: public
join-permission: ''
full-join-permission: simplecloud.join.full.public
motd-layout-by-proxy: public
- name: closedBeta
join-permission: simplecloud.join.closedbeta
full-join-permission: simplecloud.join.full.closedbeta
motd-layout-by-proxy: closed_beta
- name: maintenance
join-permission: simplecloud.join.maintenance
full-join-permission: simplecloud.join.full.maintenance
motd-layout-by-proxy: maintenance
```

## Placeholders

| Placeholder | MOTD | Tablist | Description |
|-------------------|------|----------|--------------------------------|
| %ONLINE_PLAYERS% | Yes | Yes | Current online players |
| %MAX_PLAYERS% | Yes | Yes | Maximum network players |
| %SERVER_NAME%| No | Yes | Player's current server |
| %CURRENT_TIME%| No | Yes | Current time |
| %CURRENT_DATE% | No | Yes | Current date |
| %PING% | No | Yes | Player's ping |
| \<online_players\> | Yes | Yes | Current online players |
| \<max_players\> | Yes | Yes | Maximum network players |
| \<date\>| Yes | Yes | Current date |
| \<env:NAME\> | Yes | Yes | Show the value |
| \<server_name\>| No | Yes | Player's current server |
| \<ping\> | No | Yes | Player's ping |

## API Integration

The plugin provides events for custom modifications:

<CodeGroup>
```java {{title: 'Tablist Event Example'}}
@Subscribe
public void onTablistConfiguration(TablistConfigurationEvent event) {
TablistConfiguration config = event.getTablistConfiguration();
<DangerNote>
The documentation will be available as soon as the API is ready and public
</DangerNote>

// Modify header
Component header = config.getHeader()
.replaceText(TextReplacementConfig.builder()
.match("%CUSTOM_PLACEHOLDER%")
.replacement("<red>Custom Text</red>")
.build());

config.setHeader(header);
}
```
</CodeGroup>
## Permissions
| **Permission** | **Description** |
|------------------------------|----------------------------------------------------------------------------------------------------|
| `simplecloud.command.joinstate.*` | Allows the user to use all joinstate commands. |
| `simplecloud.command.joinstate.help` | Allows the user to see the joinstate command help. |
| `simplecloud.command.joinstate.server` | Allows the user to set the joinstate for a server. |
| `simplecloud.command.joinstate.group.` | Allows the user to set the joinstate for a group and all servers in the group. |

## What's Next?

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length \u003e 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

feat: update documentation#15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Dominic-Kaemereit merged 1 commit into from
Dec 22, 2024
Merged

feat: update documentation #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
120 changes: 74 additions & 46 deletions src/app/plugin/proxy-info/page.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import {Button} from "../../../components/Button";
import {CodeGroup} from "../../../components/Code";

export const metadata = {
title: 'Proxy Plugin',
title: 'Proxy Info Plugin',
description: 'Enhance your server network with customizable MOTD and Tablist features'
}

Expand DownExpand Up@@ -30,7 +30,6 @@ If you would like to add support for a missing server software, feel free to sub
1. Download the plugin for your proxy software
2. Place it in your proxy template's plugins folder
3. Start your proxy server
4. Configure using `messages.yml`, `tablist.yml` the layouts in `layout/your-layout.yml`

## Features

Expand All@@ -39,14 +38,11 @@ Our MOTD system supports multiple layouts that you can create in the `layout/` f

```yaml
first-lines:
- <gradient:#00fcff:#0da1a3><bold>SimpleCloud</bold></gradient> <dark_gray>»<gray>
Simplify your network <dark_gray>|<bold><#4595ff> 1.12<#545454> - <#4595ff>1.20</bold>
- <color:#0ea5e9>A simplecloud.app network
second-lines:
- '<dark_gray>× <#178fff>Status<dark_gray>: <bold><#22cc22>Online</bold> <dark_gray>-
<#ffffff>%PROXY%'
- ' '
player-info: []
version-name: ''
server-icon: server-icon.png
max-player-display-type: REAL #or DYNAMIC
dynamic-player-range: 1 #Only enabled if max-player-display-type is DYNAMIC
```
Expand All@@ -58,70 +54,102 @@ dynamic-player-range: 1 #Only enabled if max-player-display-type is DYNAMIC

Create engaging tablist headers and footers that update automatically. The plugin supports both static and animated content, with configurable update intervals. You can display real-time information like player counts, server status, or custom messages. All text supports MiniMessage formatting for advanced styling.

#### Configuration for static tablist
```yaml
groups:

- group-or-service: '*'
tab-lists:
- header:
- <dark_gray> <dark_gray>
- <aqua>SimpleCloud <dark_gray>» <gray>Simplify <white><italic>your</italic>
<gray>network
- <dark_aqua>Online <dark_gray>» <gray><online_players><dark_gray>/<gray><max_players>
<dark_gray>┃ <dark_aqua>Server <dark_gray>» <gray><server_name>
- <dark_gray>
- ''
- <color:#0ea5e9>SimpleCloud v3
- ''
footer:
- <dark_gray>
- <dark_aqua>Twitter <dark_gray>» <gray>@theSimpleCloud
- <dark_aqua>Discord <dark_gray>» <gray>discord.simplecloud.app
- <dark_gray>
- group-or-service: 'lobby'
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
tab-list-update-time: 0 #If set to 0, the tablist will not update, otherwise it will update every x milliseconds
```

#### Configuration for dynamic tablist
```yaml
groups:
- group-or-service: '*'
tab-lists:
- header:
- <white>Welcome back on %SERVER_NAME%
- ''
- <color:#0ea5e9>SimpleCloud v3
- 'Frame 1'
footer:
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
- header:
- ''
- <color:#0ea5e9>SimpleCloud v3
- 'Frame 2'
footer:
- <gray>%ONLINE_PLAYERS%<dark_gray>/<gray>%MAX_PLAYERS%
tab-list-update-time: 3000 #When 0, the tablist will no longer be updated afterward.
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
tab-list-update-time: 1000 #The 1000 is the update interval in milliseconds
```

### Joinstates

<DangerNote>
Documentation will be available in the coming days.
</DangerNote>
You can use joinstates to define which user groups are allowed to join the network. You can create or adjust the joinstates in the `joinstate.yml` file.
Depending on which joinstate is currently active for a group, the corresponding authorizations that you have defined in the configuration are applied.
You can define different joinstates for each server or group. The plugin supports MiniMessage formatting for the display of rich text content.

```yaml
default-state: public
join-states:
- name: public
join-permission: ''
full-join-permission: simplecloud.join.full.public
motd-layout-by-proxy: public
- name: closedBeta
join-permission: simplecloud.join.closedbeta
full-join-permission: simplecloud.join.full.closedbeta
motd-layout-by-proxy: closed_beta
- name: maintenance
join-permission: simplecloud.join.maintenance
full-join-permission: simplecloud.join.full.maintenance
motd-layout-by-proxy: maintenance
```

## Placeholders

| Placeholder | MOTD | Tablist | Description |
|-------------------|------|----------|--------------------------------|
| %ONLINE_PLAYERS% | Yes | Yes | Current online players |
| %MAX_PLAYERS% | Yes | Yes | Maximum network players |
| %SERVER_NAME%| No | Yes | Player's current server |
| %CURRENT_TIME%| No | Yes | Current time |
| %CURRENT_DATE% | No | Yes | Current date |
| %PING% | No | Yes | Player's ping |
| \<online_players\> | Yes | Yes | Current online players |
| \<max_players\> | Yes | Yes | Maximum network players |
| \<date\>| Yes | Yes | Current date |
| \<env:NAME\> | Yes | Yes | Show the value |
| \<server_name\>| No | Yes | Player's current server |
| \<ping\> | No | Yes | Player's ping |

## API Integration

The plugin provides events for custom modifications:

<CodeGroup>
```java {{title: 'Tablist Event Example'}}
@Subscribe
public void onTablistConfiguration(TablistConfigurationEvent event) {
TablistConfiguration config = event.getTablistConfiguration();
<DangerNote>
The documentation will be available as soon as the API is ready and public
</DangerNote>

// Modify header
Component header = config.getHeader()
.replaceText(TextReplacementConfig.builder()
.match("%CUSTOM_PLACEHOLDER%")
.replacement("<red>Custom Text</red>")
.build());

config.setHeader(header);
}
```
</CodeGroup>
## Permissions
| **Permission** | **Description** |
|------------------------------|----------------------------------------------------------------------------------------------------|
| `simplecloud.command.joinstate.*` | Allows the user to use all joinstate commands. |
| `simplecloud.command.joinstate.help` | Allows the user to see the joinstate command help. |
| `simplecloud.command.joinstate.server` | Allows the user to set the joinstate for a server. |
| `simplecloud.command.joinstate.group.` | Allows the user to set the joinstate for a group and all servers in the group. |

## What's Next?

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

feat: update documentation#15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Dominic-Kaemereit merged 1 commit into from
Dec 22, 2024
Merged

feat: update documentation #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
120 changes: 74 additions & 46 deletions src/app/plugin/proxy-info/page.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import {Button} from "../../../components/Button";
import {CodeGroup} from "../../../components/Code";

export const metadata = {
title: 'Proxy Plugin',
title: 'Proxy Info Plugin',
description: 'Enhance your server network with customizable MOTD and Tablist features'
}

Expand DownExpand Up@@ -30,7 +30,6 @@ If you would like to add support for a missing server software, feel free to sub
1. Download the plugin for your proxy software
2. Place it in your proxy template's plugins folder
3. Start your proxy server
4. Configure using `messages.yml`, `tablist.yml` the layouts in `layout/your-layout.yml`

## Features

Expand All@@ -39,14 +38,11 @@ Our MOTD system supports multiple layouts that you can create in the `layout/` f

```yaml
first-lines:
- <gradient:#00fcff:#0da1a3><bold>SimpleCloud</bold></gradient> <dark_gray>»<gray>
Simplify your network <dark_gray>|<bold><#4595ff> 1.12<#545454> - <#4595ff>1.20</bold>
- <color:#0ea5e9>A simplecloud.app network
second-lines:
- '<dark_gray>× <#178fff>Status<dark_gray>: <bold><#22cc22>Online</bold> <dark_gray>-
<#ffffff>%PROXY%'
- ' '
player-info: []
version-name: ''
server-icon: server-icon.png
max-player-display-type: REAL #or DYNAMIC
dynamic-player-range: 1 #Only enabled if max-player-display-type is DYNAMIC
```
Expand All@@ -58,70 +54,102 @@ dynamic-player-range: 1 #Only enabled if max-player-display-type is DYNAMIC

Create engaging tablist headers and footers that update automatically. The plugin supports both static and animated content, with configurable update intervals. You can display real-time information like player counts, server status, or custom messages. All text supports MiniMessage formatting for advanced styling.

#### Configuration for static tablist
```yaml
groups:

- group-or-service: '*'
tab-lists:
- header:
- <dark_gray> <dark_gray>
- <aqua>SimpleCloud <dark_gray>» <gray>Simplify <white><italic>your</italic>
<gray>network
- <dark_aqua>Online <dark_gray>» <gray><online_players><dark_gray>/<gray><max_players>
<dark_gray>┃ <dark_aqua>Server <dark_gray>» <gray><server_name>
- <dark_gray>
- ''
- <color:#0ea5e9>SimpleCloud v3
- ''
footer:
- <dark_gray>
- <dark_aqua>Twitter <dark_gray>» <gray>@theSimpleCloud
- <dark_aqua>Discord <dark_gray>» <gray>discord.simplecloud.app
- <dark_gray>
- group-or-service: 'lobby'
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
tab-list-update-time: 0 #If set to 0, the tablist will not update, otherwise it will update every x milliseconds
```

#### Configuration for dynamic tablist
```yaml
groups:
- group-or-service: '*'
tab-lists:
- header:
- <white>Welcome back on %SERVER_NAME%
- ''
- <color:#0ea5e9>SimpleCloud v3
- 'Frame 1'
footer:
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
- header:
- ''
- <color:#0ea5e9>SimpleCloud v3
- 'Frame 2'
footer:
- <gray>%ONLINE_PLAYERS%<dark_gray>/<gray>%MAX_PLAYERS%
tab-list-update-time: 3000 #When 0, the tablist will no longer be updated afterward.
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
tab-list-update-time: 1000 #The 1000 is the update interval in milliseconds
```

### Joinstates

<DangerNote>
Documentation will be available in the coming days.
</DangerNote>
You can use joinstates to define which user groups are allowed to join the network. You can create or adjust the joinstates in the `joinstate.yml` file.
Depending on which joinstate is currently active for a group, the corresponding authorizations that you have defined in the configuration are applied.
You can define different joinstates for each server or group. The plugin supports MiniMessage formatting for the display of rich text content.

```yaml
default-state: public
join-states:
- name: public
join-permission: ''
full-join-permission: simplecloud.join.full.public
motd-layout-by-proxy: public
- name: closedBeta
join-permission: simplecloud.join.closedbeta
full-join-permission: simplecloud.join.full.closedbeta
motd-layout-by-proxy: closed_beta
- name: maintenance
join-permission: simplecloud.join.maintenance
full-join-permission: simplecloud.join.full.maintenance
motd-layout-by-proxy: maintenance
```

## Placeholders

| Placeholder | MOTD | Tablist | Description |
|-------------------|------|----------|--------------------------------|
| %ONLINE_PLAYERS% | Yes | Yes | Current online players |
| %MAX_PLAYERS% | Yes | Yes | Maximum network players |
| %SERVER_NAME%| No | Yes | Player's current server |
| %CURRENT_TIME%| No | Yes | Current time |
| %CURRENT_DATE% | No | Yes | Current date |
| %PING% | No | Yes | Player's ping |
| \<online_players\> | Yes | Yes | Current online players |
| \<max_players\> | Yes | Yes | Maximum network players |
| \<date\>| Yes | Yes | Current date |
| \<env:NAME\> | Yes | Yes | Show the value |
| \<server_name\>| No | Yes | Player's current server |
| \<ping\> | No | Yes | Player's ping |

## API Integration

The plugin provides events for custom modifications:

<CodeGroup>
```java {{title: 'Tablist Event Example'}}
@Subscribe
public void onTablistConfiguration(TablistConfigurationEvent event) {
TablistConfiguration config = event.getTablistConfiguration();
<DangerNote>
The documentation will be available as soon as the API is ready and public
</DangerNote>

// Modify header
Component header = config.getHeader()
.replaceText(TextReplacementConfig.builder()
.match("%CUSTOM_PLACEHOLDER%")
.replacement("<red>Custom Text</red>")
.build());

config.setHeader(header);
}
```
</CodeGroup>
## Permissions
| **Permission** | **Description** |
|------------------------------|----------------------------------------------------------------------------------------------------|
| `simplecloud.command.joinstate.*` | Allows the user to use all joinstate commands. |
| `simplecloud.command.joinstate.help` | Allows the user to see the joinstate command help. |
| `simplecloud.command.joinstate.server` | Allows the user to set the joinstate for a server. |
| `simplecloud.command.joinstate.group.` | Allows the user to set the joinstate for a group and all servers in the group. |

## What's Next?

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat: update documentation#15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Dominic-Kaemereit merged 1 commit into from
Dec 22, 2024
Merged

feat: update documentation #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
120 changes: 74 additions & 46 deletions src/app/plugin/proxy-info/page.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import {Button} from "../../../components/Button";
import {CodeGroup} from "../../../components/Code";

export const metadata = {
title: 'Proxy Plugin',
title: 'Proxy Info Plugin',
description: 'Enhance your server network with customizable MOTD and Tablist features'
}

Expand DownExpand Up@@ -30,7 +30,6 @@ If you would like to add support for a missing server software, feel free to sub
1. Download the plugin for your proxy software
2. Place it in your proxy template's plugins folder
3. Start your proxy server
4. Configure using `messages.yml`, `tablist.yml` the layouts in `layout/your-layout.yml`

## Features

Expand All@@ -39,14 +38,11 @@ Our MOTD system supports multiple layouts that you can create in the `layout/` f

```yaml
first-lines:
- <gradient:#00fcff:#0da1a3><bold>SimpleCloud</bold></gradient> <dark_gray>»<gray>
Simplify your network <dark_gray>|<bold><#4595ff> 1.12<#545454> - <#4595ff>1.20</bold>
- <color:#0ea5e9>A simplecloud.app network
second-lines:
- '<dark_gray>× <#178fff>Status<dark_gray>: <bold><#22cc22>Online</bold> <dark_gray>-
<#ffffff>%PROXY%'
- ' '
player-info: []
version-name: ''
server-icon: server-icon.png
max-player-display-type: REAL #or DYNAMIC
dynamic-player-range: 1 #Only enabled if max-player-display-type is DYNAMIC
```
Expand All@@ -58,70 +54,102 @@ dynamic-player-range: 1 #Only enabled if max-player-display-type is DYNAMIC

Create engaging tablist headers and footers that update automatically. The plugin supports both static and animated content, with configurable update intervals. You can display real-time information like player counts, server status, or custom messages. All text supports MiniMessage formatting for advanced styling.

#### Configuration for static tablist
```yaml
groups:

- group-or-service: '*'
tab-lists:
- header:
- <dark_gray> <dark_gray>
- <aqua>SimpleCloud <dark_gray>» <gray>Simplify <white><italic>your</italic>
<gray>network
- <dark_aqua>Online <dark_gray>» <gray><online_players><dark_gray>/<gray><max_players>
<dark_gray>┃ <dark_aqua>Server <dark_gray>» <gray><server_name>
- <dark_gray>
- ''
- <color:#0ea5e9>SimpleCloud v3
- ''
footer:
- <dark_gray>
- <dark_aqua>Twitter <dark_gray>» <gray>@theSimpleCloud
- <dark_aqua>Discord <dark_gray>» <gray>discord.simplecloud.app
- <dark_gray>
- group-or-service: 'lobby'
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
tab-list-update-time: 0 #If set to 0, the tablist will not update, otherwise it will update every x milliseconds
```

#### Configuration for dynamic tablist
```yaml
groups:
- group-or-service: '*'
tab-lists:
- header:
- <white>Welcome back on %SERVER_NAME%
- ''
- <color:#0ea5e9>SimpleCloud v3
- 'Frame 1'
footer:
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
- header:
- ''
- <color:#0ea5e9>SimpleCloud v3
- 'Frame 2'
footer:
- <gray>%ONLINE_PLAYERS%<dark_gray>/<gray>%MAX_PLAYERS%
tab-list-update-time: 3000 #When 0, the tablist will no longer be updated afterward.
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
tab-list-update-time: 1000 #The 1000 is the update interval in milliseconds
```

### Joinstates

<DangerNote>
Documentation will be available in the coming days.
</DangerNote>
You can use joinstates to define which user groups are allowed to join the network. You can create or adjust the joinstates in the `joinstate.yml` file.
Depending on which joinstate is currently active for a group, the corresponding authorizations that you have defined in the configuration are applied.
You can define different joinstates for each server or group. The plugin supports MiniMessage formatting for the display of rich text content.

```yaml
default-state: public
join-states:
- name: public
join-permission: ''
full-join-permission: simplecloud.join.full.public
motd-layout-by-proxy: public
- name: closedBeta
join-permission: simplecloud.join.closedbeta
full-join-permission: simplecloud.join.full.closedbeta
motd-layout-by-proxy: closed_beta
- name: maintenance
join-permission: simplecloud.join.maintenance
full-join-permission: simplecloud.join.full.maintenance
motd-layout-by-proxy: maintenance
```

## Placeholders

| Placeholder | MOTD | Tablist | Description |
|-------------------|------|----------|--------------------------------|
| %ONLINE_PLAYERS% | Yes | Yes | Current online players |
| %MAX_PLAYERS% | Yes | Yes | Maximum network players |
| %SERVER_NAME%| No | Yes | Player's current server |
| %CURRENT_TIME%| No | Yes | Current time |
| %CURRENT_DATE% | No | Yes | Current date |
| %PING% | No | Yes | Player's ping |
| \<online_players\> | Yes | Yes | Current online players |
| \<max_players\> | Yes | Yes | Maximum network players |
| \<date\>| Yes | Yes | Current date |
| \<env:NAME\> | Yes | Yes | Show the value |
| \<server_name\>| No | Yes | Player's current server |
| \<ping\> | No | Yes | Player's ping |

## API Integration

The plugin provides events for custom modifications:

<CodeGroup>
```java {{title: 'Tablist Event Example'}}
@Subscribe
public void onTablistConfiguration(TablistConfigurationEvent event) {
TablistConfiguration config = event.getTablistConfiguration();
<DangerNote>
The documentation will be available as soon as the API is ready and public
</DangerNote>

// Modify header
Component header = config.getHeader()
.replaceText(TextReplacementConfig.builder()
.match("%CUSTOM_PLACEHOLDER%")
.replacement("<red>Custom Text</red>")
.build());

config.setHeader(header);
}
```
</CodeGroup>
## Permissions
| **Permission** | **Description** |
|------------------------------|----------------------------------------------------------------------------------------------------|
| `simplecloud.command.joinstate.*` | Allows the user to use all joinstate commands. |
| `simplecloud.command.joinstate.help` | Allows the user to see the joinstate command help. |
| `simplecloud.command.joinstate.server` | Allows the user to set the joinstate for a server. |
| `simplecloud.command.joinstate.group.` | Allows the user to set the joinstate for a group and all servers in the group. |

## What's Next?

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat: update documentation#15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Dominic-Kaemereit merged 1 commit into from
Dec 22, 2024
Merged

feat: update documentation #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
120 changes: 74 additions & 46 deletions src/app/plugin/proxy-info/page.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import {Button} from "../../../components/Button";
import {CodeGroup} from "../../../components/Code";

export const metadata = {
title: 'Proxy Plugin',
title: 'Proxy Info Plugin',
description: 'Enhance your server network with customizable MOTD and Tablist features'
}

Expand DownExpand Up@@ -30,7 +30,6 @@ If you would like to add support for a missing server software, feel free to sub
1. Download the plugin for your proxy software
2. Place it in your proxy template's plugins folder
3. Start your proxy server
4. Configure using `messages.yml`, `tablist.yml` the layouts in `layout/your-layout.yml`

## Features

Expand All@@ -39,14 +38,11 @@ Our MOTD system supports multiple layouts that you can create in the `layout/` f

```yaml
first-lines:
- <gradient:#00fcff:#0da1a3><bold>SimpleCloud</bold></gradient> <dark_gray>»<gray>
Simplify your network <dark_gray>|<bold><#4595ff> 1.12<#545454> - <#4595ff>1.20</bold>
- <color:#0ea5e9>A simplecloud.app network
second-lines:
- '<dark_gray>× <#178fff>Status<dark_gray>: <bold><#22cc22>Online</bold> <dark_gray>-
<#ffffff>%PROXY%'
- ' '
player-info: []
version-name: ''
server-icon: server-icon.png
max-player-display-type: REAL #or DYNAMIC
dynamic-player-range: 1 #Only enabled if max-player-display-type is DYNAMIC
```
Expand All@@ -58,70 +54,102 @@ dynamic-player-range: 1 #Only enabled if max-player-display-type is DYNAMIC

Create engaging tablist headers and footers that update automatically. The plugin supports both static and animated content, with configurable update intervals. You can display real-time information like player counts, server status, or custom messages. All text supports MiniMessage formatting for advanced styling.

#### Configuration for static tablist
```yaml
groups:

- group-or-service: '*'
tab-lists:
- header:
- <dark_gray> <dark_gray>
- <aqua>SimpleCloud <dark_gray>» <gray>Simplify <white><italic>your</italic>
<gray>network
- <dark_aqua>Online <dark_gray>» <gray><online_players><dark_gray>/<gray><max_players>
<dark_gray>┃ <dark_aqua>Server <dark_gray>» <gray><server_name>
- <dark_gray>
- ''
- <color:#0ea5e9>SimpleCloud v3
- ''
footer:
- <dark_gray>
- <dark_aqua>Twitter <dark_gray>» <gray>@theSimpleCloud
- <dark_aqua>Discord <dark_gray>» <gray>discord.simplecloud.app
- <dark_gray>
- group-or-service: 'lobby'
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
tab-list-update-time: 0 #If set to 0, the tablist will not update, otherwise it will update every x milliseconds
```

#### Configuration for dynamic tablist
```yaml
groups:
- group-or-service: '*'
tab-lists:
- header:
- <white>Welcome back on %SERVER_NAME%
- ''
- <color:#0ea5e9>SimpleCloud v3
- 'Frame 1'
footer:
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
- header:
- ''
- <color:#0ea5e9>SimpleCloud v3
- 'Frame 2'
footer:
- <gray>%ONLINE_PLAYERS%<dark_gray>/<gray>%MAX_PLAYERS%
tab-list-update-time: 3000 #When 0, the tablist will no longer be updated afterward.
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
tab-list-update-time: 1000 #The 1000 is the update interval in milliseconds
```

### Joinstates

<DangerNote>
Documentation will be available in the coming days.
</DangerNote>
You can use joinstates to define which user groups are allowed to join the network. You can create or adjust the joinstates in the `joinstate.yml` file.
Depending on which joinstate is currently active for a group, the corresponding authorizations that you have defined in the configuration are applied.
You can define different joinstates for each server or group. The plugin supports MiniMessage formatting for the display of rich text content.

```yaml
default-state: public
join-states:
- name: public
join-permission: ''
full-join-permission: simplecloud.join.full.public
motd-layout-by-proxy: public
- name: closedBeta
join-permission: simplecloud.join.closedbeta
full-join-permission: simplecloud.join.full.closedbeta
motd-layout-by-proxy: closed_beta
- name: maintenance
join-permission: simplecloud.join.maintenance
full-join-permission: simplecloud.join.full.maintenance
motd-layout-by-proxy: maintenance
```

## Placeholders

| Placeholder | MOTD | Tablist | Description |
|-------------------|------|----------|--------------------------------|
| %ONLINE_PLAYERS% | Yes | Yes | Current online players |
| %MAX_PLAYERS% | Yes | Yes | Maximum network players |
| %SERVER_NAME%| No | Yes | Player's current server |
| %CURRENT_TIME%| No | Yes | Current time |
| %CURRENT_DATE% | No | Yes | Current date |
| %PING% | No | Yes | Player's ping |
| \<online_players\> | Yes | Yes | Current online players |
| \<max_players\> | Yes | Yes | Maximum network players |
| \<date\>| Yes | Yes | Current date |
| \<env:NAME\> | Yes | Yes | Show the value |
| \<server_name\>| No | Yes | Player's current server |
| \<ping\> | No | Yes | Player's ping |

## API Integration

The plugin provides events for custom modifications:

<CodeGroup>
```java {{title: 'Tablist Event Example'}}
@Subscribe
public void onTablistConfiguration(TablistConfigurationEvent event) {
TablistConfiguration config = event.getTablistConfiguration();
<DangerNote>
The documentation will be available as soon as the API is ready and public
</DangerNote>

// Modify header
Component header = config.getHeader()
.replaceText(TextReplacementConfig.builder()
.match("%CUSTOM_PLACEHOLDER%")
.replacement("<red>Custom Text</red>")
.build());

config.setHeader(header);
}
```
</CodeGroup>
## Permissions
| **Permission** | **Description** |
|------------------------------|----------------------------------------------------------------------------------------------------|
| `simplecloud.command.joinstate.*` | Allows the user to use all joinstate commands. |
| `simplecloud.command.joinstate.help` | Allows the user to see the joinstate command help. |
| `simplecloud.command.joinstate.server` | Allows the user to set the joinstate for a server. |
| `simplecloud.command.joinstate.group.` | Allows the user to set the joinstate for a group and all servers in the group. |

## What's Next?

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

feat: update documentation#15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Dominic-Kaemereit merged 1 commit into from
Dec 22, 2024
Merged

feat: update documentation #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
120 changes: 74 additions & 46 deletions src/app/plugin/proxy-info/page.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import {Button} from "../../../components/Button";
import {CodeGroup} from "../../../components/Code";

export const metadata = {
title: 'Proxy Plugin',
title: 'Proxy Info Plugin',
description: 'Enhance your server network with customizable MOTD and Tablist features'
}

Expand DownExpand Up@@ -30,7 +30,6 @@ If you would like to add support for a missing server software, feel free to sub
1. Download the plugin for your proxy software
2. Place it in your proxy template's plugins folder
3. Start your proxy server
4. Configure using `messages.yml`, `tablist.yml` the layouts in `layout/your-layout.yml`

## Features

Expand All@@ -39,14 +38,11 @@ Our MOTD system supports multiple layouts that you can create in the `layout/` f

```yaml
first-lines:
- <gradient:#00fcff:#0da1a3><bold>SimpleCloud</bold></gradient> <dark_gray>»<gray>
Simplify your network <dark_gray>|<bold><#4595ff> 1.12<#545454> - <#4595ff>1.20</bold>
- <color:#0ea5e9>A simplecloud.app network
second-lines:
- '<dark_gray>× <#178fff>Status<dark_gray>: <bold><#22cc22>Online</bold> <dark_gray>-
<#ffffff>%PROXY%'
- ' '
player-info: []
version-name: ''
server-icon: server-icon.png
max-player-display-type: REAL #or DYNAMIC
dynamic-player-range: 1 #Only enabled if max-player-display-type is DYNAMIC
```
Expand All@@ -58,70 +54,102 @@ dynamic-player-range: 1 #Only enabled if max-player-display-type is DYNAMIC

Create engaging tablist headers and footers that update automatically. The plugin supports both static and animated content, with configurable update intervals. You can display real-time information like player counts, server status, or custom messages. All text supports MiniMessage formatting for advanced styling.

#### Configuration for static tablist
```yaml
groups:

- group-or-service: '*'
tab-lists:
- header:
- <dark_gray> <dark_gray>
- <aqua>SimpleCloud <dark_gray>» <gray>Simplify <white><italic>your</italic>
<gray>network
- <dark_aqua>Online <dark_gray>» <gray><online_players><dark_gray>/<gray><max_players>
<dark_gray>┃ <dark_aqua>Server <dark_gray>» <gray><server_name>
- <dark_gray>
- ''
- <color:#0ea5e9>SimpleCloud v3
- ''
footer:
- <dark_gray>
- <dark_aqua>Twitter <dark_gray>» <gray>@theSimpleCloud
- <dark_aqua>Discord <dark_gray>» <gray>discord.simplecloud.app
- <dark_gray>
- group-or-service: 'lobby'
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
tab-list-update-time: 0 #If set to 0, the tablist will not update, otherwise it will update every x milliseconds
```

#### Configuration for dynamic tablist
```yaml
groups:
- group-or-service: '*'
tab-lists:
- header:
- <white>Welcome back on %SERVER_NAME%
- ''
- <color:#0ea5e9>SimpleCloud v3
- 'Frame 1'
footer:
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
- header:
- ''
- <color:#0ea5e9>SimpleCloud v3
- 'Frame 2'
footer:
- <gray>%ONLINE_PLAYERS%<dark_gray>/<gray>%MAX_PLAYERS%
tab-list-update-time: 3000 #When 0, the tablist will no longer be updated afterward.
- ''
- ' <color:#ffffff><online_players> players <color:#cbd5e1>are playing on
your network '
- <color:#64748b> sɪᴍᴘʟᴇᴄʟᴏᴜᴅ.ᴀᴘᴘ
- ''
tab-list-update-time: 1000 #The 1000 is the update interval in milliseconds
```

### Joinstates

<DangerNote>
Documentation will be available in the coming days.
</DangerNote>
You can use joinstates to define which user groups are allowed to join the network. You can create or adjust the joinstates in the `joinstate.yml` file.
Depending on which joinstate is currently active for a group, the corresponding authorizations that you have defined in the configuration are applied.
You can define different joinstates for each server or group. The plugin supports MiniMessage formatting for the display of rich text content.

```yaml
default-state: public
join-states:
- name: public
join-permission: ''
full-join-permission: simplecloud.join.full.public
motd-layout-by-proxy: public
- name: closedBeta
join-permission: simplecloud.join.closedbeta
full-join-permission: simplecloud.join.full.closedbeta
motd-layout-by-proxy: closed_beta
- name: maintenance
join-permission: simplecloud.join.maintenance
full-join-permission: simplecloud.join.full.maintenance
motd-layout-by-proxy: maintenance
```

## Placeholders

| Placeholder | MOTD | Tablist | Description |
|-------------------|------|----------|--------------------------------|
| %ONLINE_PLAYERS% | Yes | Yes | Current online players |
| %MAX_PLAYERS% | Yes | Yes | Maximum network players |
| %SERVER_NAME%| No | Yes | Player's current server |
| %CURRENT_TIME%| No | Yes | Current time |
| %CURRENT_DATE% | No | Yes | Current date |
| %PING% | No | Yes | Player's ping |
| \<online_players\> | Yes | Yes | Current online players |
| \<max_players\> | Yes | Yes | Maximum network players |
| \<date\>| Yes | Yes | Current date |
| \<env:NAME\> | Yes | Yes | Show the value |
| \<server_name\>| No | Yes | Player's current server |
| \<ping\> | No | Yes | Player's ping |

## API Integration

The plugin provides events for custom modifications:

<CodeGroup>
```java {{title: 'Tablist Event Example'}}
@Subscribe
public void onTablistConfiguration(TablistConfigurationEvent event) {
TablistConfiguration config = event.getTablistConfiguration();
<DangerNote>
The documentation will be available as soon as the API is ready and public
</DangerNote>

// Modify header
Component header = config.getHeader()
.replaceText(TextReplacementConfig.builder()
.match("%CUSTOM_PLACEHOLDER%")
.replacement("<red>Custom Text</red>")
.build());

config.setHeader(header);
}
```
</CodeGroup>
## Permissions
| **Permission** | **Description** |
|------------------------------|----------------------------------------------------------------------------------------------------|
| `simplecloud.command.joinstate.*` | Allows the user to use all joinstate commands. |
| `simplecloud.command.joinstate.help` | Allows the user to see the joinstate command help. |
| `simplecloud.command.joinstate.server` | Allows the user to set the joinstate for a server. |
| `simplecloud.command.joinstate.group.` | Allows the user to set the joinstate for a group and all servers in the group. |

## What's Next?

Expand Down