Develop#21

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
egyboyy merged 9 commits into from
Jan 1, 2025
Merged

Develop #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d4715cb
ref: update npc commands table
niklasnieberler Dec 27, 2024
df021c0
ref: add npc quick_join action
niklasnieberler Dec 28, 2024
8fc51f3
fix: remove unicode
niklasnieberler Dec 28, 2024
5240093
ref: update placeholder in npc page
niklasnieberler Dec 29, 2024
59ea763
refactor: dashboard login instructions
egyboyy Dec 30, 2024
95829f1
fix: dashboard overview screenshot
egyboyy Dec 30, 2024
abb1b4b
ref: update placeholder page
niklasnieberler Dec 31, 2024
7d6da54
Merge remote-tracking branch 'origin/develop' into develop
niklasnieberler Dec 31, 2024
dcf86b1
ref: update npc commands in npc page
niklasnieberler Dec 31, 2024
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
28 changes: 25 additions & 3 deletions src/app/dashboard/page.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,16 @@ export const metadata = {
# Dashboard
The dashboard offers a user-friendly and efficient interface for managing all essential cloud functions, streamlining operations and enhancing productivity.

<img
src={"https://github.com/simplecloudapp/branding/blob/main/media/dashboard/overview.png?raw=true"}
alt=""
className="w-full object-cover"
style={{
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
}}
/>

## Understanding the Dashboard
The dashboard is a web application that, like the [CLI](/cli), allows you to manage your cloud instance.
It serves solely as an interface that sends commands to the controller or droplets and retrieves information.
Expand All@@ -26,10 +36,22 @@ Upcoming Features:


## Login
<Note>
Work in Progress
</Note>

For anyone who doesn't want to install the dashboard on their own machine, feel free to use the dashboard we host ourselves.

<img
src={"https://github.com/simplecloudapp/branding/blob/main/media/dashboard/login.png?raw=true"}
alt=""
className="w-full aspect-video object-cover"
style={{
borderRadius: '1rem',
border: '1px solid rgba(255, 255, 255, 0.1)',
}}
/>

1. Go to [dashboard.simplecloud.app](http://dashboard.simplecloud.app)
2. Enter your controller endpoint, including your IP and port 8080 (Example: `187.420.69:8080`)
3. Enter your controller secret, which you can find under `/components/.secrets/auth.secret`

## Installing the Dashboard

Expand Down
24 changes: 12 additions & 12 deletions src/app/plugin/npcs/page.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,14 +55,14 @@ Actions allow you to interact with NPCs and set the trigger of an action individ
Each action has its own option with which you can customise it. Exactly as required for your NPC.
Here you will find all available actions and their options:

| Action | Option | Description |
|--------------------- | ---------------------- | ------------------------------------------------------------|
| `open_inventory` | inventory.name | Open an inventory to select a server |
| `run_command` | command.name | Execute a command via the player |
| `run_console_command` | command.name | Execute a command via the console |
| `connect_to_server` | server.name | Send a player to a server |
| `transfer_to_server` | server.ip, server.port | Send a player to an external server with the transfer method |

| Action | Option | Description |
|-----------------------|---------------------------------------------------------------------------|--------------------------------------------------------------|
| `open_inventory` | inventory.name | Open an inventory to select a server |
| `run_command` | command.name | Execute a command via the player |
| `run_console_command` | command.name | Execute a command via the console |
| `connect_to_server` | server.name | Send a player to a server |
| `transfer_to_server` | server.ip, server.port | Send a player to an external server with the transfer method |
| `quick_join` | group.name, server.name.pattern, filter.player.count, filter.server.state | Send a player to an random server |

## Creating a NPC

Expand DownExpand Up@@ -212,7 +212,7 @@ items:
material: LIME_BANNER
display-name: <group_name> <numerical_id>
lores:
- "<gray>Players: <#38bdf8><player_count><dark_gray><dark_gray>/<#38bdf8><max_players>"
- "<gray>Players: <#38bdf8><online_players><dark_gray><dark_gray>/<#38bdf8><max_players>"
- ""
- "<gray>Version: <#a3a3a3><property:server-software> <property:minecraft-version>"
- "<gray>Template: <#a3a3a3><property:template-id>"
Expand All@@ -234,18 +234,18 @@ items:
## Commands
| Command | Description |
|----------------------------------------------------------|-----------------------------------------------------------|
| `/scnpc create <name>` | Create a NPC with our own NPC implementation |
| `/scnpc apply <name>` | Create a NPC with our own NPC implementation |
| `/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` |
| `/scnpc <id> setOption <key> <value>` | Set global options |
| `/scnpc <id> removeOption <key> <value>` | Remove global options |
| `/scnpc <id> setHologramGroup <groupName>` | Set the Group for the Hologram Placeholders |
| `/scnpc createInventory <name>` | Create a new Inventory Configuration |
| `/scnpc createInventory <name> <groupName>` | Create a new Inventory Configuration |

## Permissions
| Permission | Description |
|------------------------- | --------------------|
|---------------------------|----------------------|
| `simplecloud.command.npc` | For `/scnps` Command |

## What's Next?
Expand Down
42 changes: 21 additions & 21 deletions src/app/plugin/placeholder/page.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,29 +39,29 @@ The following table shows all currently supported server implementations:
You can use the parameters of the current server and the group to which the server belongs as placeholders.

### Server Placeholder
| Placeholder | Description |
|-----------------------|--------------------------------------------------------------------------------|
| %server_id% | Unique identifier (e.g., "0f0c2d1a-d7d5-4c7f-b7a9-c0e8e9b5a6b8") |
| %server_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %server_state% | Server state (UNKNOWN_STATE, PREPARING, STARTING, AVAILABLE, INGAME, STOPPING) |
| %server_host% | Host machine identifier |
| %server_numerical_id% | Numerical ID within group |
| %server_ip% | Server IP address |
| %server_port% | Server port |
| %server_max_players% | Maximum allowed players |
| %server_min_memory% | Minimum RAM allocation in MB |
| %server_max_memory% | Maximum RAM allocation in MB |
| %server_player_count% | Current player count |
| Placeholder | Description |
|-----------------------------------|--------------------------------------------------------------------------------|
| %simplecloud_server_id% | Unique identifier (e.g., "0f0c2d1a-d7d5-4c7f-b7a9-c0e8e9b5a6b8") |
| %simplecloud_server_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %simplecloud_server_state% | Server state (UNKNOWN_STATE, PREPARING, STARTING, AVAILABLE, INGAME, STOPPING) |
| %simplecloud_server_host% | Host machine identifier |
| %simplecloud_server_numerical_id% | Numerical ID within group |
| %simplecloud_server_ip% | Server IP address |
| %simplecloud_server_port% | Server port |
| %simplecloud_server_max_players% | Maximum allowed players |
| %simplecloud_server_min_memory% | Minimum RAM allocation in MB |
| %simplecloud_server_max_memory% | Maximum RAM allocation in MB |
| %simplecloud_server_player_count% | Current player count |

### Group Placeholder
| Placeholder | Description |
|----------------------|---------------------------------------------|
| %group_name% | Unique identifier for the group |
| %group_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %group_min_memory% | Minimum RAM allocation in MB |
| %group_max_memory% | Maximum RAM allocation in MB |
| %group_max_players% | Maximum players per server |
| %group_player_count% | Current players count |
| Placeholder | Description |
|----------------------------------|---------------------------------------------|
| %simplecloud_group_name% | Unique identifier for the group |
| %simplecloud_group_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %simplecloud_group_min_memory% | Minimum RAM allocation in MB |
| %simplecloud_group_max_memory% | Maximum RAM allocation in MB |
| %simplecloud_group_max_players% | Maximum players per server |
| %simplecloud_group_player_count% | Current players count |

## What's Next?

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Develop#21

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

egyboyy
merged 9 commits into

from

Jan 1, 2025
 Merged


Develop
#21
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
d4715cb

ref: update npc commands table


niklasnieberler Dec 27, 2024
df021c0

ref: add npc quick_join action


niklasnieberler Dec 28, 2024
8fc51f3

fix: remove unicode


niklasnieberler Dec 28, 2024
5240093

ref: update placeholder in npc page


niklasnieberler Dec 29, 2024
59ea763

refactor: dashboard login instructions


egyboyy Dec 30, 2024
95829f1

fix: dashboard overview screenshot


egyboyy Dec 30, 2024
abb1b4b

ref: update placeholder page


niklasnieberler Dec 31, 2024
7d6da54

Merge remote-tracking branch 'origin/develop' into develop


niklasnieberler Dec 31, 2024
dcf86b1

ref: update npc commands in npc page


niklasnieberler Dec 31, 2024

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


28 changes: 25 additions & 3 deletions
src/app/dashboard/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,16 @@ export const metadata = {
# Dashboard
The dashboard offers a user-friendly and efficient interface for managing all essential cloud functions, streamlining operations and enhancing productivity.

<img
 src={"https://github.com/simplecloudapp/branding/blob/main/media/dashboard/overview.png?raw=true"}
 alt=""
 className="w-full object-cover"
 style={{
 borderRadius: '1rem',
 border: '1px solid rgba(255, 255, 255, 0.1)',
 }}
/>

## Understanding the Dashboard
The dashboard is a web application that, like the [CLI](/cli), allows you to manage your cloud instance. 
It serves solely as an interface that sends commands to the controller or droplets and retrieves information. 
Expand All@@ -26,10 +36,22 @@ Upcoming Features:


## Login
<Note>
 Work in Progress
</Note>

For anyone who doesn't want to install the dashboard on their own machine, feel free to use the dashboard we host ourselves.

<img
 src={"https://github.com/simplecloudapp/branding/blob/main/media/dashboard/login.png?raw=true"}
 alt=""
 className="w-full aspect-video object-cover"
 style={{
 borderRadius: '1rem',
 border: '1px solid rgba(255, 255, 255, 0.1)',
 }}
/>

1. Go to [dashboard.simplecloud.app](http://dashboard.simplecloud.app)
2. Enter your controller endpoint, including your IP and port 8080 (Example: `187.420.69:8080`)
3. Enter your controller secret, which you can find under `/components/.secrets/auth.secret`

## Installing the Dashboard

Expand Down

24 changes: 12 additions & 12 deletions
src/app/plugin/npcs/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,14 +55,14 @@ Actions allow you to interact with NPCs and set the trigger of an action individ
Each action has its own option with which you can customise it. Exactly as required for your NPC.
Here you will find all available actions and their options:

| Action | Option | Description |
|--------------------- | ---------------------- | ------------------------------------------------------------|
| `open_inventory` | inventory.name | Open an inventory to select a server |
| `run_command` | command.name | Execute a command via the player |
| `run_console_command` | command.name | Execute a command via the console |
| `connect_to_server` | server.name | Send a player to a server |
| `transfer_to_server` | server.ip, server.port | Send a player to an external server with the transfer method |

| Action | Option | Description |
|-----------------------|---------------------------------------------------------------------------|--------------------------------------------------------------|
| `open_inventory` | inventory.name | Open an inventory to select a server |
| `run_command` | command.name | Execute a command via the player |
| `run_console_command` | command.name | Execute a command via the console |
| `connect_to_server` | server.name | Send a player to a server |
| `transfer_to_server` | server.ip, server.port | Send a player to an external server with the transfer method |
| `quick_join` | group.name, server.name.pattern, filter.player.count, filter.server.state | Send a player to an random server |

## Creating a NPC

Expand DownExpand Up@@ -212,7 +212,7 @@ items:
 material: LIME_BANNER
 display-name: <group_name> <numerical_id>
 lores:
 - "<gray>Players: <#38bdf8><player_count><dark_gray><dark_gray>/<#38bdf8><max_players>"
 - "<gray>Players: <#38bdf8><online_players><dark_gray><dark_gray>/<#38bdf8><max_players>"
 - ""
 - "<gray>Version: <#a3a3a3><property:server-software> <property:minecraft-version>"
 - "<gray>Template: <#a3a3a3><property:template-id>"
Expand All@@ -234,18 +234,18 @@ items:
## Commands
| Command | Description |
|----------------------------------------------------------|-----------------------------------------------------------|
| `/scnpc create <name>` | Create a NPC with our own NPC implementation |
| `/scnpc apply <name>` | Create a NPC with our own NPC implementation |
| `/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` |
| `/scnpc <id> setOption <key> <value>` | Set global options |
| `/scnpc <id> removeOption <key> <value>` | Remove global options |
| `/scnpc <id> setHologramGroup <groupName>` | Set the Group for the Hologram Placeholders |
| `/scnpc createInventory <name>`  | Create a new Inventory Configuration |
| `/scnpc createInventory <name> <groupName>` | Create a new Inventory Configuration |

## Permissions
| Permission | Description |
|------------------------- | --------------------|
|---------------------------|----------------------|
| `simplecloud.command.npc` | For `/scnps` Command |

## What's Next?
Expand Down

42 changes: 21 additions & 21 deletions
src/app/plugin/placeholder/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,29 +39,29 @@ The following table shows all currently supported server implementations:
You can use the parameters of the current server and the group to which the server belongs as placeholders.

### Server Placeholder
| Placeholder | Description |
|-----------------------|--------------------------------------------------------------------------------|
| %server_id% | Unique identifier (e.g., "0f0c2d1a-d7d5-4c7f-b7a9-c0e8e9b5a6b8") |
| %server_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %server_state% | Server state (UNKNOWN_STATE, PREPARING, STARTING, AVAILABLE, INGAME, STOPPING) |
| %server_host% | Host machine identifier |
| %server_numerical_id% | Numerical ID within group |
| %server_ip% | Server IP address |
| %server_port% | Server port |
| %server_max_players% | Maximum allowed players |
| %server_min_memory% | Minimum RAM allocation in MB |
| %server_max_memory% | Maximum RAM allocation in MB |
| %server_player_count% | Current player count |
| Placeholder | Description |
|-----------------------------------|--------------------------------------------------------------------------------|
| %simplecloud_server_id% | Unique identifier (e.g., "0f0c2d1a-d7d5-4c7f-b7a9-c0e8e9b5a6b8") |
| %simplecloud_server_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %simplecloud_server_state% | Server state (UNKNOWN_STATE, PREPARING, STARTING, AVAILABLE, INGAME, STOPPING) |
| %simplecloud_server_host% | Host machine identifier |
| %simplecloud_server_numerical_id% | Numerical ID within group |
| %simplecloud_server_ip% | Server IP address |
| %simplecloud_server_port% | Server port |
| %simplecloud_server_max_players% | Maximum allowed players |
| %simplecloud_server_min_memory% | Minimum RAM allocation in MB |
| %simplecloud_server_max_memory% | Maximum RAM allocation in MB |
| %simplecloud_server_player_count% | Current player count |

### Group Placeholder
| Placeholder | Description |
|----------------------|---------------------------------------------|
| %group_name% | Unique identifier for the group |
| %group_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %group_min_memory% | Minimum RAM allocation in MB |
| %group_max_memory% | Maximum RAM allocation in MB |
| %group_max_players% | Maximum players per server |
| %group_player_count% | Current players count |
| Placeholder | Description |
|----------------------------------|---------------------------------------------|
| %simplecloud_group_name% | Unique identifier for the group |
| %simplecloud_group_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %simplecloud_group_min_memory% | Minimum RAM allocation in MB |
| %simplecloud_group_max_memory% | Maximum RAM allocation in MB |
| %simplecloud_group_max_players% | Maximum players per server |
| %simplecloud_group_player_count% | Current players count |

## 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
Develop#21

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

egyboyy
merged 9 commits into

from

Jan 1, 2025
 Merged


Develop
#21
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
d4715cb

ref: update npc commands table


niklasnieberler Dec 27, 2024
df021c0

ref: add npc quick_join action


niklasnieberler Dec 28, 2024
8fc51f3

fix: remove unicode


niklasnieberler Dec 28, 2024
5240093

ref: update placeholder in npc page


niklasnieberler Dec 29, 2024
59ea763

refactor: dashboard login instructions


egyboyy Dec 30, 2024
95829f1

fix: dashboard overview screenshot


egyboyy Dec 30, 2024
abb1b4b

ref: update placeholder page


niklasnieberler Dec 31, 2024
7d6da54

Merge remote-tracking branch 'origin/develop' into develop


niklasnieberler Dec 31, 2024
dcf86b1

ref: update npc commands in npc page


niklasnieberler Dec 31, 2024

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


28 changes: 25 additions & 3 deletions
src/app/dashboard/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,16 @@ export const metadata = {
# Dashboard
The dashboard offers a user-friendly and efficient interface for managing all essential cloud functions, streamlining operations and enhancing productivity.

<img
 src={"https://github.com/simplecloudapp/branding/blob/main/media/dashboard/overview.png?raw=true"}
 alt=""
 className="w-full object-cover"
 style={{
 borderRadius: '1rem',
 border: '1px solid rgba(255, 255, 255, 0.1)',
 }}
/>

## Understanding the Dashboard
The dashboard is a web application that, like the [CLI](/cli), allows you to manage your cloud instance. 
It serves solely as an interface that sends commands to the controller or droplets and retrieves information. 
Expand All@@ -26,10 +36,22 @@ Upcoming Features:


## Login
<Note>
 Work in Progress
</Note>

For anyone who doesn't want to install the dashboard on their own machine, feel free to use the dashboard we host ourselves.

<img
 src={"https://github.com/simplecloudapp/branding/blob/main/media/dashboard/login.png?raw=true"}
 alt=""
 className="w-full aspect-video object-cover"
 style={{
 borderRadius: '1rem',
 border: '1px solid rgba(255, 255, 255, 0.1)',
 }}
/>

1. Go to [dashboard.simplecloud.app](http://dashboard.simplecloud.app)
2. Enter your controller endpoint, including your IP and port 8080 (Example: `187.420.69:8080`)
3. Enter your controller secret, which you can find under `/components/.secrets/auth.secret`

## Installing the Dashboard

Expand Down

24 changes: 12 additions & 12 deletions
src/app/plugin/npcs/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,14 +55,14 @@ Actions allow you to interact with NPCs and set the trigger of an action individ
Each action has its own option with which you can customise it. Exactly as required for your NPC.
Here you will find all available actions and their options:

| Action | Option | Description |
|--------------------- | ---------------------- | ------------------------------------------------------------|
| `open_inventory` | inventory.name | Open an inventory to select a server |
| `run_command` | command.name | Execute a command via the player |
| `run_console_command` | command.name | Execute a command via the console |
| `connect_to_server` | server.name | Send a player to a server |
| `transfer_to_server` | server.ip, server.port | Send a player to an external server with the transfer method |

| Action | Option | Description |
|-----------------------|---------------------------------------------------------------------------|--------------------------------------------------------------|
| `open_inventory` | inventory.name | Open an inventory to select a server |
| `run_command` | command.name | Execute a command via the player |
| `run_console_command` | command.name | Execute a command via the console |
| `connect_to_server` | server.name | Send a player to a server |
| `transfer_to_server` | server.ip, server.port | Send a player to an external server with the transfer method |
| `quick_join` | group.name, server.name.pattern, filter.player.count, filter.server.state | Send a player to an random server |

## Creating a NPC

Expand DownExpand Up@@ -212,7 +212,7 @@ items:
 material: LIME_BANNER
 display-name: <group_name> <numerical_id>
 lores:
 - "<gray>Players: <#38bdf8><player_count><dark_gray><dark_gray>/<#38bdf8><max_players>"
 - "<gray>Players: <#38bdf8><online_players><dark_gray><dark_gray>/<#38bdf8><max_players>"
 - ""
 - "<gray>Version: <#a3a3a3><property:server-software> <property:minecraft-version>"
 - "<gray>Template: <#a3a3a3><property:template-id>"
Expand All@@ -234,18 +234,18 @@ items:
## Commands
| Command | Description |
|----------------------------------------------------------|-----------------------------------------------------------|
| `/scnpc create <name>` | Create a NPC with our own NPC implementation |
| `/scnpc apply <name>` | Create a NPC with our own NPC implementation |
| `/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` |
| `/scnpc <id> setOption <key> <value>` | Set global options |
| `/scnpc <id> removeOption <key> <value>` | Remove global options |
| `/scnpc <id> setHologramGroup <groupName>` | Set the Group for the Hologram Placeholders |
| `/scnpc createInventory <name>`  | Create a new Inventory Configuration |
| `/scnpc createInventory <name> <groupName>` | Create a new Inventory Configuration |

## Permissions
| Permission | Description |
|------------------------- | --------------------|
|---------------------------|----------------------|
| `simplecloud.command.npc` | For `/scnps` Command |

## What's Next?
Expand Down

42 changes: 21 additions & 21 deletions
src/app/plugin/placeholder/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,29 +39,29 @@ The following table shows all currently supported server implementations:
You can use the parameters of the current server and the group to which the server belongs as placeholders.

### Server Placeholder
| Placeholder | Description |
|-----------------------|--------------------------------------------------------------------------------|
| %server_id% | Unique identifier (e.g., "0f0c2d1a-d7d5-4c7f-b7a9-c0e8e9b5a6b8") |
| %server_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %server_state% | Server state (UNKNOWN_STATE, PREPARING, STARTING, AVAILABLE, INGAME, STOPPING) |
| %server_host% | Host machine identifier |
| %server_numerical_id% | Numerical ID within group |
| %server_ip% | Server IP address |
| %server_port% | Server port |
| %server_max_players% | Maximum allowed players |
| %server_min_memory% | Minimum RAM allocation in MB |
| %server_max_memory% | Maximum RAM allocation in MB |
| %server_player_count% | Current player count |
| Placeholder | Description |
|-----------------------------------|--------------------------------------------------------------------------------|
| %simplecloud_server_id% | Unique identifier (e.g., "0f0c2d1a-d7d5-4c7f-b7a9-c0e8e9b5a6b8") |
| %simplecloud_server_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %simplecloud_server_state% | Server state (UNKNOWN_STATE, PREPARING, STARTING, AVAILABLE, INGAME, STOPPING) |
| %simplecloud_server_host% | Host machine identifier |
| %simplecloud_server_numerical_id% | Numerical ID within group |
| %simplecloud_server_ip% | Server IP address |
| %simplecloud_server_port% | Server port |
| %simplecloud_server_max_players% | Maximum allowed players |
| %simplecloud_server_min_memory% | Minimum RAM allocation in MB |
| %simplecloud_server_max_memory% | Maximum RAM allocation in MB |
| %simplecloud_server_player_count% | Current player count |

### Group Placeholder
| Placeholder | Description |
|----------------------|---------------------------------------------|
| %group_name% | Unique identifier for the group |
| %group_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %group_min_memory% | Minimum RAM allocation in MB |
| %group_max_memory% | Maximum RAM allocation in MB |
| %group_max_players% | Maximum players per server |
| %group_player_count% | Current players count |
| Placeholder | Description |
|----------------------------------|---------------------------------------------|
| %simplecloud_group_name% | Unique identifier for the group |
| %simplecloud_group_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %simplecloud_group_min_memory% | Minimum RAM allocation in MB |
| %simplecloud_group_max_memory% | Maximum RAM allocation in MB |
| %simplecloud_group_max_players% | Maximum players per server |
| %simplecloud_group_player_count% | Current players count |

## 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 > 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
Develop#21

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

egyboyy
merged 9 commits into

from

Jan 1, 2025
 Merged


Develop
#21
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
d4715cb

ref: update npc commands table


niklasnieberler Dec 27, 2024
df021c0

ref: add npc quick_join action


niklasnieberler Dec 28, 2024
8fc51f3

fix: remove unicode


niklasnieberler Dec 28, 2024
5240093

ref: update placeholder in npc page


niklasnieberler Dec 29, 2024
59ea763

refactor: dashboard login instructions


egyboyy Dec 30, 2024
95829f1

fix: dashboard overview screenshot


egyboyy Dec 30, 2024
abb1b4b

ref: update placeholder page


niklasnieberler Dec 31, 2024
7d6da54

Merge remote-tracking branch 'origin/develop' into develop


niklasnieberler Dec 31, 2024
dcf86b1

ref: update npc commands in npc page


niklasnieberler Dec 31, 2024

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


28 changes: 25 additions & 3 deletions
src/app/dashboard/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,16 @@ export const metadata = {
# Dashboard
The dashboard offers a user-friendly and efficient interface for managing all essential cloud functions, streamlining operations and enhancing productivity.

<img
 src={"https://github.com/simplecloudapp/branding/blob/main/media/dashboard/overview.png?raw=true"}
 alt=""
 className="w-full object-cover"
 style={{
 borderRadius: '1rem',
 border: '1px solid rgba(255, 255, 255, 0.1)',
 }}
/>

## Understanding the Dashboard
The dashboard is a web application that, like the [CLI](/cli), allows you to manage your cloud instance. 
It serves solely as an interface that sends commands to the controller or droplets and retrieves information. 
Expand All@@ -26,10 +36,22 @@ Upcoming Features:


## Login
<Note>
 Work in Progress
</Note>

For anyone who doesn't want to install the dashboard on their own machine, feel free to use the dashboard we host ourselves.

<img
 src={"https://github.com/simplecloudapp/branding/blob/main/media/dashboard/login.png?raw=true"}
 alt=""
 className="w-full aspect-video object-cover"
 style={{
 borderRadius: '1rem',
 border: '1px solid rgba(255, 255, 255, 0.1)',
 }}
/>

1. Go to [dashboard.simplecloud.app](http://dashboard.simplecloud.app)
2. Enter your controller endpoint, including your IP and port 8080 (Example: `187.420.69:8080`)
3. Enter your controller secret, which you can find under `/components/.secrets/auth.secret`

## Installing the Dashboard

Expand Down

24 changes: 12 additions & 12 deletions
src/app/plugin/npcs/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,14 +55,14 @@ Actions allow you to interact with NPCs and set the trigger of an action individ
Each action has its own option with which you can customise it. Exactly as required for your NPC.
Here you will find all available actions and their options:

| Action | Option | Description |
|--------------------- | ---------------------- | ------------------------------------------------------------|
| `open_inventory` | inventory.name | Open an inventory to select a server |
| `run_command` | command.name | Execute a command via the player |
| `run_console_command` | command.name | Execute a command via the console |
| `connect_to_server` | server.name | Send a player to a server |
| `transfer_to_server` | server.ip, server.port | Send a player to an external server with the transfer method |

| Action | Option | Description |
|-----------------------|---------------------------------------------------------------------------|--------------------------------------------------------------|
| `open_inventory` | inventory.name | Open an inventory to select a server |
| `run_command` | command.name | Execute a command via the player |
| `run_console_command` | command.name | Execute a command via the console |
| `connect_to_server` | server.name | Send a player to a server |
| `transfer_to_server` | server.ip, server.port | Send a player to an external server with the transfer method |
| `quick_join` | group.name, server.name.pattern, filter.player.count, filter.server.state | Send a player to an random server |

## Creating a NPC

Expand DownExpand Up@@ -212,7 +212,7 @@ items:
 material: LIME_BANNER
 display-name: <group_name> <numerical_id>
 lores:
 - "<gray>Players: <#38bdf8><player_count><dark_gray><dark_gray>/<#38bdf8><max_players>"
 - "<gray>Players: <#38bdf8><online_players><dark_gray><dark_gray>/<#38bdf8><max_players>"
 - ""
 - "<gray>Version: <#a3a3a3><property:server-software> <property:minecraft-version>"
 - "<gray>Template: <#a3a3a3><property:template-id>"
Expand All@@ -234,18 +234,18 @@ items:
## Commands
| Command | Description |
|----------------------------------------------------------|-----------------------------------------------------------|
| `/scnpc create <name>` | Create a NPC with our own NPC implementation |
| `/scnpc apply <name>` | Create a NPC with our own NPC implementation |
| `/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` |
| `/scnpc <id> setOption <key> <value>` | Set global options |
| `/scnpc <id> removeOption <key> <value>` | Remove global options |
| `/scnpc <id> setHologramGroup <groupName>` | Set the Group for the Hologram Placeholders |
| `/scnpc createInventory <name>`  | Create a new Inventory Configuration |
| `/scnpc createInventory <name> <groupName>` | Create a new Inventory Configuration |

## Permissions
| Permission | Description |
|------------------------- | --------------------|
|---------------------------|----------------------|
| `simplecloud.command.npc` | For `/scnps` Command |

## What's Next?
Expand Down

42 changes: 21 additions & 21 deletions
src/app/plugin/placeholder/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,29 +39,29 @@ The following table shows all currently supported server implementations:
You can use the parameters of the current server and the group to which the server belongs as placeholders.

### Server Placeholder
| Placeholder | Description |
|-----------------------|--------------------------------------------------------------------------------|
| %server_id% | Unique identifier (e.g., "0f0c2d1a-d7d5-4c7f-b7a9-c0e8e9b5a6b8") |
| %server_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %server_state% | Server state (UNKNOWN_STATE, PREPARING, STARTING, AVAILABLE, INGAME, STOPPING) |
| %server_host% | Host machine identifier |
| %server_numerical_id% | Numerical ID within group |
| %server_ip% | Server IP address |
| %server_port% | Server port |
| %server_max_players% | Maximum allowed players |
| %server_min_memory% | Minimum RAM allocation in MB |
| %server_max_memory% | Maximum RAM allocation in MB |
| %server_player_count% | Current player count |
| Placeholder | Description |
|-----------------------------------|--------------------------------------------------------------------------------|
| %simplecloud_server_id% | Unique identifier (e.g., "0f0c2d1a-d7d5-4c7f-b7a9-c0e8e9b5a6b8") |
| %simplecloud_server_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %simplecloud_server_state% | Server state (UNKNOWN_STATE, PREPARING, STARTING, AVAILABLE, INGAME, STOPPING) |
| %simplecloud_server_host% | Host machine identifier |
| %simplecloud_server_numerical_id% | Numerical ID within group |
| %simplecloud_server_ip% | Server IP address |
| %simplecloud_server_port% | Server port |
| %simplecloud_server_max_players% | Maximum allowed players |
| %simplecloud_server_min_memory% | Minimum RAM allocation in MB |
| %simplecloud_server_max_memory% | Maximum RAM allocation in MB |
| %simplecloud_server_player_count% | Current player count |

### Group Placeholder
| Placeholder | Description |
|----------------------|---------------------------------------------|
| %group_name% | Unique identifier for the group |
| %group_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %group_min_memory% | Minimum RAM allocation in MB |
| %group_max_memory% | Maximum RAM allocation in MB |
| %group_max_players% | Maximum players per server |
| %group_player_count% | Current players count |
| Placeholder | Description |
|----------------------------------|---------------------------------------------|
| %simplecloud_group_name% | Unique identifier for the group |
| %simplecloud_group_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %simplecloud_group_min_memory% | Minimum RAM allocation in MB |
| %simplecloud_group_max_memory% | Maximum RAM allocation in MB |
| %simplecloud_group_max_players% | Maximum players per server |
| %simplecloud_group_player_count% | Current players count |

## 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
Develop#21

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

egyboyy
merged 9 commits into

from

Jan 1, 2025
 Merged


Develop
#21
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
d4715cb

ref: update npc commands table


niklasnieberler Dec 27, 2024
df021c0

ref: add npc quick_join action


niklasnieberler Dec 28, 2024
8fc51f3

fix: remove unicode


niklasnieberler Dec 28, 2024
5240093

ref: update placeholder in npc page


niklasnieberler Dec 29, 2024
59ea763

refactor: dashboard login instructions


egyboyy Dec 30, 2024
95829f1

fix: dashboard overview screenshot


egyboyy Dec 30, 2024
abb1b4b

ref: update placeholder page


niklasnieberler Dec 31, 2024
7d6da54

Merge remote-tracking branch 'origin/develop' into develop


niklasnieberler Dec 31, 2024
dcf86b1

ref: update npc commands in npc page


niklasnieberler Dec 31, 2024

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


28 changes: 25 additions & 3 deletions
src/app/dashboard/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,16 @@ export const metadata = {
# Dashboard
The dashboard offers a user-friendly and efficient interface for managing all essential cloud functions, streamlining operations and enhancing productivity.

<img
 src={"https://github.com/simplecloudapp/branding/blob/main/media/dashboard/overview.png?raw=true"}
 alt=""
 className="w-full object-cover"
 style={{
 borderRadius: '1rem',
 border: '1px solid rgba(255, 255, 255, 0.1)',
 }}
/>

## Understanding the Dashboard
The dashboard is a web application that, like the [CLI](/cli), allows you to manage your cloud instance. 
It serves solely as an interface that sends commands to the controller or droplets and retrieves information. 
Expand All@@ -26,10 +36,22 @@ Upcoming Features:


## Login
<Note>
 Work in Progress
</Note>

For anyone who doesn't want to install the dashboard on their own machine, feel free to use the dashboard we host ourselves.

<img
 src={"https://github.com/simplecloudapp/branding/blob/main/media/dashboard/login.png?raw=true"}
 alt=""
 className="w-full aspect-video object-cover"
 style={{
 borderRadius: '1rem',
 border: '1px solid rgba(255, 255, 255, 0.1)',
 }}
/>

1. Go to [dashboard.simplecloud.app](http://dashboard.simplecloud.app)
2. Enter your controller endpoint, including your IP and port 8080 (Example: `187.420.69:8080`)
3. Enter your controller secret, which you can find under `/components/.secrets/auth.secret`

## Installing the Dashboard

Expand Down

24 changes: 12 additions & 12 deletions
src/app/plugin/npcs/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,14 +55,14 @@ Actions allow you to interact with NPCs and set the trigger of an action individ
Each action has its own option with which you can customise it. Exactly as required for your NPC.
Here you will find all available actions and their options:

| Action | Option | Description |
|--------------------- | ---------------------- | ------------------------------------------------------------|
| `open_inventory` | inventory.name | Open an inventory to select a server |
| `run_command` | command.name | Execute a command via the player |
| `run_console_command` | command.name | Execute a command via the console |
| `connect_to_server` | server.name | Send a player to a server |
| `transfer_to_server` | server.ip, server.port | Send a player to an external server with the transfer method |

| Action | Option | Description |
|-----------------------|---------------------------------------------------------------------------|--------------------------------------------------------------|
| `open_inventory` | inventory.name | Open an inventory to select a server |
| `run_command` | command.name | Execute a command via the player |
| `run_console_command` | command.name | Execute a command via the console |
| `connect_to_server` | server.name | Send a player to a server |
| `transfer_to_server` | server.ip, server.port | Send a player to an external server with the transfer method |
| `quick_join` | group.name, server.name.pattern, filter.player.count, filter.server.state | Send a player to an random server |

## Creating a NPC

Expand DownExpand Up@@ -212,7 +212,7 @@ items:
 material: LIME_BANNER
 display-name: <group_name> <numerical_id>
 lores:
 - "<gray>Players: <#38bdf8><player_count><dark_gray><dark_gray>/<#38bdf8><max_players>"
 - "<gray>Players: <#38bdf8><online_players><dark_gray><dark_gray>/<#38bdf8><max_players>"
 - ""
 - "<gray>Version: <#a3a3a3><property:server-software> <property:minecraft-version>"
 - "<gray>Template: <#a3a3a3><property:template-id>"
Expand All@@ -234,18 +234,18 @@ items:
## Commands
| Command | Description |
|----------------------------------------------------------|-----------------------------------------------------------|
| `/scnpc create <name>` | Create a NPC with our own NPC implementation |
| `/scnpc apply <name>` | Create a NPC with our own NPC implementation |
| `/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` |
| `/scnpc <id> setOption <key> <value>` | Set global options |
| `/scnpc <id> removeOption <key> <value>` | Remove global options |
| `/scnpc <id> setHologramGroup <groupName>` | Set the Group for the Hologram Placeholders |
| `/scnpc createInventory <name>`  | Create a new Inventory Configuration |
| `/scnpc createInventory <name> <groupName>` | Create a new Inventory Configuration |

## Permissions
| Permission | Description |
|------------------------- | --------------------|
|---------------------------|----------------------|
| `simplecloud.command.npc` | For `/scnps` Command |

## What's Next?
Expand Down

42 changes: 21 additions & 21 deletions
src/app/plugin/placeholder/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,29 +39,29 @@ The following table shows all currently supported server implementations:
You can use the parameters of the current server and the group to which the server belongs as placeholders.

### Server Placeholder
| Placeholder | Description |
|-----------------------|--------------------------------------------------------------------------------|
| %server_id% | Unique identifier (e.g., "0f0c2d1a-d7d5-4c7f-b7a9-c0e8e9b5a6b8") |
| %server_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %server_state% | Server state (UNKNOWN_STATE, PREPARING, STARTING, AVAILABLE, INGAME, STOPPING) |
| %server_host% | Host machine identifier |
| %server_numerical_id% | Numerical ID within group |
| %server_ip% | Server IP address |
| %server_port% | Server port |
| %server_max_players% | Maximum allowed players |
| %server_min_memory% | Minimum RAM allocation in MB |
| %server_max_memory% | Maximum RAM allocation in MB |
| %server_player_count% | Current player count |
| Placeholder | Description |
|-----------------------------------|--------------------------------------------------------------------------------|
| %simplecloud_server_id% | Unique identifier (e.g., "0f0c2d1a-d7d5-4c7f-b7a9-c0e8e9b5a6b8") |
| %simplecloud_server_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %simplecloud_server_state% | Server state (UNKNOWN_STATE, PREPARING, STARTING, AVAILABLE, INGAME, STOPPING) |
| %simplecloud_server_host% | Host machine identifier |
| %simplecloud_server_numerical_id% | Numerical ID within group |
| %simplecloud_server_ip% | Server IP address |
| %simplecloud_server_port% | Server port |
| %simplecloud_server_max_players% | Maximum allowed players |
| %simplecloud_server_min_memory% | Minimum RAM allocation in MB |
| %simplecloud_server_max_memory% | Maximum RAM allocation in MB |
| %simplecloud_server_player_count% | Current player count |

### Group Placeholder
| Placeholder | Description |
|----------------------|---------------------------------------------|
| %group_name% | Unique identifier for the group |
| %group_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %group_min_memory% | Minimum RAM allocation in MB |
| %group_max_memory% | Maximum RAM allocation in MB |
| %group_max_players% | Maximum players per server |
| %group_player_count% | Current players count |
| Placeholder | Description |
|----------------------------------|---------------------------------------------|
| %simplecloud_group_name% | Unique identifier for the group |
| %simplecloud_group_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %simplecloud_group_min_memory% | Minimum RAM allocation in MB |
| %simplecloud_group_max_memory% | Maximum RAM allocation in MB |
| %simplecloud_group_max_players% | Maximum players per server |
| %simplecloud_group_player_count% | Current players count |

## 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
Develop#21

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

egyboyy
merged 9 commits into

from

Jan 1, 2025
 Merged


Develop
#21
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
d4715cb

ref: update npc commands table


niklasnieberler Dec 27, 2024
df021c0

ref: add npc quick_join action


niklasnieberler Dec 28, 2024
8fc51f3

fix: remove unicode


niklasnieberler Dec 28, 2024
5240093

ref: update placeholder in npc page


niklasnieberler Dec 29, 2024
59ea763

refactor: dashboard login instructions


egyboyy Dec 30, 2024
95829f1

fix: dashboard overview screenshot


egyboyy Dec 30, 2024
abb1b4b

ref: update placeholder page


niklasnieberler Dec 31, 2024
7d6da54

Merge remote-tracking branch 'origin/develop' into develop


niklasnieberler Dec 31, 2024
dcf86b1

ref: update npc commands in npc page


niklasnieberler Dec 31, 2024

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


28 changes: 25 additions & 3 deletions
src/app/dashboard/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,16 @@ export const metadata = {
# Dashboard
The dashboard offers a user-friendly and efficient interface for managing all essential cloud functions, streamlining operations and enhancing productivity.

<img
 src={"https://github.com/simplecloudapp/branding/blob/main/media/dashboard/overview.png?raw=true"}
 alt=""
 className="w-full object-cover"
 style={{
 borderRadius: '1rem',
 border: '1px solid rgba(255, 255, 255, 0.1)',
 }}
/>

## Understanding the Dashboard
The dashboard is a web application that, like the [CLI](/cli), allows you to manage your cloud instance. 
It serves solely as an interface that sends commands to the controller or droplets and retrieves information. 
Expand All@@ -26,10 +36,22 @@ Upcoming Features:


## Login
<Note>
 Work in Progress
</Note>

For anyone who doesn't want to install the dashboard on their own machine, feel free to use the dashboard we host ourselves.

<img
 src={"https://github.com/simplecloudapp/branding/blob/main/media/dashboard/login.png?raw=true"}
 alt=""
 className="w-full aspect-video object-cover"
 style={{
 borderRadius: '1rem',
 border: '1px solid rgba(255, 255, 255, 0.1)',
 }}
/>

1. Go to [dashboard.simplecloud.app](http://dashboard.simplecloud.app)
2. Enter your controller endpoint, including your IP and port 8080 (Example: `187.420.69:8080`)
3. Enter your controller secret, which you can find under `/components/.secrets/auth.secret`

## Installing the Dashboard

Expand Down

24 changes: 12 additions & 12 deletions
src/app/plugin/npcs/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,14 +55,14 @@ Actions allow you to interact with NPCs and set the trigger of an action individ
Each action has its own option with which you can customise it. Exactly as required for your NPC.
Here you will find all available actions and their options:

| Action | Option | Description |
|--------------------- | ---------------------- | ------------------------------------------------------------|
| `open_inventory` | inventory.name | Open an inventory to select a server |
| `run_command` | command.name | Execute a command via the player |
| `run_console_command` | command.name | Execute a command via the console |
| `connect_to_server` | server.name | Send a player to a server |
| `transfer_to_server` | server.ip, server.port | Send a player to an external server with the transfer method |

| Action | Option | Description |
|-----------------------|---------------------------------------------------------------------------|--------------------------------------------------------------|
| `open_inventory` | inventory.name | Open an inventory to select a server |
| `run_command` | command.name | Execute a command via the player |
| `run_console_command` | command.name | Execute a command via the console |
| `connect_to_server` | server.name | Send a player to a server |
| `transfer_to_server` | server.ip, server.port | Send a player to an external server with the transfer method |
| `quick_join` | group.name, server.name.pattern, filter.player.count, filter.server.state | Send a player to an random server |

## Creating a NPC

Expand DownExpand Up@@ -212,7 +212,7 @@ items:
 material: LIME_BANNER
 display-name: <group_name> <numerical_id>
 lores:
 - "<gray>Players: <#38bdf8><player_count><dark_gray><dark_gray>/<#38bdf8><max_players>"
 - "<gray>Players: <#38bdf8><online_players><dark_gray><dark_gray>/<#38bdf8><max_players>"
 - ""
 - "<gray>Version: <#a3a3a3><property:server-software> <property:minecraft-version>"
 - "<gray>Template: <#a3a3a3><property:template-id>"
Expand All@@ -234,18 +234,18 @@ items:
## Commands
| Command | Description |
|----------------------------------------------------------|-----------------------------------------------------------|
| `/scnpc create <name>` | Create a NPC with our own NPC implementation |
| `/scnpc apply <name>` | Create a NPC with our own NPC implementation |
| `/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` |
| `/scnpc <id> setOption <key> <value>` | Set global options |
| `/scnpc <id> removeOption <key> <value>` | Remove global options |
| `/scnpc <id> setHologramGroup <groupName>` | Set the Group for the Hologram Placeholders |
| `/scnpc createInventory <name>`  | Create a new Inventory Configuration |
| `/scnpc createInventory <name> <groupName>` | Create a new Inventory Configuration |

## Permissions
| Permission | Description |
|------------------------- | --------------------|
|---------------------------|----------------------|
| `simplecloud.command.npc` | For `/scnps` Command |

## What's Next?
Expand Down

42 changes: 21 additions & 21 deletions
src/app/plugin/placeholder/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,29 +39,29 @@ The following table shows all currently supported server implementations:
You can use the parameters of the current server and the group to which the server belongs as placeholders.

### Server Placeholder
| Placeholder | Description |
|-----------------------|--------------------------------------------------------------------------------|
| %server_id% | Unique identifier (e.g., "0f0c2d1a-d7d5-4c7f-b7a9-c0e8e9b5a6b8") |
| %server_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %server_state% | Server state (UNKNOWN_STATE, PREPARING, STARTING, AVAILABLE, INGAME, STOPPING) |
| %server_host% | Host machine identifier |
| %server_numerical_id% | Numerical ID within group |
| %server_ip% | Server IP address |
| %server_port% | Server port |
| %server_max_players% | Maximum allowed players |
| %server_min_memory% | Minimum RAM allocation in MB |
| %server_max_memory% | Maximum RAM allocation in MB |
| %server_player_count% | Current player count |
| Placeholder | Description |
|-----------------------------------|--------------------------------------------------------------------------------|
| %simplecloud_server_id% | Unique identifier (e.g., "0f0c2d1a-d7d5-4c7f-b7a9-c0e8e9b5a6b8") |
| %simplecloud_server_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %simplecloud_server_state% | Server state (UNKNOWN_STATE, PREPARING, STARTING, AVAILABLE, INGAME, STOPPING) |
| %simplecloud_server_host% | Host machine identifier |
| %simplecloud_server_numerical_id% | Numerical ID within group |
| %simplecloud_server_ip% | Server IP address |
| %simplecloud_server_port% | Server port |
| %simplecloud_server_max_players% | Maximum allowed players |
| %simplecloud_server_min_memory% | Minimum RAM allocation in MB |
| %simplecloud_server_max_memory% | Maximum RAM allocation in MB |
| %simplecloud_server_player_count% | Current player count |

### Group Placeholder
| Placeholder | Description |
|----------------------|---------------------------------------------|
| %group_name% | Unique identifier for the group |
| %group_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %group_min_memory% | Minimum RAM allocation in MB |
| %group_max_memory% | Maximum RAM allocation in MB |
| %group_max_players% | Maximum players per server |
| %group_player_count% | Current players count |
| Placeholder | Description |
|----------------------------------|---------------------------------------------|
| %simplecloud_group_name% | Unique identifier for the group |
| %simplecloud_group_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %simplecloud_group_min_memory% | Minimum RAM allocation in MB |
| %simplecloud_group_max_memory% | Maximum RAM allocation in MB |
| %simplecloud_group_max_players% | Maximum players per server |
| %simplecloud_group_player_count% | Current players count |

## 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
Develop#21

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

egyboyy
merged 9 commits into

from

Jan 1, 2025
 Merged


Develop
#21
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
d4715cb

ref: update npc commands table


niklasnieberler Dec 27, 2024
df021c0

ref: add npc quick_join action


niklasnieberler Dec 28, 2024
8fc51f3

fix: remove unicode


niklasnieberler Dec 28, 2024
5240093

ref: update placeholder in npc page


niklasnieberler Dec 29, 2024
59ea763

refactor: dashboard login instructions


egyboyy Dec 30, 2024
95829f1

fix: dashboard overview screenshot


egyboyy Dec 30, 2024
abb1b4b

ref: update placeholder page


niklasnieberler Dec 31, 2024
7d6da54

Merge remote-tracking branch 'origin/develop' into develop


niklasnieberler Dec 31, 2024
dcf86b1

ref: update npc commands in npc page


niklasnieberler Dec 31, 2024

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


28 changes: 25 additions & 3 deletions
src/app/dashboard/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,16 @@ export const metadata = {
# Dashboard
The dashboard offers a user-friendly and efficient interface for managing all essential cloud functions, streamlining operations and enhancing productivity.

<img
 src={"https://github.com/simplecloudapp/branding/blob/main/media/dashboard/overview.png?raw=true"}
 alt=""
 className="w-full object-cover"
 style={{
 borderRadius: '1rem',
 border: '1px solid rgba(255, 255, 255, 0.1)',
 }}
/>

## Understanding the Dashboard
The dashboard is a web application that, like the [CLI](/cli), allows you to manage your cloud instance. 
It serves solely as an interface that sends commands to the controller or droplets and retrieves information. 
Expand All@@ -26,10 +36,22 @@ Upcoming Features:


## Login
<Note>
 Work in Progress
</Note>

For anyone who doesn't want to install the dashboard on their own machine, feel free to use the dashboard we host ourselves.

<img
 src={"https://github.com/simplecloudapp/branding/blob/main/media/dashboard/login.png?raw=true"}
 alt=""
 className="w-full aspect-video object-cover"
 style={{
 borderRadius: '1rem',
 border: '1px solid rgba(255, 255, 255, 0.1)',
 }}
/>

1. Go to [dashboard.simplecloud.app](http://dashboard.simplecloud.app)
2. Enter your controller endpoint, including your IP and port 8080 (Example: `187.420.69:8080`)
3. Enter your controller secret, which you can find under `/components/.secrets/auth.secret`

## Installing the Dashboard

Expand Down

24 changes: 12 additions & 12 deletions
src/app/plugin/npcs/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,14 +55,14 @@ Actions allow you to interact with NPCs and set the trigger of an action individ
Each action has its own option with which you can customise it. Exactly as required for your NPC.
Here you will find all available actions and their options:

| Action | Option | Description |
|--------------------- | ---------------------- | ------------------------------------------------------------|
| `open_inventory` | inventory.name | Open an inventory to select a server |
| `run_command` | command.name | Execute a command via the player |
| `run_console_command` | command.name | Execute a command via the console |
| `connect_to_server` | server.name | Send a player to a server |
| `transfer_to_server` | server.ip, server.port | Send a player to an external server with the transfer method |

| Action | Option | Description |
|-----------------------|---------------------------------------------------------------------------|--------------------------------------------------------------|
| `open_inventory` | inventory.name | Open an inventory to select a server |
| `run_command` | command.name | Execute a command via the player |
| `run_console_command` | command.name | Execute a command via the console |
| `connect_to_server` | server.name | Send a player to a server |
| `transfer_to_server` | server.ip, server.port | Send a player to an external server with the transfer method |
| `quick_join` | group.name, server.name.pattern, filter.player.count, filter.server.state | Send a player to an random server |

## Creating a NPC

Expand DownExpand Up@@ -212,7 +212,7 @@ items:
 material: LIME_BANNER
 display-name: <group_name> <numerical_id>
 lores:
 - "<gray>Players: <#38bdf8><player_count><dark_gray><dark_gray>/<#38bdf8><max_players>"
 - "<gray>Players: <#38bdf8><online_players><dark_gray><dark_gray>/<#38bdf8><max_players>"
 - ""
 - "<gray>Version: <#a3a3a3><property:server-software> <property:minecraft-version>"
 - "<gray>Template: <#a3a3a3><property:template-id>"
Expand All@@ -234,18 +234,18 @@ items:
## Commands
| Command | Description |
|----------------------------------------------------------|-----------------------------------------------------------|
| `/scnpc create <name>` | Create a NPC with our own NPC implementation |
| `/scnpc apply <name>` | Create a NPC with our own NPC implementation |
| `/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` |
| `/scnpc <id> setOption <key> <value>` | Set global options |
| `/scnpc <id> removeOption <key> <value>` | Remove global options |
| `/scnpc <id> setHologramGroup <groupName>` | Set the Group for the Hologram Placeholders |
| `/scnpc createInventory <name>`  | Create a new Inventory Configuration |
| `/scnpc createInventory <name> <groupName>` | Create a new Inventory Configuration |

## Permissions
| Permission | Description |
|------------------------- | --------------------|
|---------------------------|----------------------|
| `simplecloud.command.npc` | For `/scnps` Command |

## What's Next?
Expand Down

42 changes: 21 additions & 21 deletions
src/app/plugin/placeholder/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,29 +39,29 @@ The following table shows all currently supported server implementations:
You can use the parameters of the current server and the group to which the server belongs as placeholders.

### Server Placeholder
| Placeholder | Description |
|-----------------------|--------------------------------------------------------------------------------|
| %server_id% | Unique identifier (e.g., "0f0c2d1a-d7d5-4c7f-b7a9-c0e8e9b5a6b8") |
| %server_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %server_state% | Server state (UNKNOWN_STATE, PREPARING, STARTING, AVAILABLE, INGAME, STOPPING) |
| %server_host% | Host machine identifier |
| %server_numerical_id% | Numerical ID within group |
| %server_ip% | Server IP address |
| %server_port% | Server port |
| %server_max_players% | Maximum allowed players |
| %server_min_memory% | Minimum RAM allocation in MB |
| %server_max_memory% | Maximum RAM allocation in MB |
| %server_player_count% | Current player count |
| Placeholder | Description |
|-----------------------------------|--------------------------------------------------------------------------------|
| %simplecloud_server_id% | Unique identifier (e.g., "0f0c2d1a-d7d5-4c7f-b7a9-c0e8e9b5a6b8") |
| %simplecloud_server_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %simplecloud_server_state% | Server state (UNKNOWN_STATE, PREPARING, STARTING, AVAILABLE, INGAME, STOPPING) |
| %simplecloud_server_host% | Host machine identifier |
| %simplecloud_server_numerical_id% | Numerical ID within group |
| %simplecloud_server_ip% | Server IP address |
| %simplecloud_server_port% | Server port |
| %simplecloud_server_max_players% | Maximum allowed players |
| %simplecloud_server_min_memory% | Minimum RAM allocation in MB |
| %simplecloud_server_max_memory% | Maximum RAM allocation in MB |
| %simplecloud_server_player_count% | Current player count |

### Group Placeholder
| Placeholder | Description |
|----------------------|---------------------------------------------|
| %group_name% | Unique identifier for the group |
| %group_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %group_min_memory% | Minimum RAM allocation in MB |
| %group_max_memory% | Maximum RAM allocation in MB |
| %group_max_players% | Maximum players per server |
| %group_player_count% | Current players count |
| Placeholder | Description |
|----------------------------------|---------------------------------------------|
| %simplecloud_group_name% | Unique identifier for the group |
| %simplecloud_group_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %simplecloud_group_min_memory% | Minimum RAM allocation in MB |
| %simplecloud_group_max_memory% | Maximum RAM allocation in MB |
| %simplecloud_group_max_players% | Maximum players per server |
| %simplecloud_group_player_count% | Current players count |

## 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
Develop#21

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

egyboyy
merged 9 commits into

from

Jan 1, 2025
 Merged


Develop
#21
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
d4715cb

ref: update npc commands table


niklasnieberler Dec 27, 2024
df021c0

ref: add npc quick_join action


niklasnieberler Dec 28, 2024
8fc51f3

fix: remove unicode


niklasnieberler Dec 28, 2024
5240093

ref: update placeholder in npc page


niklasnieberler Dec 29, 2024
59ea763

refactor: dashboard login instructions


egyboyy Dec 30, 2024
95829f1

fix: dashboard overview screenshot


egyboyy Dec 30, 2024
abb1b4b

ref: update placeholder page


niklasnieberler Dec 31, 2024
7d6da54

Merge remote-tracking branch 'origin/develop' into develop


niklasnieberler Dec 31, 2024
dcf86b1

ref: update npc commands in npc page


niklasnieberler Dec 31, 2024

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


28 changes: 25 additions & 3 deletions
src/app/dashboard/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,16 @@ export const metadata = {
# Dashboard
The dashboard offers a user-friendly and efficient interface for managing all essential cloud functions, streamlining operations and enhancing productivity.

<img
 src={"https://github.com/simplecloudapp/branding/blob/main/media/dashboard/overview.png?raw=true"}
 alt=""
 className="w-full object-cover"
 style={{
 borderRadius: '1rem',
 border: '1px solid rgba(255, 255, 255, 0.1)',
 }}
/>

## Understanding the Dashboard
The dashboard is a web application that, like the [CLI](/cli), allows you to manage your cloud instance. 
It serves solely as an interface that sends commands to the controller or droplets and retrieves information. 
Expand All@@ -26,10 +36,22 @@ Upcoming Features:


## Login
<Note>
 Work in Progress
</Note>

For anyone who doesn't want to install the dashboard on their own machine, feel free to use the dashboard we host ourselves.

<img
 src={"https://github.com/simplecloudapp/branding/blob/main/media/dashboard/login.png?raw=true"}
 alt=""
 className="w-full aspect-video object-cover"
 style={{
 borderRadius: '1rem',
 border: '1px solid rgba(255, 255, 255, 0.1)',
 }}
/>

1. Go to [dashboard.simplecloud.app](http://dashboard.simplecloud.app)
2. Enter your controller endpoint, including your IP and port 8080 (Example: `187.420.69:8080`)
3. Enter your controller secret, which you can find under `/components/.secrets/auth.secret`

## Installing the Dashboard

Expand Down

24 changes: 12 additions & 12 deletions
src/app/plugin/npcs/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,14 +55,14 @@ Actions allow you to interact with NPCs and set the trigger of an action individ
Each action has its own option with which you can customise it. Exactly as required for your NPC.
Here you will find all available actions and their options:

| Action | Option | Description |
|--------------------- | ---------------------- | ------------------------------------------------------------|
| `open_inventory` | inventory.name | Open an inventory to select a server |
| `run_command` | command.name | Execute a command via the player |
| `run_console_command` | command.name | Execute a command via the console |
| `connect_to_server` | server.name | Send a player to a server |
| `transfer_to_server` | server.ip, server.port | Send a player to an external server with the transfer method |

| Action | Option | Description |
|-----------------------|---------------------------------------------------------------------------|--------------------------------------------------------------|
| `open_inventory` | inventory.name | Open an inventory to select a server |
| `run_command` | command.name | Execute a command via the player |
| `run_console_command` | command.name | Execute a command via the console |
| `connect_to_server` | server.name | Send a player to a server |
| `transfer_to_server` | server.ip, server.port | Send a player to an external server with the transfer method |
| `quick_join` | group.name, server.name.pattern, filter.player.count, filter.server.state | Send a player to an random server |

## Creating a NPC

Expand DownExpand Up@@ -212,7 +212,7 @@ items:
 material: LIME_BANNER
 display-name: <group_name> <numerical_id>
 lores:
 - "<gray>Players: <#38bdf8><player_count><dark_gray><dark_gray>/<#38bdf8><max_players>"
 - "<gray>Players: <#38bdf8><online_players><dark_gray><dark_gray>/<#38bdf8><max_players>"
 - ""
 - "<gray>Version: <#a3a3a3><property:server-software> <property:minecraft-version>"
 - "<gray>Template: <#a3a3a3><property:template-id>"
Expand All@@ -234,18 +234,18 @@ items:
## Commands
| Command | Description |
|----------------------------------------------------------|-----------------------------------------------------------|
| `/scnpc create <name>` | Create a NPC with our own NPC implementation |
| `/scnpc apply <name>` | Create a NPC with our own NPC implementation |
| `/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` |
| `/scnpc <id> setOption <key> <value>` | Set global options |
| `/scnpc <id> removeOption <key> <value>` | Remove global options |
| `/scnpc <id> setHologramGroup <groupName>` | Set the Group for the Hologram Placeholders |
| `/scnpc createInventory <name>`  | Create a new Inventory Configuration |
| `/scnpc createInventory <name> <groupName>` | Create a new Inventory Configuration |

## Permissions
| Permission | Description |
|------------------------- | --------------------|
|---------------------------|----------------------|
| `simplecloud.command.npc` | For `/scnps` Command |

## What's Next?
Expand Down

42 changes: 21 additions & 21 deletions
src/app/plugin/placeholder/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,29 +39,29 @@ The following table shows all currently supported server implementations:
You can use the parameters of the current server and the group to which the server belongs as placeholders.

### Server Placeholder
| Placeholder | Description |
|-----------------------|--------------------------------------------------------------------------------|
| %server_id% | Unique identifier (e.g., "0f0c2d1a-d7d5-4c7f-b7a9-c0e8e9b5a6b8") |
| %server_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %server_state% | Server state (UNKNOWN_STATE, PREPARING, STARTING, AVAILABLE, INGAME, STOPPING) |
| %server_host% | Host machine identifier |
| %server_numerical_id% | Numerical ID within group |
| %server_ip% | Server IP address |
| %server_port% | Server port |
| %server_max_players% | Maximum allowed players |
| %server_min_memory% | Minimum RAM allocation in MB |
| %server_max_memory% | Maximum RAM allocation in MB |
| %server_player_count% | Current player count |
| Placeholder | Description |
|-----------------------------------|--------------------------------------------------------------------------------|
| %simplecloud_server_id% | Unique identifier (e.g., "0f0c2d1a-d7d5-4c7f-b7a9-c0e8e9b5a6b8") |
| %simplecloud_server_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %simplecloud_server_state% | Server state (UNKNOWN_STATE, PREPARING, STARTING, AVAILABLE, INGAME, STOPPING) |
| %simplecloud_server_host% | Host machine identifier |
| %simplecloud_server_numerical_id% | Numerical ID within group |
| %simplecloud_server_ip% | Server IP address |
| %simplecloud_server_port% | Server port |
| %simplecloud_server_max_players% | Maximum allowed players |
| %simplecloud_server_min_memory% | Minimum RAM allocation in MB |
| %simplecloud_server_max_memory% | Maximum RAM allocation in MB |
| %simplecloud_server_player_count% | Current player count |

### Group Placeholder
| Placeholder | Description |
|----------------------|---------------------------------------------|
| %group_name% | Unique identifier for the group |
| %group_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %group_min_memory% | Minimum RAM allocation in MB |
| %group_max_memory% | Maximum RAM allocation in MB |
| %group_max_players% | Maximum players per server |
| %group_player_count% | Current players count |
| Placeholder | Description |
|----------------------------------|---------------------------------------------|
| %simplecloud_group_name% | Unique identifier for the group |
| %simplecloud_group_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
| %simplecloud_group_min_memory% | Minimum RAM allocation in MB |
| %simplecloud_group_max_memory% | Maximum RAM allocation in MB |
| %simplecloud_group_max_players% | Maximum players per server |
| %simplecloud_group_player_count% | Current players count |

## What's Next?

Expand Down