From a168281be854898d416e917fc86e737a7df6dde2 Mon Sep 17 00:00:00 2001 From: Pear <20259871+TheRealPear@users.noreply.github.com> Date: Mon, 14 Oct 2024 23:29:07 -0400 Subject: [PATCH] Document proto 1.5.0 (#151) * Document proto 1.5.0 Signed-off-by: Pear <20259871+TheRealPear@users.noreply.github.com> * Implement CoWink's suggested change Co-authored-by: Patrick Signed-off-by: Pear <20259871+TheRealPear@users.noreply.github.com> * Delete extra word Signed-off-by: Pear <20259871+TheRealPear@users.noreply.github.com> * Implement Pablo's suggested change (part 1) Co-authored-by: Pablo Herrera Signed-off-by: Pear <20259871+TheRealPear@users.noreply.github.com> * Implement Pablo's suggested change (part 2) Signed-off-by: Pear <20259871+TheRealPear@users.noreply.github.com> * Adjust untrigger notes Based on updates in PGMDev/PGM#1411 Signed-off-by: Pear <20259871+TheRealPear@users.noreply.github.com> * Fix XML issue in Race for Victory example Signed-off-by: Pear <20259871+TheRealPear@users.noreply.github.com> --------- Signed-off-by: Pear <20259871+TheRealPear@users.noreply.github.com> Co-authored-by: Patrick Co-authored-by: Pablo Herrera --- docs/examples/airship-battle.mdx | 2 +- docs/examples/harb.mdx | 2 +- docs/examples/ozone.mdx | 2 +- docs/examples/race-for-victory.mdx | 6 +-- docs/examples/the-fenland.mdx | 2 +- docs/examples/warlock.mdx | 2 +- docs/guides/preparing/local-server-setup.mdx | 2 +- docs/guides/xml-pointers/conventions.mdx | 15 +++--- docs/modules/general/main.mdx | 2 +- docs/modules/general/proto.mdx | 49 +++++++++++++++++--- docusaurus.config.js | 2 +- package-lock.json | 6 +-- 12 files changed, 65 insertions(+), 27 deletions(-) diff --git a/docs/examples/airship-battle.mdx b/docs/examples/airship-battle.mdx index 40be953e..7b70f3d4 100644 --- a/docs/examples/airship-battle.mdx +++ b/docs/examples/airship-battle.mdx @@ -26,7 +26,7 @@ Make the lava leak by destroying the obsidian blocks containing it and other obs Every map XML file starts with the XML header and then the base `` module. ```xml - + Airship Battle diff --git a/docs/examples/harb.mdx b/docs/examples/harb.mdx index 232de1d8..9d91f0ef 100644 --- a/docs/examples/harb.mdx +++ b/docs/examples/harb.mdx @@ -20,7 +20,7 @@ _The large spawn island for harb, where players initially spawn at when the map Every map XML file starts with the XML header and then the base `` module. ```xml - + Harb diff --git a/docs/examples/ozone.mdx b/docs/examples/ozone.mdx index 3821619f..3eab2134 100644 --- a/docs/examples/ozone.mdx +++ b/docs/examples/ozone.mdx @@ -21,7 +21,7 @@ _This map was copied in 1/4th sections._ Every map XML file starts with the XML header and then the base `` module. ```xml - + Ozone FFA diff --git a/docs/examples/race-for-victory.mdx b/docs/examples/race-for-victory.mdx index 89c398e7..03fc70b1 100644 --- a/docs/examples/race-for-victory.mdx +++ b/docs/examples/race-for-victory.mdx @@ -31,11 +31,11 @@ to help their way back to base!_ Every map XML file starts with the XML header and then the base `` module. ```xml - + Race for Victory -1.2.4 +1.2.5 Take the enemy's wool located to either side of the enemy's base and place it in your victory monument. @@ -175,7 +175,7 @@ Define regions that can be later used to apply spawns, filters, etc. - + diff --git a/docs/examples/the-fenland.mdx b/docs/examples/the-fenland.mdx index ea7c0d86..456e41c4 100644 --- a/docs/examples/the-fenland.mdx +++ b/docs/examples/the-fenland.mdx @@ -21,7 +21,7 @@ All players spawn with diamond pickaxes necessary to break them._ Every map XML file starts with the XML header and then the base `` module. ```xml - + The Fenland diff --git a/docs/examples/warlock.mdx b/docs/examples/warlock.mdx index 361d0bd6..7fdf33f3 100644 --- a/docs/examples/warlock.mdx +++ b/docs/examples/warlock.mdx @@ -19,7 +19,7 @@ _The monument is obsidian protected by stone bricks and a wooden pressure plate Every map XML file starts with the XML header and then the base `` module. ```xml - + Warlock diff --git a/docs/guides/preparing/local-server-setup.mdx b/docs/guides/preparing/local-server-setup.mdx index ddbe9d18..0edba6e3 100644 --- a/docs/guides/preparing/local-server-setup.mdx +++ b/docs/guides/preparing/local-server-setup.mdx @@ -285,7 +285,7 @@ map: # List of git repositories to load maps. # When using multiple GitHub repositories hosted by PGM networks, beware of duplicate maps. - uri: "https://github.com/PGMDev/Maps" - path: "sample-github-maps" + path: "sample-github-maps" # Experimental features that are not yet stable. experiments: diff --git a/docs/guides/xml-pointers/conventions.mdx b/docs/guides/xml-pointers/conventions.mdx index b4c7a04e..f128743c 100644 --- a/docs/guides/xml-pointers/conventions.mdx +++ b/docs/guides/xml-pointers/conventions.mdx @@ -11,7 +11,7 @@ Modules must all start on column one. This means that all children tags under the `` tag must be aligned with said `` tag. ```xml - + Blocks DTC 1.3.4 Leak lava from the enemy's obsidian core. @@ -23,7 +23,7 @@ This means that all children tags under the `` tag must be aligned with sai Modules that have sub elements such as the `author` tag must be indented with 4 spaces below the parent element. ```xml - + ... @@ -38,7 +38,7 @@ That means the end of one module should have the start of another on the immedia ```xml - + Blocks DTC 1.3.4 Leak lava from the enemy's obsidian core. @@ -47,7 +47,7 @@ That means the end of one module should have the start of another on the immedia ```xml - + Blocks DTC @@ -90,7 +90,7 @@ Contributors are optional but are still to remain near the top of a XML file. ::: ```xml - + Blocks DTC 1.3.4 Leak lava from the enemy's obsidian core. @@ -105,10 +105,11 @@ Contributors are optional but are still to remain near the top of a XML file. ### The Protocol -All maps should use the latest [protocol version](/docs/modules/general/proto). The proto version can be defined with this line: +All maps should use the latest [protocol version](/docs/modules/general/proto). +The proto version can be defined with this line: ```xml - + ``` ### Authors and Contributors diff --git a/docs/modules/general/main.mdx b/docs/modules/general/main.mdx index bd0e0d2a..0114eff6 100644 --- a/docs/modules/general/main.mdx +++ b/docs/modules/general/main.mdx @@ -41,7 +41,7 @@ The maps version should follow the versioning schema `major.minor.patch`. | `` | The gamemode(s) of this map. If this is not specified the map will set the gamemode(s) to whatever modules are used. | Gamemode ID | ```xml - + Map Name 1.0.0 Short description about the map's objective. diff --git a/docs/modules/general/proto.mdx b/docs/modules/general/proto.mdx index 5ed3612b..c0def2ef 100644 --- a/docs/modules/general/proto.mdx +++ b/docs/modules/general/proto.mdx @@ -1,12 +1,11 @@ --- id: proto title: Protocol Versions -description: The proto attribute specifies what iteration of PGM a certain XML document was created for. It also instructs PGM on whether to allow the usage of deprecated or newly introduced features within a map. toc_max_heading_level: 4 --- -The `proto=""` attribute specifies what iteration of PGM a certain XML document was created for. -It also instructs PGM on whether to allow the usage of deprecated or newly introduced features within a map. +The proto attribute specifies what iteration of PGM a certain XML document was created for. +It instructs PGM on whether to allow the usage of deprecated or newly introduced features within a map. If the value is lower than the currently recommended proto version, the map will load but the XML may be interpreted in an outdated and unexpected ways. Mapmakers should always use the latest supported proto version, and this may be required of new maps that are to be added to any map compilation projects, such as [ResourcePile](https://mcresourcepile.github.io). @@ -21,12 +20,13 @@ Mapmakers should always use the latest supported proto version, and this may be | Attribute | Description | Value | |---|---|---| -| `proto` | RequiredThe map XML's protocol version. | Recommended`1.4.2` | +| `proto` | RequiredThe map XML's protocol version. | Recommended`1.5.0` | ##### Map Protocol Values | Version | Description | |---|---| +| `1.5.0` | Refer to [Changes in 1.5.0](#changes-in-150). | | `1.4.2` | Refer to [Changes in 1.4.2](#changes-in-142). | | `1.4.1` | No change in features on PGM. Use `1.4.0` or `1.4.2` instead. | | `1.4.0` | Filters, regions, and teams are always referenced by its ID (replaces `name`).
Disallows `