Upstream/SubServers-2
1
0
Fork 0
mirror of https://github.com/ME1312/SubServers-2.git synced 2024-11-25 03:35:26 +01:00
Code Issues Projects Releases Wiki Activity

Created Commands and Permissions (markdown)

ME1312 2020-02-29 18:20:00 -05:00
parent 7a9a3f8476
commit ca26e099a9
1 changed files with 98 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

98
Commands-and-Permissions.md Normal file

@ -0,0 +1,98 @@
This page defines all the commands provided by SubServers apps across your network and their permissions where they apply.<br><br>
# SubServers Commands
**Permission:** `subservers.command`<br>
This is the main group of commands provided by SubServers that are intended for use by server admins.<br>
For in-game users, these commands are all handled by SubServers.Client. So when applying these permissions, apply them on the servers, not the proxies. The above permission is required to access any commands in this group as a whole.<br><br>
> // We're still writing this part of the docs<br>
> // Sorry about that!
<br>
## Selecting Multiple Servers
Some commands on this page allow you to perform the same action on multiple servers without having to retype the command every time. In a similar fashion, some permissions can use these same methods to grant a permission on multiple servers.<br><br>
**Selecting a single Server:**<br>
This is as easy as it gets. We will be using this example throughout this section.<br>
```
/sub cmd Server1 say Hello World!
```
<br>
**Selecting multiple Servers directly:**<br>
If you just want to select multiple servers, this will do the job. It's essentially just a comma separated list. Although, if you have to select these same servers frequently, you may want to check out the methods after this one. Also, this method cannot be used in permissions.
```
/sub cmd Server1, Server2, Server3 say Hello World!
```
<br>
**Selecting all Servers:**<br>
If you felt like broadcasting that command to all servers, you can select all of them with this wildcard symbol.
```
/sub cmd * say Hello World!
```
<br>
**Selecting the Server you are currently on:**<br>
Speaking of wildcard symbols, this one is used to select the server you are currently on. However, this is only available when you are in-game, and it can't be used in permissions.
```
/sub cmd . say Hello World!
```
<br>
### Selecting Multiple Servers using Groups
You can also use groups to select servers. To begin selecting using groups, type a `:` before whatever you are trying to select. Many of the methods and limitations beyond that point are the same as they were in the last section.
**Selecting all Servers that belong to a single Group:**<br>
```
/sub cmd :Group1 say Hello World!
```
<br>
**Selecting all Servers that belong to at least one of multiple Groups:**<br>
```
/sub cmd :Group1, :Group2, :Group3 say Hello World!
```
<br>
**Selecting all Servers that belong to at least one Group:**<br>
```
/sub cmd :* say Hello World!
```
<br>
**Selecting all Servers that the Server you are currently on shares a Group with:**<br>
```
/sub cmd :. say Hello World!
```
<br>
### Selecting Multiple SubServers using Hosts
Lastly, you can select subservers using their hosts. To begin selecting using hosts, type a `::` before whatever you are trying to select. Many of the methods and limitations beyond that point are the same as they were in the last two sections.
**Selecting all Subservers that belong to a single Host:**<br>
```
/sub cmd ::Host1 say Hello World!
```
<br>
**Selecting all Subservers that belong to one of multiple Hosts:**<br>
```
/sub cmd ::Host1, ::Host2, ::Host3 say Hello World!
```
<br>
**Selecting all SubServers:** *(SubServers must all belong to a host)*<br>
```
/sub cmd ::* say Hello World!
```
<br>
**Selecting all SubServers that the Host you are currently on provides for:**<br>
```
/sub cmd ::. say Hello World!
```
<br><br><br>