Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,24 @@ updates:
directory: "/"
schedule:
interval: "weekly"
cooldown:
default-days: 7
semver-major-days: 7
semver-minor-days: 7
semver-patch-days: 7
groups:
docusaurus:
patterns:
- "^@docusaurus/.*"
fortawesome:
patterns:
- "^@fortawesome/.*"
react:
patterns:
- "^react$"
- "^react-dom$"

- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
interval: "monthly"
2 changes: 1 addition & 1 deletion docs/commands/main.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Permissions are prefixed with `Permissions` (i.e. `Permissions.ADMINCHAT`).
| `/inventory` | inv<br />vi | View a player's inventory. |
| `/list` | who<br />online<br />ls | View a list of online players. |
| `/map` | mapinfo | Show info about a map. || [map name] - defaults to current map |
| `/maps` | maplist<br />ml | List all loaded maps. | -a author<br />-t tag1,tag2<br />-n name |
| `/maps` | maplist<br />ml | List all loaded maps. | -a author<br />-t tag1,tag2<br />-n name<br />-g gamemode |
| `/match` | matchinfo | Show the match info. |
| `/mode list` | page | List all objective modes. || [page] |
| `/mode next` || Show the next objective mode. |
Expand Down
79 changes: 59 additions & 20 deletions docs/guides/preparing/local-server-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: Setting Up a Server
---

import ImageSwitcher from "@site/src/components/ImageSwitcher.js";
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Setting up a local Minecraft server loaded with PGM is one of the best ways to test your map without disruption and allows for greater experimentation.
Additionally, being able to test maps before submitting to a Minecraft network of your choice means that you will be able to catch mistakes early and speed up the map submission process.
Expand Down Expand Up @@ -38,10 +40,18 @@ If you already have Java 21 installed, you may skip this step.
</div>
</div>

### Downloading SportPaper
### Downloading the Server Software

