From 0b9f50e7eaa5a67d8310057ae71d4265cfd04c5a Mon Sep 17 00:00:00 2001 From: Pear <20259871+TheRealPear@users.noreply.github.com> Date: Sun, 15 Feb 2026 01:30:09 -0500 Subject: [PATCH] Modernize server setup guide, document new features Signed-off-by: Pear <20259871+TheRealPear@users.noreply.github.com> --- .github/dependabot.yml | 18 +- docs/commands/main.mdx | 2 +- docs/guides/preparing/local-server-setup.mdx | 185 +++++++++++++------ docs/modules/gear/classes.mdx | 4 +- docs/modules/gear/items.mdx | 72 +++++--- docs/modules/mechanics/actions-triggers.mdx | 8 + docs/modules/objectives/control-points.mdx | 1 + docs/modules/objectives/ctf.mdx | 1 + docs/modules/objectives/ctw.mdx | 1 + docs/modules/objectives/dtc.mdx | 1 + docs/modules/objectives/dtm.mdx | 1 + docs/reference/misc/colors.mdx | 36 ++-- package-lock.json | 4 +- package.json | 4 +- src/pages/downloads/index.js | 8 +- src/pages/index.js | 6 +- 16 files changed, 231 insertions(+), 121 deletions(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index a1046b839..28153026d 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -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" diff --git a/docs/commands/main.mdx b/docs/commands/main.mdx index 690623477..ac1853eac 100644 --- a/docs/commands/main.mdx +++ b/docs/commands/main.mdx @@ -54,7 +54,7 @@ Permissions are prefixed with `Permissions` (i.e. `Permissions.ADMINCHAT`). | `/inventory` | inv
vi | View a player's inventory. | | `/list` | who
online
ls | View a list of online players. | | `/map` | mapinfo | Show info about a map. || [map name] - defaults to current map | -| `/maps` | maplist
ml | List all loaded maps. | -a author
-t tag1,tag2
-n name | +| `/maps` | maplist
ml | List all loaded maps. | -a author
-t tag1,tag2
-n name
-g gamemode | | `/match` | matchinfo | Show the match info. | | `/mode list` | page | List all objective modes. || [page] | | `/mode next` || Show the next objective mode. | diff --git a/docs/guides/preparing/local-server-setup.mdx b/docs/guides/preparing/local-server-setup.mdx index 15a3caa93..e98dc761f 100644 --- a/docs/guides/preparing/local-server-setup.mdx +++ b/docs/guides/preparing/local-server-setup.mdx @@ -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. @@ -19,9 +21,9 @@ This guide uses Windows 11, however, the same process will work on Windows 10 an ### Installing Java -We recommend using Java 21. For this guide, we will be using [Amazon Corretto 21](https://aws.amazon.com/corretto/). +We recommend using Java 25. For this guide, we will be using [Amazon Corretto](https://aws.amazon.com/corretto/). However, you may choose to use [OpenJDK](https://openjdk.org/) or [Eclipse Adoptium](https://adoptium.net/) instead. -If you already have Java 21 installed, you may skip this step. +If you already have Java installed, you may skip this step.
@@ -38,10 +40,18 @@ If you already have Java 21 installed, you may skip this step.
-### 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. + + + 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. + + + 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. + + 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`. @@ -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 ``` @@ -68,7 +78,7 @@ 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.
@@ -76,7 +86,7 @@ Once the download is done, you must put `PGM.jar` inside the `plugins` folder (c ### 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. @@ -91,9 +101,9 @@ This guide uses macOS 14 (Sonoma). Generally speaking, the process should be the ### Installing Java -We recommend using Java 21. For this guide, we will be using [Amazon Corretto 21](https://aws.amazon.com/corretto/). +We recommend using Java 25. For this guide, we will be using [Amazon Corretto](https://aws.amazon.com/corretto/). However, you may choose to use [OpenJDK](https://openjdk.org/) or [Eclipse Adoptium](https://adoptium.net/) instead. -If you already have Java 21 installed, you may skip this step. +If you already have Java installed, you may skip this step.
@@ -116,10 +126,18 @@ If you already have Java 21 installed, you may skip this step.
-### 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. + + + 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. + + + 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. + + 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`. @@ -189,18 +207,26 @@ Otherwise, we trust that you know what you are doing. ### Installing Java -We recommend using Java 21. For this guide, we will be using [OpenJDK](https://openjdk.org/). -However, you may choose to use [Amazon Corretto 21](https://aws.amazon.com/corretto/) or [Eclipse Adoptium](https://adoptium.net/) instead. -If you already have Java 21 installed, you may skip this step. +We recommend using Java 25. For this guide, we will be using [OpenJDK](https://openjdk.org/). +However, you may choose to use [Amazon Corretto](https://aws.amazon.com/corretto/) or [Eclipse Adoptium](https://adoptium.net/) instead. +If you already have Java installed, you may skip this step. ```bash -sudo apt update && sudo apt install openjdk-21-jdk +sudo apt update && sudo apt install openjdk-25-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. + + + 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. + + + 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. + + 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`. @@ -234,39 +260,63 @@ Also see [Additional Setup](#additional-setup) if you would like to make the mos ## Additional Setup -### Configure SportPaper - -Using your text editor of choice, you may edit `server.properties` and `sportpaper.yml`. We recommend changing the following options below to these values: - -```properties title="server.properties" -allow-nether=false -announce-player-achievements=false -generate-structures=false -``` - -```yml title="sportpaper.yml" -bukkit: - settings: - allow-end: false -spigot: - # Forcibly disable vanilla Minecraft achievements. - stats: - disable-saving: true - forced-stats: - achievement: - openInventory: 1 - world-settings: - anti-xray: - enabled: false # Helps with reducing lag; public servers should utilize an anti-cheat plugin. -paper: - settings: - empty-server-suspend: P100D # Prevent the server from immediately suspending itself due to inactivity. - world-settings: - fix-cannons: true # Stops ignited TNT from moving in flowing water. Recommended when making maps that involves TNT. - game-mechanics: - disable-chest-cat-detection: true # Helps with reducing lag. - optimize-explosions: true # Recommended when making maps that involves TNT. -``` +### Configure the Server Software + + + + Using your text editor of choice, you may edit `server.properties` and `sportpaper.yml`. We recommend changing the following options below to these values: + + ```properties title="server.properties" + announce-player-achievements=false + generate-structures=false + ``` + + ```yml title="sportpaper.yml" + spigot: + # Forcibly disable vanilla Minecraft achievements. + stats: + disable-saving: true + forced-stats: + achievement: + openInventory: 1 + world-settings: + anti-xray: + enabled: false # Helps with reducing lag; public servers should utilize an anti-cheat plugin. + paper: + settings: + empty-server-suspend: P100D # Prevent the server from immediately suspending itself due to inactivity. + world-settings: + fix-cannons: true # Stops ignited TNT from moving in flowing water. Recommended when making maps that involves TNT. + game-mechanics: + disable-chest-cat-detection: true # Helps with reducing lag. + optimize-explosions: true # Recommended when making maps that involves TNT. + ``` + + + Using your text editor of choice, you may edit `spigot.yml` and `/config/paper-world-defaults.yml`. We recommend changing the following options below to these values: + + ```yml title="spigot.yml" + # Forcibly disable vanilla Minecraft advancements. + advancements: + disable-saving: true + disabled: + - '*' + ``` + + ```yml title="/config/paper-world-defaults.yml" + anticheat: + anti-xray: + enabled: false # Helps with reducing lag; public servers should utilize an anti-cheat plugin. + entities: + behavior: + disable-chest-cat-detection: true # Helps with reducing lag. + environment: + optimize-explosions: true # Recommended when making maps that involves TNT. + fixes: + prevent-tnt-from-moving-in-water: true # Stops ignited TNT from moving in flowing water. Recommended when making maps that involves TNT. + ``` + + ### Configure PGM @@ -295,14 +345,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: + + + 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 + ``` + + + 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 + ``` + + diff --git a/docs/modules/gear/classes.mdx b/docs/modules/gear/classes.mdx index 8e9b74a36..26fd51ce4 100644 --- a/docs/modules/gear/classes.mdx +++ b/docs/modules/gear/classes.mdx @@ -16,7 +16,7 @@ Players can then change their class in game with the `/class` command. |---|---|---| | ` ` | A single player class. | Class Sub-elements | -##### Class Attributes +#### Class Attributes | Attribute | Description | Value | Default | |---|---|---|---| @@ -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.
*One class must be set as the default.* | true/false | false | | `restrict` | If set to `true`, only operators can use this class. | true/false | false | -##### Class Sub-elements +#### Class Sub-elements | Element | Description | Value | |---|---|---| diff --git a/docs/modules/gear/items.mdx b/docs/modules/gear/items.mdx index 8a9a05f2d..9cc478237 100644 --- a/docs/modules/gear/items.mdx +++ b/docs/modules/gear/items.mdx @@ -17,7 +17,7 @@ or on the [bukkit docs - Material](https://hub.spigotmc.org/javadocs/bukkit/org/ |---|---| | `` | A single item stack. | -### Sub-Elements +#### Sub-Elements | Element | Description | |---|---| @@ -27,7 +27,7 @@ or on the [bukkit docs - Material](https://hub.spigotmc.org/javadocs/bukkit/org/ | ` ` | Materials that can be mined with the item | | ` ` | Materials that the item can be placed on | -### Item Attributes +#### Item Attributes | Attribute | Description | Value | Default | |---|---|---|---| @@ -54,7 +54,7 @@ or on the [bukkit docs - Material](https://hub.spigotmc.org/javadocs/bukkit/org/ | `show-other` | Show various other things in the item tooltip. | true/false | true | Items can be give custom names and lore with the `name` and `lore` attributes. -Colors and fancy text in item names or lore can be specified with the grave symbol `` ` `` and then the [formatting code](/docs/reference/misc/formatting). +Colors and fancy text in item names or lore can be specified with the grave symbol `` ` `` and the [formatting code](/docs/reference/misc/formatting). You can specify multiple lines of lore using a pipe symbol `|` for line breaks. ```xml @@ -63,7 +63,7 @@ You can specify multiple lines of lore using a pipe symbol `|` for line breaks. ``` -### Custom Heads +## Custom Heads Player heads can be given to players by using the heads element. @@ -75,7 +75,7 @@ A player's skin data can be found by using `https://sessionserver.mojang.com/ses ``` -##### Head Attributes +#### Head Attributes | Attribute | Description | Value | |---|---|---| @@ -83,14 +83,14 @@ A player's skin data can be found by using `https://sessionserver.mojang.com/ses | `uuid` | PropertyRequiredThe UUID used to identify the player this head belongs to. | String | | `skin` | PropertyRequiredThe skin data used for this head. | Base64 | -##### Head Sub-elements +#### Head Sub-elements | Element | Description | Value | |---|---|---| | `` | PropertyRequiredThe UUID used to identify the player this head belongs to. | String | | `` | PropertyRequiredThe skin data used for this head. | Base64 | -### Banners +## Banners Custom banners can be given to the player using the banner element. @@ -102,13 +102,13 @@ Custom banners can be given to the player using the banner element. |---|---| | `` | Defines a specific pattern layer. | -##### Banner Attributes +#### Banner Attributes | Attribute | Description | Value | |---|---|---| | `base-color` | Defines the base color of the banner. | [Dye Color Name](/docs/reference/misc/colors) | -##### Pattern Attributes +#### Pattern Attributes | Attribute | Description | Value | |---|---|---| @@ -126,7 +126,7 @@ Custom banners can be given to the player using the banner element. ``` -### Armor +## Armor Armor slots have predefined tags to make it easier to give them to a player. They accept all of the properties of normal items and may have their own special attributes. @@ -138,7 +138,7 @@ They accept all of the properties of normal items and may have their own special ``` -##### Armor Attributes +#### Armor Attributes | Attribute | Description | Value | Default | |---|---|---|---| @@ -163,7 +163,7 @@ The hex color value is specified without the hash `#` symbol. ``` -###### Team Color Attribute +#### Team Color Attribute The `team-color` attribute can be used to add color to leather armor automatically. Armor color is based on the team's [Chat Color](/docs/reference/misc/formatting#chat-colors) rather @@ -182,7 +182,25 @@ This helps simplfy kits so a seperate team kit for colored armor and items is no ``` -### Potions +### Armor Trims + +As an alternative to `team-color`, armor trims are available in modern Minecraft versions for all armor materials. +By default, PGM will use the player's team color. + +```xml + + + + + + shaper + shaper + shaper + shaper + +``` + +## Potions Potion items, including lingering and splash potions, can specify their potion type and any number of custom effects. The potion type determines the name and color of the item. @@ -195,7 +213,7 @@ This behavior can be disabled with the `` tag. For more details on the `` element, visit [Potion Effects](/docs/modules/gear/potions). Additionally, you can visit [Potions & Effects](/docs/reference/items/potions) for references on potion effects available in Minecraft. -##### Potion Item Sub-elements +#### Potion Item Sub-elements | Element | Description | Value | |---|---|---| @@ -220,7 +238,7 @@ This feature is enabled by default, but can be disabled with this tag. ``` -### Books +## Books Written books can be created using the book element. The title, author, and individual pages can be formatted with [formatting codes](/docs/reference/misc/formatting). @@ -229,13 +247,13 @@ All normal item attributes can also be applied to books. Each page in a book can contain a maximum of 13 lines, with approximately 19 characters per line. Preferably, books should be written in-game to ensure proper formatting and then translated into the books element. -##### Book Element +#### Book Element | Element | Description | Value | |---|---|---| | `` | The element containing the books ``, `<author>`, and `<pages>`. | <span className="badge badge--primary">Formatted Text</span> | -##### Book Sub-elements +#### Book Sub-elements | Element | Description | Value | |---|---|---| @@ -263,7 +281,7 @@ Preferably, books should be written in-game to ensure proper formatting and then </book> ``` -### Firework +## Firework You can define custom explosion designs when creating and giving a firework rocket item. @@ -275,13 +293,13 @@ You can define custom explosion designs when creating and giving a firework rock |---|---| | `<firework> </firework>` | Define an explosion effect design. | -##### Firework Attributes +#### Firework Attributes | Attribute | Description | Value | Default | |---|---|---|---| | `power` | Defines the power of the firework. This also determines how high it will travel. | <span className="badge badge--primary">Number</span> | 1 | -##### Explosion Attributes +#### Explosion Attributes | Attribute | Description | Value | Default | |---|---|---|---| @@ -289,7 +307,7 @@ You can define custom explosion designs when creating and giving a firework rock | `flicker` | Whether the effect should flicker. | <span className="badge badge--primary">true/false</span> | false | | `trail` | Whether the effect should have a trail. | <span className="badge badge--primary">true/false</span> | false | -##### Explosion Sub-elements +#### Explosion Sub-elements | Element | Description | Value | |---|---|---| @@ -316,7 +334,7 @@ You can define custom explosion designs when creating and giving a firework rock </firework> ``` -### Enchantments +## Enchantments Any enchantment can be applied to any item and an item can have one or multiple enchantments. The enchantment type can be specified by its @@ -326,14 +344,14 @@ The enchantment type can be specified by its To store an enchantment in an enchanted book (instead of enchanting the book itself), simply replace the tag `enchantment` with `stored-enchantment`. -##### Enchantment Element +#### Enchantment Element | Element | Description | Value | |---|---|---| | `<enchantment> <enchantment>` | An item enchantment. | [Enchantment Name](/docs/reference/items/enchantments) | | `<stored-enchantment> </stored-enchantment>` | An enchantment stored in an enchanted book. | [Enchantment Name](/docs/reference/items/enchantments) | -##### Enchantment Attributes +#### Enchantment Attributes | Element | Description | Value | Default | |---|---|---|---| @@ -369,7 +387,7 @@ _Examples_ </item> ``` -### Attribute Modifiers +## Attribute Modifiers Attribute modifiers can be applied to items in the same way they are applied to kits. See [Attribute Kits](/docs/modules/gear/kits#attribute-modifier-kits-removable) for details. @@ -395,7 +413,7 @@ _Examples_ Negative attribute values are allowed, however, they sometimes do not work as expected. ::: -### Grenades +## Grenades The `grenade="true"` attribute will make the item explode on impact, just like a grenade. This option only works on items that can turn into projectiles. @@ -415,7 +433,7 @@ If an ender pearl is used as a grenade, the player will teleport to the location <item name="`a`lRocket Ammo" amount="3" enchantment="thorns" grenade="true" grenade-power="4" grenade-fire="true" material="arrow"/> ``` -### Can-Destroy / Can-Place-On +## Can-Destroy / Can-Place-On In adventure mode, no blocks can be placed or mined by default. The `<can-destroy>` element allows an item to mine a specified list of blocks. The `<can-place-on>` element allows a block item to be placed against a specified list of blocks. In each case, the blocks are listed inside diff --git a/docs/modules/mechanics/actions-triggers.mdx b/docs/modules/mechanics/actions-triggers.mdx index 3f6a03de3..924f5200b 100644 --- a/docs/modules/mechanics/actions-triggers.mdx +++ b/docs/modules/mechanics/actions-triggers.mdx @@ -26,6 +26,7 @@ In the future, some features that are currently used in Kits may be transferred | `<kit/>` | Applies a [Kit](/docs/modules/gear/kits). | | `<fill/>` | Places blocks in a block-bounded region. | | `<paste-structure/>` | Places a structure at a specified location when triggered. | +| `<open-shop/>` | Open a [shop](/docs/modules/gear/shops) menu when triggered. | | `<replace-item> </replace-item>` | Finds and replaces certain items. | | `<enchant-item> </enchant-item>` | Enchants the targeted item. | | `<take-payment> </take-payment>` | Allow players to pay with items in their inventory to trigger an action. | @@ -155,6 +156,12 @@ In the future, some features that are currently used in Kits may be transferred | `structure` | The structure to paste. | [Structure ID](/docs/modules/blocks/structures) | | `update` | Placed blocks will update upon interaction, e.g., redstone, and invalid block placements such as floating ladders, "popping" off. *May impact performance for large fills.* | <span className="badge badge--primary">true/false</span> | true | +### Open-Shop Attributes + +| Attribute | Description | Value | +|---|---|---| +| `shop` | The individual shop to open. | [Shop ID](/docs/modules/gear/shops) | + ### Replace-Item #### Sub-elements @@ -210,6 +217,7 @@ In the future, some features that are currently used in Kits may be transferred | Attribute | Description | Value | |---|---|---| +| `region` | The destination region to teleport the user to.<br />*This is available only for teleport action.* | [Region](/docs/modules/mechanics/regions) | | `x` | The X coordinate, measured in east-west. | <span className="badge badge--primary">Expression</span> | | `y` | The Y coordinate, measured in altitude. | <span className="badge badge--primary">Expression</span> | | `z` | The Z coordinate, measured in north-south. | <span className="badge badge--primary">Expression</span> | diff --git a/docs/modules/objectives/control-points.mdx b/docs/modules/objectives/control-points.mdx index 32f98a3cd..93a01ee3c 100644 --- a/docs/modules/objectives/control-points.mdx +++ b/docs/modules/objectives/control-points.mdx @@ -60,6 +60,7 @@ Other uses of control points include unlocking an area of the map using objectiv | `show-effects` | Play sounds, fireworks and other effects related to the control point. | <span className="badge badge--primary">true/false</span> | true | | `show-info` | Display the control point under commands such as `/match`. | <span className="badge badge--primary">true/false</span> | true | | `show-sidebar` | Displays the control point on scoreboard. | <span className="badge badge--primary">true/false</span> | true | +| `show-waypoint` | Displays a waypoint for the control point's location (in the controlling team's color) on the user's [locator bar](https://minecraft.wiki/w/Locator_Bar).<br />*Applicable to Minecraft 1.21.6 and later.* | <span className="badge badge--primary">true/false</span> | true | | `stats` | Determines if this control point counts as a win condition. | <span className="badge badge--primary">true/false</span> | true | | `show` | Specify if the control point should be hidden from all visible locations to the player. These locations include chat, the boss bar, and the scoreboard.<br />**Note:** This attribute sets all five values above to true/false. | <span className="badge badge--primary">true/false</span> | true | | `scoreboard-filter` | Determines when the objective should be displayed on the scoreboard. | [Dynamic Filter](/docs/modules/mechanics/filters#dynamic-filters) | | diff --git a/docs/modules/objectives/ctf.mdx b/docs/modules/objectives/ctf.mdx index ebd9d4158..8c26e0665 100644 --- a/docs/modules/objectives/ctf.mdx +++ b/docs/modules/objectives/ctf.mdx @@ -59,6 +59,7 @@ Filters can be used to control who can pickup/capture the flag and when. | `show-effects` | Play sounds, fireworks and other effects related to the flag. | <span className="badge badge--primary">true/false</span> | true | | `show-info` | Display the flag under commands such as `/match`. | <span className="badge badge--primary">true/false</span> | true | | `show-sidebar` | Displays the flag on scoreboard. | <span className="badge badge--primary">true/false</span> | true | +| `show-waypoint` | Displays a waypoint for the flag's location on the user's [locator bar](https://minecraft.wiki/w/Locator_Bar).<br />*Applicable to Minecraft 1.21.6 and later.* | <span className="badge badge--primary">true/false</span> | true | | `stats` | Determines if this flag counts as a win condition. | <span className="badge badge--primary">true/false</span> | true | | `show` | Specify if the flag should be hidden from all visible locations to the player. These locations include chat, the boss bar, and the scoreboard.<br />**Note:** This attribute sets all five values above to true/false. | <span className="badge badge--primary">true/false</span> | true | | `post` | <span className="badge badge--secondary" title="Can be this attribute or a sub-element.">Property</span><span className="badge badge--danger">Required</span>The flag's initial & default post. | [Flag Post](#posts) | diff --git a/docs/modules/objectives/ctw.mdx b/docs/modules/objectives/ctw.mdx index df03ce6e3..4d7e2e59f 100644 --- a/docs/modules/objectives/ctw.mdx +++ b/docs/modules/objectives/ctw.mdx @@ -46,6 +46,7 @@ The victory monument's area, where the wool block is placed, is protected by def | `show-effects` | Play sounds, fireworks, and other effects related to the wool. | <span className="badge badge--primary">true/false</span> | true | | `show-info` | Display the wool under commands such as `/match`. | <span className="badge badge--primary">true/false</span> | true | | `show-sidebar` | Displays the wool on scoreboard. | <span className="badge badge--primary">true/false</span> | true | +| `show-waypoint` | Displays a waypoint for the wool and monument location on the user's [locator bar](https://minecraft.wiki/w/Locator_Bar).<br />*Applicable to Minecraft 1.21.6 and later.* | <span className="badge badge--primary">true/false</span> | true | | `stats` | Determines if this wool counts as a win condition. | <span className="badge badge--primary">true/false</span> | true | | `show` | Specify if the wool should be hidden from all visible locations to the player. These locations include chat, the boss bar, and the scoreboard.<br />**Note:** This attribute sets all five values above to true/false. | <span className="badge badge--primary">true/false</span> | | `scoreboard-filter` | Determines when the objective should be displayed on the scoreboard. | [Dynamic Filter](/docs/modules/mechanics/filters#dynamic-filters) | | diff --git a/docs/modules/objectives/dtc.mdx b/docs/modules/objectives/dtc.mdx index 2848dfd86..468074922 100644 --- a/docs/modules/objectives/dtc.mdx +++ b/docs/modules/objectives/dtc.mdx @@ -38,6 +38,7 @@ This can also be avoided by keeping the lava far away enough from the core and n | `show-effects` | Play sounds, fireworks, and other effects related to the core. | <span className="badge badge--primary">true/false</span> | true | | `show-info` | Display the core under commands such as `/match`. | <span className="badge badge--primary">true/false</span> | true | | `show-sidebar` | Displays the core on scoreboard. | <span className="badge badge--primary">true/false</span> | true | +| `show-waypoint` | Displays a waypoint for the core's location on the user's [locator bar](https://minecraft.wiki/w/Locator_Bar).<br />*Applicable to Minecraft 1.21.6 and later.* | <span className="badge badge--primary">true/false</span> | true | | `stats` | Determines if this core counts as a win condition. | <span className="badge badge--primary">true/false</span> | true | | `show` | Specify if the core should be hidden from all visible locations to the player. These locations include chat, the boss bar, and the scoreboard.<br />**Note:** This attribute sets all five values above to true/false. | <span className="badge badge--primary">true/false</span> | true | | `scoreboard-filter` | Determines when the objective should be displayed on the scoreboard. | [Dynamic Filter](/docs/modules/mechanics/filters#dynamic-filters) | | diff --git a/docs/modules/objectives/dtm.mdx b/docs/modules/objectives/dtm.mdx index d3c48e1ab..564b3bedc 100644 --- a/docs/modules/objectives/dtm.mdx +++ b/docs/modules/objectives/dtm.mdx @@ -39,6 +39,7 @@ For example, if the monument is obsidian and completion is set to 100%, then all | `show-effects` | Play sounds, fireworks, and other effects related to the monument. | <span className="badge badge--primary">true/false</span> | true | | `show-info` | Display the monument under commands such as `/match`. | <span className="badge badge--primary">true/false</span> | true | | `show-sidebar` | Displays the monument on scoreboard. | <span className="badge badge--primary">true/false</span> | true | +| `show-waypoint` | Displays a waypoint for the monument's location on the user's [locator bar](https://minecraft.wiki/w/Locator_Bar).<br />*Applicable to Minecraft 1.21.6 and later.* | <span className="badge badge--primary">true/false</span> | true | | `stats` | Determines if this monument counts as a win condition. | <span className="badge badge--primary">true/false</span> | true | | `show` | Specify if the monument should be hidden from all visible locations to the player. These locations include chat, the boss bar, and the scoreboard.<br />**Note:** This attribute sets all five values above to true/false. | <span className="badge badge--primary">true/false</span> | true | | `scoreboard-filter` | Determines when the objective should be displayed on the scoreboard. | [Dynamic Filter](/docs/modules/mechanics/filters#dynamic-filters) | | diff --git a/docs/reference/misc/colors.mdx b/docs/reference/misc/colors.mdx index 790ab9e26..66c3ff798 100644 --- a/docs/reference/misc/colors.mdx +++ b/docs/reference/misc/colors.mdx @@ -8,23 +8,23 @@ The dye's HEX color can be used to color leather armor. Teams are created with the chat color names defined in [Text Formatting](/docs/reference/misc/formatting#chat-colors). However, you can use the [`dye-color` attribute](/docs/modules/format/teams#team-attributes) to force a specific dye color for an individual team. -| Color Name | `team-color`<br />Damage Value | Armor HEX Color | Firework HEX Color | -|---|---|---|---| -| WHITE | <span style={{color: "#E4E4E4"}}>■</span> 0 | `FFFFFF` | `F0F0F0` | -| ORANGE | <span style={{color: "#EA7e35"}}>■</span> 1 | `D87F33` | `EB8844` | -| MAGENTA | <span style={{color: "#BE49C9"}}>■</span> 2 | `B24CD8` | `C354CD` | -| LIGHT_BLUE | <span style={{color: "#6387D2"}}>■</span> 3 | `6699D8` | `6689D3` | -| YELLOW | <span style={{color: "#C2b51C"}}>■</span> 4 | `E5E533` | `DECF2A` | -| LIME | <span style={{color: "#39BA2E"}}>■</span> 5 | `7FCC19` | `41CD34` | -| PINK | <span style={{color: "#D98199"}}>■</span> 6 | `F27FA5` | `D88198` | -| GRAY | <span style={{color: "#414141"}}>■</span> 7 | `4C4C4C` | `434343` | -| SILVER | <span style={{color: "#A0A7A7"}}>■</span> 8 | `999999` | `ABABAB` | -| CYAN | <span style={{color: "#267191"}}>■</span> 9 | `4C7F99` | `287697` | -| PURPLE | <span style={{color: "#7E34BF"}}>■</span> 10 | `7F3FB2` | `7B2FBE` | -| BLUE | <span style={{color: "#253193"}}>■</span> 11 | `334CB2` | `253192` | -| BROWN | <span style={{color: "#56331C"}}>■</span> 12 | `664C33` | `51301A` | -| GREEN | <span style={{color: "#364B18"}}>■</span> 13 | `667F33` | `3B511A` | -| RED | <span style={{color: "#9E2B27"}}>■</span> 14 | `993333` | `B3312C` | -| BLACK | <span style={{color: "#181414"}}>■</span> 15 | `191919` | `1E1B1B` | +| Color Name | `team-color`<br />Damage Value | Armor HEX Color | Firework HEX Color | Armor Trim Material | +|---|---|---|---|---| +| WHITE | <span style={{color: "#E4E4E4"}}>■</span> 0 | `FFFFFF` | `F0F0F0` | quartz | +| ORANGE | <span style={{color: "#EA7e35"}}>■</span> 1 | `D87F33` | `EB8844` | resin | +| MAGENTA | <span style={{color: "#BE49C9"}}>■</span> 2 | `B24CD8` | `C354CD` | amethyst | +| LIGHT_BLUE | <span style={{color: "#6387D2"}}>■</span> 3 | `6699D8` | `6689D3` | lapis | +| YELLOW | <span style={{color: "#C2b51C"}}>■</span> 4 | `E5E533` | `DECF2A` | gold | +| LIME | <span style={{color: "#39BA2E"}}>■</span> 5 | `7FCC19` | `41CD34` | emerald | +| PINK | <span style={{color: "#D98199"}}>■</span> 6 | `F27FA5` | `D88198` | redstone | +| GRAY | <span style={{color: "#414141"}}>■</span> 7 | `4C4C4C` | `434343` | netherite | +| SILVER | <span style={{color: "#A0A7A7"}}>■</span> 8 | `999999` | `ABABAB` | copper | +| CYAN | <span style={{color: "#267191"}}>■</span> 9 | `4C7F99` | `287697` | diamond | +| PURPLE | <span style={{color: "#7E34BF"}}>■</span> 10 | `7F3FB2` | `7B2FBE` | amethyst | +| BLUE | <span style={{color: "#253193"}}>■</span> 11 | `334CB2` | `253192` | lapis | +| BROWN | <span style={{color: "#56331C"}}>■</span> 12 | `664C33` | `51301A` | +| GREEN | <span style={{color: "#364B18"}}>■</span> 13 | `667F33` | `3B511A` | emerald | +| RED | <span style={{color: "#9E2B27"}}>■</span> 14 | `993333` | `B3312C` | redstone | +| BLACK | <span style={{color: "#181414"}}>■</span> 15 | `191919` | `1E1B1B` | netherite | Copied from: [bukkit docs - Dye Color](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/DyeColor.html) diff --git a/package-lock.json b/package-lock.json index 80f9c85d9..7d2cecd56 100644 --- a/package-lock.json +++ b/package-lock.json @@ -20,11 +20,11 @@ "clsx": "^2.1.1", "date-fns": "^4.1.0", "prism-react-renderer": "^2.4.1", - "react": "^19.2.4", + "react": "^19.2.5", "react-dom": "^19.2.5" }, "devDependencies": { - "@docusaurus/module-type-aliases": "^3.9.2" + "@docusaurus/module-type-aliases": "^3.10.0" }, "engines": { "node": ">=22.0" diff --git a/package.json b/package.json index da4989df7..f3552c95d 100644 --- a/package.json +++ b/package.json @@ -31,11 +31,11 @@ "clsx": "^2.1.1", "date-fns": "^4.1.0", "prism-react-renderer": "^2.4.1", - "react": "^19.2.4", + "react": "^19.2.5", "react-dom": "^19.2.5" }, "devDependencies": { - "@docusaurus/module-type-aliases": "^3.9.2" + "@docusaurus/module-type-aliases": "^3.10.0" }, "browserslist": { "production": [ diff --git a/src/pages/downloads/index.js b/src/pages/downloads/index.js index c9c555839..517f1a37f 100644 --- a/src/pages/downloads/index.js +++ b/src/pages/downloads/index.js @@ -1,4 +1,4 @@ -import React, { useState, useEffect } from "react"; +import { useState, useEffect } from "react"; import Layout from "@theme/Layout"; import { format } from "date-fns"; @@ -94,7 +94,7 @@ export default function Downloads() { "button button--primary", styles.download_button )} - href={"https://nightly.link/PGMDev/PGM/workflows/build/dev/PGM.jar.zip"} + href={"https://dl.pgm.fyi/download/pgm"} title={"Latest build directly from GitHub.\nContains all the latest features, may occasionally bring new bugs."} > Download <FontAwesomeIcon icon={faDownload} /> @@ -119,7 +119,7 @@ export default function Downloads() { "button button--primary", styles.download_button )} - href={"https://repo.pgm.fyi/#/snapshots/app/ashcon/sportpaper/1.8.8-R0.1-SNAPSHOT"} + href={"https://dl.pgm.fyi/download/sportpaper"} > Download <FontAwesomeIcon icon={faDownload} /> </a> @@ -194,7 +194,7 @@ export default function Downloads() { "button button--primary", styles.others_button )} - href={"https://nightly.link/PGMDev/Community/workflows/build/dev/Community.jar.zip"} + href={"https://dl.pgm.fyi/download/community"} > Download <FontAwesomeIcon icon={faDownload} /> </a> diff --git a/src/pages/index.js b/src/pages/index.js index e15782ac6..6722ed683 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -12,7 +12,7 @@ const features = [ imageUrl: "img/ok-hand.svg", description: ( <> - Unlike the original release, PGM 1.8 is much easier to use. It has no + Unlike the original release, PGM is much easier to use. It has no backend, website, or API to make hosting more cost-effective. </> ), @@ -34,8 +34,8 @@ const features = [ imageUrl: "img/handshake.svg", description: ( <> - Be part of a community of over 20 contributors and help keep the project - alive! Our <a href="https://discord.gg/pEEcwTk">Discord server</a> is + Be part of our growing community of contributors and help keep the project alive! + Our <a href="https://discord.gg/pEEcwTk">Discord server</a> is the best place to discuss bug fixes and implementations in real time. </> ),