Skip to content

Commit c530b56

Browse files
jarnejarne
committed
Initial commit
0 parents  commit c530b56

32 files changed

+8317
-0
lines changed

‎.gitignore

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

‎.prettierignore

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Dependencies
2+
/node_modules
3+
/yarn.lock
4+
5+
# Temporary files
6+
/.docusaurus
7+
8+
# Build directory
9+
/build

‎.prettierrc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"arrowParens": "avoid",
3+
"semi": false,
4+
"singleQuote": false,
5+
"tabWidth": 4
6+
}

‎babel.config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
3+
}

‎docs/general/_category_.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"position": 2,
3+
"label": "General",
4+
"collapsed": false,
5+
"link": {
6+
"type": "generated-index"
7+
}
8+
}

‎docs/general/download-a-plugin.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Downloading a plugin
6+
7+
## Official download
8+
9+
You can download the latest version of our plugins from our **[offical plugins portal](https://plugins.surva.net)**.
10+
11+
There is a "Direct download" button for every plugin. Click on it to download the latest stable version.
12+
13+
## Download from Poggit
14+
15+
Alternatively, you can download the packed plugin file (PHAR file) from Poggit.
16+
17+
A version which is not always up to date but approved by the Poggit team is available [here](https://poggit.pmmp.io/plugins/by/survanetwork). Download it by selecting the plugin and then clicking on the black "Direct Download" button.
18+
19+
Now you should have a file with the file extension ".phar" in your Downloads folder.

‎docs/general/install-plugin-on-server.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Install a plugin on the server
6+
7+
To install the plugin, you can just put the PHAR-file you downloaded in the step before into the `plugins` folder in your PocketMine-folder. You need to start the server once so the config files needed for the next step are created. Config files are stored in the `plugin_data` folder of your server.

‎docs/general/language-translations.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
5+
# Language and translations
6+
7+
## Changing the default language
8+
9+
To change the default language of the plugin, open the "config.yml" file in the plugin config folder, located unter `plugin_data`. It should contain those lines:
10+
11+
```yaml
12+
# Language of the plugin messages
13+
# Possible options are: en (English), de (German), fr (French), ...
14+
language: "en"
15+
```
16+
17+
Change the value in quotes after "language:" into the language you want to use. For example, to set the plugin on German, it should look like this:
18+
19+
```yaml
20+
# Language of the plugin messages
21+
# Possible options are: en (English), de (German), fr (French), ...
22+
language: "de"
23+
```
24+
25+
## Player language detection
26+
27+
In the latest version, all of our plugins support automated detection of the player's language set in Minecraft: Bedrock Edition. It is enabled by default.
28+
29+
If the player's language can be detected and translations are available, they will be used instead of the default language.
30+
31+
To disable this behaviour and always use the default language, change this config option to `false`:
32+
33+
```yaml
34+
# Try to automatically detect the player's language and send translated messages for each player
35+
# (language set above is used if player's language can't be detected)
36+
autodetectlanguage: true
37+
```
38+
39+
## Contributing to translations
40+
41+
You're always welcome to translate the plugin into languages which don't exist yet or correct translations which already exist.
42+
43+
We use [Transifex](https://explore.transifex.com/surva/) for translating our open source plugin projects, you're able login with your existing GitHub account there. You can contribute to the translations on the [translation project page](https://explore.transifex.com/surva/)!
44+
45+
If you want to create translations for a language we haven't added to the project yet, please [send an e-mail 📫 to our open source team](mailto:[email protected]). We'll add the additional language as soon as possible, so you can begin translating the plugin.

‎docs/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Welcome
6+
7+
Test 123

‎docs/worlds/_category_.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"position": 3,
3+
"label": "Worlds",
4+
"collapsed": false,
5+
"link": {
6+
"type": "generated-index"
7+
}
8+
}

‎docs/worlds/commands/_category_.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"position": 3,
3+
"label": "Commands",
4+
"link": {
5+
"type": "generated-index"
6+
}
7+
}

‎docs/worlds/commands/assets/world-settings-form.png

202 KB
Loading

‎docs/worlds/commands/control-list.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
sidebar_position: 8
3+
---
4+
5+
# Control lists
6+
7+
Learn more about control lists [here](./set#control-list-flags).
8+
9+
## /worlds set <flag\> list add <item\>
10+
11+
Add an item to a control list
12+
13+
Examples:
14+
15+
`/worlds set build list add 5` - Add block ID 5 (wood planks) to build/break control list of this world
16+
17+
## /worlds set <flag\> list remove <item\>
18+
19+
Remove an item from a control list
20+
21+
Examples:
22+
23+
`/worlds set command list remove me` - Remove the `me` command from the commands control list in this world
24+
25+
## /worlds set <flag\> list reset
26+
27+
Reset a control list (remove all items)
28+
29+
Examples:
30+
31+
`/worlds set build list reset` - Reset build control list (remove all block ID's) for this world
32+
33+
## /worlds set <flag\> list show
34+
35+
Show items of a control list
36+
37+
Examples:
38+
39+
`/worlds set command list show` - List commands which are on the command control list

‎docs/worlds/commands/copy-rename.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
sidebar_position: 6
3+
---
4+
5+
# Copy and rename
6+
7+
## /worlds copy <from\> <to\>
8+
9+
Copy a world
10+
11+
| Info | Value |
12+
| ------------- | ------------------------ |
13+
| Permission | worlds.admin.copy |
14+
| Short command | /worlds cp <from\> <to\> |
15+
16+
Examples:
17+
18+
`/worlds copy theoldworld anotherworld` - Copy the world "theoldworld" to the world "anotherworld"
19+
20+
## /worlds rename <from\> <to\>
21+
22+
Rename a world
23+
24+
| Info | Value |
25+
| ------------- | ------------------------ |
26+
| Permission | worlds.admin.rename |
27+
| Short command | /worlds rn <from\> <to\> |
28+
29+
Examples:
30+
31+
`/worlds rename theoldworld thenewworld` - Rename the world "theoldworld" to the world "thenewworld"

‎docs/worlds/commands/create.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
5+
# Create new world
6+
7+
## /worlds create <worldname\>
8+
9+
Create a new world.
10+
11+
| Info | Value |
12+
| ------------- | ------------------- |
13+
| Permission | worlds.admin.create |
14+
| Short command | /ws cr <worldname\> |
15+
16+
Examples:
17+
18+
`/worlds create mycoolworld` - Create a world with the name "mycoolworld"
19+
20+
## /worlds create <worldname\> <type\>
21+
22+
Create a world with the given name and world generator type (can be `NORMAL`, `FLAT`, `NETHER`, or any other valid generator registered by a plugin).
23+
24+
| Info | Value |
25+
| ------------- | --------------------------- |
26+
| Permission | worlds.admin.create |
27+
| Short command | /ws cr <worldname\> <type\> |
28+
29+
Examples:
30+
31+
`/worlds create netherworld NETHER` - Create a world with the name "netherworld" and the type `NETHER`

‎docs/worlds/commands/default-flags.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
sidebar_position: 10
3+
---
4+
5+
# Default flags
6+
7+
For default flags, the commands are nearly identical to the ones to set flags for the current world. Just add `defaults` behind `/worlds` and use the commands from [set](./set), [control lists](./control-list) and [unset](./unset).
8+
9+
Permission: `worlds.admin.defaults`
10+
11+
Examples:
12+
13+
`/worlds defaults set pvp false` - Disable PvP by default
14+
`/worlds defaults set command black` - Allow executing commands except those which are added to the control list (blacklist mode) by default
15+
`/worlds defaults set command list add me` - Add the `me` command to default command control list
16+
`/worlds defaults unset fly` - Don't allow or forbid flying as default like the plugin wasn't there

‎docs/worlds/commands/general.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# General syntax
6+
7+
Commands for the Worlds plugin always begin with `/worlds` (or use `/ws`, which is shorter).

‎docs/worlds/commands/list.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# List worlds
6+
7+
## /worlds list
8+
9+
Show the names of all worlds on the server
10+
11+
| Info | Value |
12+
| ------------- | ----------- |
13+
| Permission | worlds.list |
14+
| Short command | /ws ls |
15+
16+
Examples:
17+
18+
`/worlds list`

‎docs/worlds/commands/set.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
sidebar_position: 7
3+
---
4+
5+
# Set control flags
6+
7+
## Using the Forms GUI
8+
9+
An easy way for beginners to set control flags in worlds is using the Forms GUI.
10+
11+
You can open the GUI using the command `/worlds set` (for current world flags) or `/worlds defaults` (for default world flags).
12+
13+
![World control flags Forms GUI](./assets/world-settings-form.png)
14+
15+
The corresponding permissions are `worlds.admin.set` and `worlds.admin.defaults`, short commands are `/ws st` and `/ws df`.
16+
17+
## Using commands
18+
19+
All commands require the permission `worlds.admin.set`, the short version of the commands is `/ws st [...]`.
20+
21+
### /worlds set show
22+
23+
List all flags and their values in a world
24+
25+
Examples: `/worlds set show`
26+
27+
### /worlds set permission <permissionstring\>
28+
29+
Set a permission which is needed to join the world (cannot be set on default world)
30+
31+
Examples:
32+
33+
`/worlds set permission you.arecool` - Only players with the permission `you.arecool` are allowed to join the world
34+
35+
### /worlds set gamemode <gamemodename\>
36+
37+
Set the world's game mode (possible values are `survival`, `creative`, `adventure` or `spectator`)
38+
39+
Examples:
40+
41+
`/worlds set gamemode creative` - Set the game mode of this world to `creative`
42+
43+
### Control list flags
44+
45+
The following flags support control lists: see [here](./../flags).
46+
47+
They can be set to four possible operation modes:
48+
49+
| Operation mode | Description |
50+
| -------------- | --------------------- |
51+
| `true` | Generally allow |
52+
| `false` | Always deny |
53+
| `white` | Only allow white list |
54+
| `black` | Not allow black list |
55+
56+
Examples:
57+
58+
- `build` set to `false` doesn't allow building
59+
- `command` set to `black` doens't allow executing commands which are on the black list
60+
- `drop` set to `white` only allows dropping items which are on the white list
61+
62+
**Command: /worlds set <flag\> <value\>**
63+
64+
Examples:
65+
66+
`/worlds set build white` - Allow building only blocks which are added to the control list (whitelist mode) in this world
67+
`/worlds set command black` - Allow executing commands except those which are added to the control list (blacklist mode) in this world
68+
`/worlds set interact false` - Disable interaction (opening chests, ...) in this world
69+
70+
### Normal flags
71+
72+
The following flags are normal flags without support for control lists: see [here](./../flags).
73+
74+
They can be set to `true` (allow) or `false` (deny).
75+
76+
**Command: /worlds set <flag\> <value\>**
77+
78+
Examples:
79+
80+
`/worlds set explode false` - Disable explosions in this world
81+
`/worlds set hunger true` - Enable hunger in this world
82+
`/worlds set daylightcycle false` - Disable day and night cycling in this world

0 commit comments

Comments
 (0)