Get the latest version of SportPaper from the [Downloads](/downloads) page.
Once the download is done, you must rename the file and put `SportPaper.jar` inside an empty folder.
<Tabs groupId="server-versions">
<TabItem value="classic" label="Classic (1.8)">
Get the latest version of SportPaper from the [Downloads](/downloads) page.
Once the download is done, you must rename the file and put `SportPaper.jar` inside an empty folder.
</TabItem>
<TabItem value="modern" label="Modern (1.21+)">
Get the latest stable version of Paper from [PaperMC website](https://papermc.io/downloads/paper).
Once the download is done, you must rename the file and put `paper.jar` inside an empty folder.
</TabItem>
</Tabs>

Next, you must create a Batch file to be able to start your server and have access to its console.
Start by opening your preferred text editor, copy and paste the following example below, and save the file as `start.bat`.
Expand All @@ -56,7 +66,7 @@ otherwise you will not be able to start the server!

```batch title="start.bat"
@ECHO OFF
TITLE SportPaper 1.8
TITLE My Server
java -Xms128M -Xmx2G -Dterminal.jline=false -Dterminal.ansi=true -jar SportPaper.jar nogui
PAUSE
```
Expand All @@ -68,15 +78,15 @@ PAUSE

You can download a copy of the latest version of PGM from the [Downloads](/downloads) page.

Once the download is done, you must put `PGM.jar` inside the `plugins` folder (create if it does not exist), which can be found in the folder that contains the `SportPaper.jar` file.
Once the download is done, you must put `PGM.jar` inside the `plugins` folder (create if it does not exist), which can be found in the folder that contains your server `.jar` file.

<div className="text--center">
<img src="/img/guides/local-server-setup/windows-pgm-c1.png" loading="lazy" />
</div>

### Starting the Server

Once you are done with the initial setup, you can double-click `start.bat` to let SportPaper create the necessary files for Minecraft and PGM.
Once you are done with the initial setup, you can double-click `start.bat` to let the server create the necessary files for Minecraft and PGM.
You can now join the server from your Minecraft client at `localhost` or `127.0.0.1:25565`.

Also see [Additional Setup](#additional-setup) if you would like to make the most use out of your newly-created server.
Expand Down Expand Up @@ -116,10 +126,18 @@ If you already have Java 21 installed, you may skip this step.
</div>
</div>

### Downloading SportPaper
### Downloading the Server Software

Get the latest version of SportPaper from the [Downloads](/downloads) page.
Once the download is done, you must rename the file and put `SportPaper.jar` inside an empty folder.
<Tabs groupId="server-versions">
<TabItem value="classic" label="Classic (1.8)">
Get the latest version of SportPaper from the [Downloads](/downloads) page.
Once the download is done, you must rename the file and put `SportPaper.jar` inside an empty folder.
</TabItem>
<TabItem value="modern" label="Modern (1.21+)">
Get the latest stable version of Paper from [PaperMC website](https://papermc.io/downloads/paper).
Once the download is done, you must rename the file and put `paper.jar` inside an empty folder.
</TabItem>
</Tabs>

Next, you must create a Terminal shell script file to be able to start your server and have access to its console.
Start by opening your preferred text editor, copy and paste the following example below, and save the file as `start.command`.
Expand Down Expand Up @@ -197,10 +215,18 @@ If you already have Java 21 installed, you may skip this step.
sudo apt update && sudo apt install openjdk-21-jdk
```

### Downloading SportPaper
### Downloading the Server Software

Get the latest version of SportPaper from the [Downloads](/downloads) page.
Once the download is done, you must rename the file and put `SportPaper.jar` inside an empty folder.
<Tabs groupId="server-versions">
<TabItem value="classic" label="Classic (1.8)">
Get the latest version of SportPaper from the [Downloads](/downloads) page.
Once the download is done, you must rename the file and put `SportPaper.jar` inside an empty folder.
</TabItem>
<TabItem value="modern" label="Modern (1.21+)">
Get the latest stable version of Paper from [PaperMC website](https://papermc.io/downloads/paper).
Once the download is done, you must rename the file and put `paper.jar` inside an empty folder.
</TabItem>
</Tabs>

Next, you must create a shell script file to be able to start your server and have access to its console.
Start by opening your preferred text editor, copy and paste the following example below, and save the file as `start.sh`.
Expand Down Expand Up @@ -295,14 +321,27 @@ experiments:

### Load and Configure WorldEdit

Some servers may choose to use [WorldEdit](https://dev.bukkit.org/projects/worldedit). Since SportPaper is based on Minecraft 1.8 server software, the latest compatible version of WorldEdit is [6.1.9](https://dev.bukkit.org/projects/worldedit/files/2597538).
Some servers may choose to use [WorldEdit](https://dev.bukkit.org/projects/worldedit).

Once the download is done, place `worldedit-bukkit-6.1.9.jar` inside the `plugins` folder and restart the server. Afterwards, you can navigate to `/plugins/WorldEdit/config.yml` and change the following option below to this value:
<Tabs groupId="server-versions">
<TabItem value="classic" label="Classic (1.8)">
Since SportPaper is based on Minecraft 1.8 server software, the latest compatible version of WorldEdit is [6.1.9](https://dev.bukkit.org/projects/worldedit/files/2597538).

```yml title="/plugins/WorldEdit/config.yml"
# PGM will give observers with OP the "Rabbit's Foot" item, which allows them to edit the world during a match.
wand-item: 414
Once the download is done, place `worldedit-bukkit-6.1.9.jar` inside the `plugins` folder and restart the server. Afterwards, you can navigate to `/plugins/WorldEdit/config.yml` and change the following option below to this value:

# On newer WorldEdit versions in combination with newer Minecraft versions, it will be the item's name.
wand-item: minecraft:rabbit_foot
```
```yml title="/plugins/WorldEdit/config.yml"
# PGM will give observers with OP the "Rabbit's Foot" item, which allows them to edit the world during a match.
wand-item: 414
```
</TabItem>
<TabItem value="modern" label="Modern (1.21+)">
You can get the latest version of WorldEdit for Paper from [Modrinth](https://modrinth.com/plugin/worldedit/versions?l=paper).

Once the download is done, place the WorldEdit jar inside the `plugins` folder and restart the server. Afterwards, you can navigate to `/plugins/WorldEdit/config.yml` and change the following option below to this value:

```yml title="/plugins/WorldEdit/config.yml"
# PGM will give observers with OP the "Rabbit's Foot" item, which allows them to edit the world during a match.
wand-item: minecraft:rabbit_foot
```
</TabItem>
</Tabs>
4 changes: 2 additions & 2 deletions docs/modules/gear/classes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Players can then change their class in game with the `/class` command.
|---|---|---|
| `<class> </class>` | A single player class. | <span className="badge badge--secondary">Class Sub-elements</span> |

##### Class Attributes
#### Class Attributes

| Attribute | Description | Value | Default |
|---|---|---|---|
Expand All @@ -29,7 +29,7 @@ Players can then change their class in game with the `/class` command.
| `default` | Specify if the class is the default class for new players.<br />*One class must be set as the default.* | <span className="badge badge--primary">true/false</span> | false |
| `restrict` | If set to `true`, only operators can use this class. | <span className="badge badge--primary">true/false</span> | false |

##### Class Sub-elements
#### Class Sub-elements

| Element | Description | Value |
|---|---|---|
Expand Down
Loading