### Simple Match Format Configuration (XML)

Source: https://github.com/pgmdev/website/blob/master/docs/events/examples.mdx

This XML snippet defines a simple match format where the first player to win 2 matches wins the round. It's a basic 'best-of-3' setup.

```xml
<format best-of="3">
    <match>Facility TE</match>
    <match>Ascendance</match>
    <match>Limbo II</match>
</format>
```

--------------------------------

### XML Kit and Action Definition Example

Source: https://github.com/pgmdev/website/blob/master/docs/modules/mechanics/actions-triggers.mdx

This example demonstrates how to define a kit with items and actions, and how to set up actions that can be triggered. It includes nested scope switching for messages and kit distribution within a team.

```xml
<kits>
    <kit id="spawn">
        <item slot="0" unbreakable="true" material="stone sword"/>
        <action>
            <message text="You were given a kit!"/>
        </action>
    </kit>
</kits>
<actions>
    <action id="do-stuff" scope="player">
        <!-- Gives the player who activated the trigger a diamond -->
        <message text="You've been given a diamond!"/>
        <kit>
            <item material="diamond"/>
        </kit>
        <!-- Sends a message to the player's message -->
        <switch-scope outer="player" inner="team">
            <message text="Your team has been given the spawn kit!"/>
            <!-- Gives each player in the team a kit (Kits are applied per player) -->
            <switch-scope outer="team" inner="player">
                <kit id="spawn"/>
            </switch-scope>
        </switch-scope>
    </action>
    <trigger filter="some-dynamic-filter" action="do-stuff" scope="player"/>
    <message id="standalone-text" text="This is a standalone text trigger"/>
    <trigger filter="another-dynamic-filter" action="standalone-text" scope="player"/>
</actions>
```

--------------------------------

### Install OpenJDK 21 (Bash)

Source: https://github.com/pgmdev/website/blob/master/docs/guides/preparing/local-server-setup.mdx

This command installs OpenJDK 21 on Debian-based Linux distributions. It first updates the package list and then installs the Java Development Kit. This is a prerequisite for running the SportPaper server on Linux.

```bash
sudo apt update && sudo apt install openjdk-21-jdk
```

--------------------------------

### XML World Border Configuration Examples

Source: https://github.com/pgmdev/website/blob/master/docs/modules/environment/border.mdx

Demonstrates how to configure world borders using XML. Includes examples for time-based shrinking borders and dynamically controlled borders based on game objectives.

```xml
<world-borders center="6.5, -36.5">
    <!-- Typical time-based shrinking border. Starts at 200 meters when the match loads. -->
    <!-- After 5 minutes, it starts shrinking, until it is 20 meters wide at 15 minutes. -->
    <world-border size="200"/>
    <world-border size="20" after="5m" duration="10m"/>
</world-borders>

<!-- Borders can be controlled with filters (and will update dynamically). This is -->
<!-- roughly how you would move a deadly border depending on which team controls a hill -->
<world-borders size="50" damage="20">
    <world-border center="30, 0">
        <when>
            <objective team="red-team">control-point</objective>
        </when>
    </world-border>
    <world-border center="-30, 0">
        <when>
            <objective team="blue-team">control-point</objective>
        </when>
    </world-border>
</world-borders>
```

--------------------------------

### Make Server Start Script Executable (Bash)

Source: https://github.com/pgmdev/website/blob/master/docs/guides/preparing/local-server-setup.mdx

This command makes the server start script executable. You need to replace '<path to your start.command file>' with the actual path to your script. This is a necessary step before running the script.

```bash
chmod a+x <path to your start.command file>
```

--------------------------------

### XML Potion Customization Examples

Source: https://github.com/pgmdev/website/blob/master/docs/reference/items/potions.mdx

These examples demonstrate how to create custom potions in XML by specifying damage values for base potion types and effects, and how to override default durations and amplifiers.

```xml
<item amount="1" material="potion" damage="16386" name="Super Speed">
    <!-- Overwrites original three minute Speed I effect -->
    <effect duration="1m" amplifier="2">speed</effect>
</item>

<!-- 16384 + 5 = 16389 -->
<!-- Splash potion + Healing color = Splash Potion of Instant Health I -->
<item amount="1" material="potion" damage="16389">
    <effect amplifier="1">instant_health</effect>
</item>
```

```xml
<!-- Strength potion color -->
<item material="potion" damage="9">
    <effect amplifier="3" duration="100">absorption</effect>
    <effect amplifier="1" duration="30">fast_digging</effect>
    <effect amplifier="2" duration="30">speed</effect>
    <!-- Strength potion effect is not applied at all -->
</item>
```

--------------------------------

### Create SportPaper Server Start Script (Bash)

Source: https://github.com/pgmdev/website/blob/master/docs/guides/preparing/local-server-setup.mdx

This bash script is used to start the SportPaper server. It navigates to the script's directory, sets Java memory allocation, and runs the SportPaper JAR file with specific terminal settings. Ensure SportPaper.jar is in the same directory.

```bash
#!/bin/sh

cd "$( dirname "$0" )"
java -Xms128M -Xmx2G -Dterminal.jline=false -Dterminal.ansi=true -jar SportPaper.jar nogui
```

--------------------------------

### Region Mirror Example - XML

Source: https://github.com/pgmdev/website/blob/master/docs/modules/mechanics/regions.mdx

An example showcasing the 'mirror' transformation to create a symmetrical region. This example defines an 'underside' region and mirrors it to cover both sides.

```xml
<regions>
    <apply block="never" message="You may not under-bridge!">
        <region>
            <cuboid id="red-underside" min="-oo,-oo,-oo" max="oo,41,40"/>
            <mirror origin="116,44,93" normal="0,0,1">
                <region id="red-underside"/>
            </mirror>
            <below y="37"/>
        </region>
    </apply>
</regions>
```

--------------------------------

### Start SportPaper Server Script (Bash)

Source: https://github.com/pgmdev/website/blob/master/docs/guides/preparing/local-server-setup.mdx

This bash script is used to start the SportPaper server. It sets JVM memory arguments, disables JLine and ANSI terminals, and runs the SportPaper.jar file in nogui mode. Ensure SportPaper.jar is in the same directory.

```bash
#!/bin/sh

java -Xms128M -Xmx2G -Dterminal.jline=false -Dterminal.ansi=true -jar SportPaper.jar nogui
```

--------------------------------

### Set Player Walk Speed with Kit

Source: https://github.com/pgmdev/website/blob/master/docs/modules/gear/kits.mdx

These XML examples show how to adjust a player's walk speed using the walk-speed kit. The value is a multiplier of the normal walking speed, with examples for increasing and decreasing speed.

```xml
<kit id="rabbit">
    <!-- 1.8 times faster than a normal player -->
    <walk-speed>1.8</walk-speed>
</kit>

<kit id="tortoise">
    <!-- half as fast as a normal player -->
    <walk-speed>0.5</walk-speed>
</kit>
```

--------------------------------

### XML Basic Armor Setup

Source: https://github.com/pgmdev/website/blob/master/docs/modules/gear/items.mdx

Assigns basic armor pieces to player slots using predefined material tags. This is a fundamental way to equip players with armor.

```xml
<helmet material="iron helmet"/>
<chestplate material="diamond chestplate"/>
<leggings material="gold leggings"/>
<boots material="leather boots"/>
```

--------------------------------

### Smelt Recipe Example (XML)

Source: https://github.com/pgmdev/website/blob/master/docs/modules/gear/crafting.mdx

An example of a smelt recipe in XML format. This defines the input ingredient and the resulting output material and amount when smelted in a furnace. Smelt recipes accept only a single ingredient.

```xml
<crafting>
    <smelt>
        <result amount="16" material="torch"/>
        <ingredient>stick</ingredient>
    </smelt>
</crafting>
```

--------------------------------

### Start Minecraft Server with SportPaper (Batch)

Source: https://github.com/pgmdev/website/blob/master/docs/guides/preparing/local-server-setup.mdx

This batch script is used to start a Minecraft server running SportPaper. It sets Java memory allocation, terminal properties, and specifies the server JAR file. Ensure 'SportPaper.jar' is in the same directory and the file is saved as 'start.bat'.

```batch
@ECHO OFF
TITLE SportPaper 1.8
java -Xms128M -Xmx2G -Dterminal.jline=false -Dterminal.ansi=true -jar SportPaper.jar nogui
PAUSE
```

--------------------------------

### XML Examples for Translatable Objective Names and Descriptors

Source: https://github.com/pgmdev/website/blob/master/docs/reference/misc/objective-names.mdx

Demonstrates how to use translatable objective names and descriptor patterns within XML configurations. These examples show how specific names are localized for different languages, such as Spanish and French.

```xml
<!-- Displays as "Adelante" to players using European Spanish -->
<control-point name="Front" capture-time="20s">
<!-- Displays as "Motor A" in European Spanish -->
<destroyable name="Engine A">
<!-- Displays as "Red Drapeau" in French -->
<flag name="Red Flag" id="red-flag" owner="red-team">
<!-- Displays as "Arrière Vaisseau" in French -->
<!-- Note that adjectives aren't swapped properly yet -->
<destroyable name="Rear Ship" id="blue-mon" owner="blue-team"/>
```

--------------------------------

### XML Configuration for Fly Kit

Source: https://github.com/pgmdev/website/blob/master/docs/modules/gear/kits.mdx

This snippet demonstrates how to configure the Fly Kit using XML. It shows examples of enabling/disabling flight, controlling the flying state, and setting fly speed.

```xml
<kit id="fly">
    <fly/> <!-- Allow player to fly -->
    <fly can-fly="false"/> <!-- Do not allow player to fly -->
    <fly flying="true"/> <!-- Make the player fly right away -->
    <fly flying="false"/> <!-- Make the player stop flying right away -->
</kit>
```

--------------------------------

### Half-space Region Example (XML)

Source: https://github.com/pgmdev/website/blob/master/docs/modules/mechanics/regions.mdx

Provides an example of defining a half-space region with a diagonal boundary using origin and normal attributes.

```xml
<half origin="5,0,0" normal="1,1,0"/>
```

--------------------------------

### Match Format with Veto System (XML)

Source: https://github.com/pgmdev/website/blob/master/docs/events/examples.mdx

This XML snippet illustrates a 'best-of-3' match format incorporating a veto system. It includes options for matches and rules for banning.

```xml
<format best-of="3">
    <veto>
        <decider>
            <match id="veto-decider">No Return</match>
        </decider>
        <options>
            <match>Ascendance 02</match>
            <match>Facility TE</match>
            <match>Nartica</match>
            <match>Desert Sanctuary</match>
            <match>Smoke</match>
        </options>
        <order ban-until="3" starting-team="2" />
    </veto>
</format>
```

--------------------------------

### Broadcast Message Examples (XML)

Source: https://github.com/pgmdev/website/blob/master/docs/modules/information/broadcasts.mdx

Demonstrates various ways to configure broadcast messages using <tip> and <alert> tags with attributes like 'after', 'every', and 'count'.

```xml
<broadcasts>
    <tip after="30s">A [Tip] displayed 30 seconds into the match</tip>
    <alert after="5m">An [Alert] displayed after 5 minutes</alert>
    <tip after="10m" count="3">Repeated [Tip] at 10m, 20m, and 30m</tip>
    <tip after="99s" count="oo">Repeated every 99 seconds, forever</tip>
    <tip after="20m" every="1m">Displayed at 20m and every minute after that</tip>
    <tip after="30m" every="10m" count="3">At 30m, 40m, and 50m</tip>
</broadcasts>
```

--------------------------------

### Shapeless Crafting Recipe Example (XML)

Source: https://github.com/pgmdev/website/blob/master/docs/modules/gear/crafting.mdx

An example of a shapeless crafting recipe in XML format. It defines a result material and a list of ingredients, where the 'amount' attribute specifies the quantity of an ingredient and can include item data.

```xml
<crafting>
    <shapeless>
        <result material="redstone"/>
        <ingredient>sugar</ingredient>
        <ingredient amount="3">ink sack:1</ingredient>
    </shapeless>
</crafting>
```

--------------------------------

### Destroy the Core Map Example (XML)

Source: https://context7.com/pgmdev/website/llms.txt

A complete XML map configuration for a 'Destroy the Core' game mode in PGM. This example demonstrates defining map properties, teams, kits, spawn points, regions, core objectives, and various game mechanics.

```xml
<?xml version="1.0"?>
<map proto="1.5.0">
    <name>Battle Arena</name>
    <version>1.0.0</version>
    <created>2024-01-15</created>
    <objective>Leak lava from the enemy's core into the void.</objective>
    <authors>
        <author uuid="ef4ea031-998f-4ec9-b7b6-1bdd428bcef8"/>
    </authors>

    <teams>
        <team id="red-team" color="dark red" max="16">Red</team>
        <team id="blue-team" color="blue" max="16">Blue</team>
    </teams>

    <kits>
        <kit id="spawn-kit">
            <item slot="0" material="iron sword"/>
            <item slot="1" material="bow"/>
            <item slot="2" material="diamond pickaxe"/>
            <item slot="8" amount="64" material="cooked beef"/>
            <item slot="28" amount="64" material="arrow"/>
            <helmet material="iron helmet"/>
            <chestplate material="chainmail chestplate"/>
            <leggings team-color="true" material="leather leggings"/>
            <boots team-color="true" material="leather boots"/>
        </kit>
    </kits>

    <spawns>
        <spawn team="red-team" kit="spawn-kit" yaw="90">
            <regions><cuboid min="-50,10,0" max="-45,10,5"/></regions>
        </spawn>
        <spawn team="blue-team" kit="spawn-kit" yaw="-90">
            <regions><cuboid min="45,10,0" max="50,10,5"/></regions>
        </spawn>
        <default yaw="180">
            <regions><cylinder base="0,50,0" radius="3" height="0"/></regions>
        </default>
    </spawns>

    <filters>
        <team id="only-red">red-team</team>
        <team id="only-blue">blue-team</team>
        <deny id="deny-obsidian"><material>obsidian</material></deny>
    </filters>

    <regions>
        <cuboid id="red-core" min="-60,20,-5" max="-55,25,5"/>
        <cuboid id="blue-core" min="55,20,-5" max="60,25,5"/>
        <rectangle id="play-area" min="-100,-50" max="100,50"/>

        <complement id="no-obsidian-area">
            <region id="play-area"/>
            <region id="red-core"/>
            <region id="blue-core"/>
        </complement>

        <apply region="no-obsidian-area" block-break="deny-obsidian"/>
        <apply region="play-area" leave="never" message="Stay in the arena!"/>
    </regions>

    <cores material="obsidian" leak="5">
        <core team="red-team" region="red-core"/>
        <core team="blue-team" region="blue-core"/>
    </cores>

    <toolrepair>
        <tool>iron sword</tool>
        <tool>bow</tool>
        <tool>diamond pickaxe</tool>
    </toolrepair>

    <itemremove>
        <item>iron helmet</item>
        <item>chainmail chestplate</item>
        <item>leather leggings</item>
        <item>leather boots</item>
        <item>arrow</item>
    </itemremove>

    <kill-rewards>
        <kill-reward>
            <item amount="8" material="arrow"/>
            <item material="golden apple"/>
        </kill-reward>
    </kill-rewards>

    <maxbuildheight>100</maxbuildheight>
    <respawn delay="4s" auto="true"/>
    <time result="objectives">30m</time>
</map>
```

--------------------------------

### Kit Configuration (XML)

Source: https://github.com/pgmdev/website/blob/master/docs/examples/warlock.mdx

Defines the equipment and effects players receive upon spawning. This includes weapons, armor, consumables, and status effects, ensuring a balanced starting loadout.

```xml
<kits>
    <kit id="spawn-kit">
        <clear/>
        <item slot="0" unbreakable="true" material="iron sword"/>
        <item slot="1" unbreakable="true" material="bow">
            <enchantment>infinity</enchantment>
        </item>
        <item slot="2" unbreakable="true" material="diamond pickaxe"/>
        <item slot="3" unbreakable="true" material="iron axe"/>
        <item slot="4" amount="64" material="glass"/>
        <item slot="5" damage="2" amount="64" material="wood"/> <!-- To get birch planks, damage must be "2" -->
        <item slot="6" amount="2" material="gold nugget"/>
        <item slot="28" material="arrow"/>
        <item slot="30" unbreakable="true" material="iron spade"/>
        <helmet unbreakable="true" team-color="true" material="leather helmet"/>
        <chestplate unbreakable="true" team-color="true" material="leather chestplate">
            <enchantment level="2">protection projectile</enchantment>
        </chestplate>
        <leggings unbreakable="true" team-color="true" material="leather leggings"/>
        <boots unbreakable="true" team-color="true" material="leather boots"/>
        <effect duration="2">heal</effect>
        <effect duration="4">damage resistance</effect>
    </kit>
</kits>
```

--------------------------------

### Kill-Streak Filter Examples (XML)

Source: https://github.com/pgmdev/website/blob/master/docs/modules/mechanics/filters.mdx

Demonstrates how to use the kill-streak filter with 'min', 'max', and 'count' attributes to match players based on their kill count. The 'repeat' and 'persistent' attributes can also be configured.

```XML
<kill-streak min="3"/> <!-- matches players with at least 3 kills -->
<kill-streak max="5"/> <!-- matches players with at most 5 kills -->
<kill-streak count="4"/> <!-- matches players with exactly 4 kills -->
<kill-streak repeat="true" count="10"/> <!-- match for every 10th kill -->
```

--------------------------------

### Match Phase Filter Options

Source: https://github.com/pgmdev/website/blob/master/docs/modules/mechanics/filters.mdx

Matches for specific states of a match, such as started, running, or finished. More specific filters like `<match-started/>` are recommended over the generic `<match-phase>` tag.

```xml
<!-- Filter if the match has started (running or finished) -->
<match-started/>
<!-- Filter if the match is currently running -->
<match-running/>
<!-- Filter if the match is over -->
<match-finished/>

<!-- Filter if the match is actively running and participants have been created -->
<match-phase>running</match-phase>
<!-- Filter if the match has stopped running and (if possible) has announced a winner -->
<match-phase>finished</match-phase>
<!-- Filter if the match has started (running or finished) -->
<match-phase>started</match-phase>
<!-- Filter if match has been queued to transition to running and a countdown is actively progressing -->
<match-phase>starting</match-phase>
<!-- Filter if match has loaded but no countdown is given -->
<match-phase>idle</match-phase>
```

--------------------------------

### XML Time Period Examples

Source: https://github.com/pgmdev/website/blob/master/docs/reference/misc/time-periods.mdx

Demonstrates how to represent time periods in XML using suffixes for days, hours, minutes, and seconds. It also shows how to combine units for more specific durations.

```xml
<!-- 5 minutes -->
<time>5m</time>

<!-- Combine multiple units for a more specific timing -->
<time>8m20s</time> <!-- Identical to 500s -->
```

--------------------------------

### After Filter Example

Source: https://github.com/pgmdev/website/blob/master/docs/modules/mechanics/filters.mdx

The After filter activates after a specified duration once a child filter starts allowing matches. It requires a duration and a child filter, and can display an optional message. The example demonstrates a 15-second delay after a player achieves first place.

```xml
<!-- Allows 15 seconds after the player gets 1st place -->
<after duration="15s" message="1st place bonus will apply in {0}"> <!-- Automatically updates to show time -->
    <rank>1</rank>
</after>
```

--------------------------------

### Make Script Executable (Bash)

Source: https://github.com/pgmdev/website/blob/master/docs/guides/preparing/local-server-setup.mdx

This command makes the 'start.sh' script executable. Run this in your terminal within the server's directory.

```bash
sudo chmod +x start.sh
```

--------------------------------

### Countdown Filter Example

Source: https://github.com/pgmdev/website/blob/master/docs/modules/mechanics/filters.mdx

The Countdown filter matches for a specified duration after a child filter starts matching. It requires a duration and a child filter, and can optionally display a message. The example shows a 30-second countdown after a player picks up the blue flag.

```xml
<!-- Countdown 30s from the moment any player picks up the flag -->
<!-- (you could then use the countdown filter to kill them, teleport them, etc) -->
<countdown duration="30s" message="You have {0} to capture the flag!">
    <carrying-flag>blue-flag</carrying-flag>
</countdown>
```

--------------------------------

### Configure Simple Monument Mode

Source: https://github.com/pgmdev/website/blob/master/docs/modules/objectives/monument-modes.mdx

Sets a monument mode to change the material of objectives to gold blocks after a specified duration from the start of the match. This is a basic setup for material transformation.

```xml
<modes>
    <mode after="10m" material="gold block"/>
</modes>
```

--------------------------------

### XML Portal Configuration Examples

Source: https://github.com/pgmdev/website/blob/master/docs/modules/mechanics/portals.mdx

Demonstrates various ways to configure portal behavior using XML. This includes setting absolute and relative coordinates for destinations, specifying regions for entry and exit, applying filters for team-based access, and controlling player orientation (yaw and pitch).

```xml
<portals>
    <!-- Moves the player to exactly X:10 Y:8 Z:45, pitch & yaw remain unchanged -->
    <portal x="@10" y="@8" z="@45">
        <region>
            <cuboid min="-56,33,-1" max="-55,35,2"/>
        </region>
    </portal>

    <!-- Adds 12 to the players Z position, turning them to face east and 10° up -->
    <portal z="12" pitch="@10" yaw="@-90">
        <region>
            <cuboid min="-56,33,-1" max="-55,35,2"/>
        </region>
    </portal>

    <!-- Teleport the player from portal-entrance to a random point inside portal-exit -->
    <portal region="portal-entrance" destination="portal-exit"/>

    <!-- Teleports players on the Red Team from score-box to red-spawn, facing west -->
    <portal filter="only-red" yaw="@90" region="score-box" destination="red-spawn"/>
</portals>
```

--------------------------------

### Objective Filter Examples (XML)

Source: https://github.com/pgmdev/website/blob/master/docs/modules/mechanics/filters.mdx

Examples showcasing the use of Objective Filters. These filters check if an objective has been completed or captured, with options to specify the objective ID and team.

```xml
<!-- Match if "red-core" has been leaked -->
<completed>red-core</completed>
<!-- Match if "south-hill" is owned by anyone -->
<completed>south-hill</completed>

<!-- Match players/teams who own "north-hill" -->
<captured>north-hill</captured>
<!-- Match if Blue Team owns central-hill -->
<captured team="blue-team">central-hill</captured>

<!-- <objective> is deprecated -->
<!-- Matches if the team of the player is the one that completed objective -->
<objective>goal-id</objective>
<!-- Matches if any team has completed objective -->
<objective any="true">goal-id</objective>
<!-- Matches if red team completed or is holding the objective -->
<objective team="red-team">goal-id</objective>
```

--------------------------------

### Player Count Filter Examples (XML)

Source: https://github.com/pgmdev/website/blob/master/docs/modules/mechanics/filters.mdx

Examples demonstrating the usage of the Player Count Filter. It can match based on a minimum and maximum number of players, and optionally include participants or observers.

```xml
<!-- Match if there are at least 4 players participating -->
<players min="4"/>

<!-- Match if there are 1 to 3 players sneaking in region X -->
<players min="1" max="3">
    <all>
        <crouching/>
        <region id="region-x"/>
    </all>
</players>
```

--------------------------------

### Rank Filter Examples (XML)

Source: https://github.com/pgmdev/website/blob/master/docs/modules/mechanics/filters.mdx

Provides examples for the rank filter, which matches players or teams based on their rank. It supports exact ranks, ranges (e.g., [1,3]), and can be filtered by team.

```XML
<!-- Match if team (or player) is ranked 2nd on the scoreboard -->
<rank>2</rank>
<!-- Match if team (or player) is ranked from 1 to 3 on the scoreboard. -->
<rank>[1,3]</rank>
<!-- Match if the blue team is ranked first. -->
<rank team="blue-team">1</rank>
```

--------------------------------

### XML Potion Effect Examples

Source: https://github.com/pgmdev/website/blob/master/docs/modules/gear/potions.mdx

Examples of the `<effect>` element in XML, demonstrating how to apply potion effects with specified duration and amplifier. These are commonly used in game development kits.

```xml
<effect duration="900" amplifier="2">jump boost</effect>

<!-- Commonly used to prevent unintended damage when spawning -->
<effect duration="2" amplifier="5">damage resistance</effect>
```

--------------------------------

### Implement Dynamic Structure Behavior (XML)

Source: https://github.com/pgmdev/website/blob/master/docs/modules/blocks/structures.mdx

This snippet demonstrates how to make structures appear or move dynamically based on game conditions. It uses filters for team control of points and time-based events to control structure visibility and location.

```XML
<structures>
    <!-- Make blue-bridge appear whenever Blue Team owns the control-point called "hill" -->
    <!-- The bridge will appear 128 blocks directly below it's original location -->
    <dynamic structure="blue-bridge" offset="0,-128,0">
        <filter>
            <captured team="blue-team">hill</captured>
        </filter>
    </dynamic>

    <!-- Start the match with a tower at 36,64,0 -->
    <!-- After 5 minutes, move the tower to -36,64,0 -->
    <!-- After 10 minutes, remove the tower -->
    <dynamic structure="tower" location="36,64,0">
        <filter>
            <not>
                <time>5m</time>
            </not>
        </filter>
    </dynamic>

    <dynamic structure="tower" location="-36,64,0">
        <filter>
            <all>
                <time>5m</time>
                <not>
                    <time>10m</time>
                </not>
            </all>
        </filter>
    </dynamic>
</structures>
```

--------------------------------

### Random Filter Examples (XML)

Source: https://github.com/pgmdev/website/blob/master/docs/modules/mechanics/filters.mdx

Shows examples of the random filter, which randomly ALLOWs or DENYs based on a probability. The value can be a decimal fraction or an interval (e.g., [0.25, 0.75)). Applicable to instantaneous events.

```XML
<!-- 50% chance that it will return either ALLOW or DENY -->
<random>0.5</random>
<!-- Also a 50% chance -->
<!-- Any number from 0.25 to 0.75 including 0.25 but excluding 0.75 -->
<random>[0.25, 0.75)</random>
```

--------------------------------

### Apply Dynamic Kits with Filters

Source: https://github.com/pgmdev/website/blob/master/docs/modules/gear/kits.mdx

Kits can be given, taken, or loaned dynamically based on matching a Dynamic Filter. The `<give>`, `<take>`, and `<lend>` elements reference kits and filters to control kit application.

```xml
<kits>
    <!-- Kit and Filter References -->
    <lend kit="jumper-kit" filter="carrying-gold"/>
    <give kit="regen-kit" filter="holding-redstone"/>
    <!-- Player can no longer fly after carrying the flag -->
    <take>
        <kit>
            <fly/>
        </kit>
        <filter>
            <flag-carried>flag</flag-carried>
        </filter>
    </take>
</kits>
```

--------------------------------

### Lives Filter Examples (XML)

Source: https://github.com/pgmdev/website/blob/master/docs/modules/mechanics/filters.mdx

Shows examples of the lives filter, which matches players based on their number of lives. It supports 'min', 'max', and 'count' attributes for specifying the life count criteria. Requires the Blitz module.

```XML
<lives min="3"/> <!-- matches players with at least 3 lives -->
<lives max="5"/> <!-- matches players with at most 5 lives -->
<lives count="1"/> <!-- matches players with exactly 1 life -->
```

--------------------------------

### Dynamic Kit Properties in XML

Source: https://github.com/pgmdev/website/blob/master/docs/modules/general/proto.mdx

Kits can now be dynamically applied using 'give', 'take', and 'lend' properties within the XML configuration. This allows for more flexible management of player gear.

```xml
<kits>
  <kit id="starter-kit">
    <item name="sword"/>
    <give amount="1"/>
    <take amount="1"/>
    <lend amount="1"/>
  </kit>
</kits>
```

--------------------------------

### Region Union Example - XML

Source: https://github.com/pgmdev/website/blob/master/docs/modules/mechanics/regions.mdx

An example demonstrating the use of the 'union' modifier to combine multiple cuboid regions into a single, larger region. This is often used for defining complex areas like team bases.

```xml
<regions>
    <!-- Blue Team Base -->
    <apply enter="only-blue" message="You may not enter the enemy team's base!">
        <region>
            <union>
                <cuboid min="-20,8,-75" max="11,41,-79"/>
                <cuboid min="8,8,-80" max="13,41,-75"/>
            </union>
        </region>
    </apply>
</regions>
```

--------------------------------

### Configure Blitz Mode Actions and Variables (XML)

Source: https://github.com/pgmdev/website/blob/master/docs/modules/mechanics/actions-triggers.mdx

This XML configuration sets up actions to enable and disable 'Blitz Mode' and defines a variable to track its state. Moderators can trigger these actions using the '/action' command, provided they have 'GAMEPLAY' permissions. The configuration also includes a filter to modify gameplay when Blitz Mode is active.

```xml
<actions>
    <!-- Moderator uses "/action trigger start-blitz" to start this Action -->
    <action id="start-blitz" expose="true" scope="match">
        <!-- Sends notification to chat -->
        <message text="Blitz mode has been enabled!"/>
        <!-- Sets blitz_enabled to 1 -->
        <set var="blitz_enabled" value="1"/>
    </action>

    <!-- Moderator uses "/action trigger end-blitz" to start this Action -->
    <action id="end-blitz" expose="true" scope="match">
        <message text="Blitz mode has been disabled!"/>
        <set var="blitz_enabled" value="0"/>
    </action>
</actions>
<!-- Creates the blitz_enabled variable -->
<variables>
    <variable id="blitz_enabled" scope="match"/>
</variables>
<blitz>
  <!-- Matches for a condition where a player loses a life -->
  <filter>
      <!-- If a player dies when blitz_enabled is 1, they lose a life -->
      <variable var="blitz_enabled">1</variable>
  </filter>
</blitz>
```

--------------------------------

### Blitz Player Life Filter Example

Source: https://github.com/pgmdev/website/blob/master/docs/modules/objectives/blitz.mdx

This example demonstrates how to apply a filter to when a player loses a life in the Blitz gamemode. Players only lose a life if they die 30 seconds after the match begins, otherwise, they respawn without penalty.

```xml
<!-- Player loses a life when dying 30 seconds after match start -->
<blitz>
    <lives>5</lives>
    <filter>
        <time>30s</time>
    </filter>
</blitz>
```

--------------------------------

### Define Kit Structure with Items and Effects (XML)

Source: https://github.com/pgmdev/website/blob/master/docs/modules/gear/kits.mdx

This XML snippet demonstrates the basic structure of a kit, including defining items with specific slots and materials, and applying potion effects with durations. It also shows how to use parent kits for inheritance and the 'force' attribute for overriding.

```xml
<kits>
    <kit id="spawn-kit" force="true">
        <item slot="0" material="iron sword"/>
        <item slot="8" amount="32" material="bread"/>
        <effect duration="5">instant_health</effect>
    </kit>
    <kit id="red-kit" parents="spawn">
        <helmet color="cd0000" material="leather helmet"/>
    </kit>
    <kit id="blue-kit" parents="spawn">
        <helmet color="0066cc" material="leather helmet"/>
    </kit>
</kits>
```

--------------------------------

### XML Example: Custom Shaped Crafting Recipes

Source: https://github.com/pgmdev/website/blob/master/docs/modules/gear/crafting.mdx

This XML snippet demonstrates how to define custom shaped crafting recipes using the `<shaped>` element. It includes examples of overriding vanilla recipes and creating recipes with different grid dimensions.

```xml
<crafting>
    <!-- Add custom shaped recipe and disable vanilla recipes for the same item. -->
    <shaped override="true">
        <result material="stone pickaxe">
            <enchantment level="2">durability</enchantment>
        </result>
        <shape>
            <row>FFF</row>
            <row>.S.</row>
            <row>.S.</row>
        </shape>
        <ingredient symbol="F">flint</ingredient >
        <ingredient symbol="S">stick</i>
    </shaped>

    <!-- 3x1 recipe, cheaper gold ingots -->
    <shaped override="true">
        <result material="gold ingot"/>
        <shape>
            <row>GGG</row>
        </shape>
        <ingredient symbol="G">gold nugget</ingredient >
    </shaped>
</crafting>
```

--------------------------------

### Kill Rewards with Actions and Filters (XML)

Source: https://github.com/pgmdev/website/blob/master/docs/modules/gear/kill-rewards.mdx

Sets up kill rewards that trigger specific actions or kits, with options to apply actions to the victim or use referenced actions. This example illustrates using the `victim-action` attribute and referencing actions or kits by ID, as well as defining inline actions.

```xml
<kill-rewards>
    <!-- Runs "some-action" on the victim whenever they are killed by a member of red team -->
    <kill-reward filter="red-team" victim-action="some-action"/>

    <!-- Kits and actions defined as references -->
    <kill-reward action="some-kit" /> <!-- Kits are a type of action, so they can be used as an action -->
    <kill-reward action="some-action"/>

    <!-- Inline defined actions -->
    <kill-reward>
        <action>
            <set var="some_variable" value="1"/>
        </action>
    </kill-reward>
</kill-rewards>
```

--------------------------------

### XML Spawn Point Configurations

Source: https://github.com/pgmdev/website/blob/master/docs/modules/mechanics/spawns.mdx

Defines spawn points for different teams and default spawn areas using XML. Includes cuboid regions and yaw orientation for precise placement.

```xml
<spawns>
    <spawn team="red" kit="red">
        <regions yaw="90">
            <cuboid min="-2,13,71" max="-9,13,78"/>
        </regions>
    </spawn>
    <spawn team="blue" kit="blue">
        <regions yaw="-90">
            <cuboid min="2,13,-71" max="9,13,-78"/>
        </regions>
    </spawn>
    <default>
        <regions>
            <cuboid min="-1,16,-1" max="2,20,2"/>
        </regions>
    </default>
</spawns>
```

```xml
<!-- Example spawns from Assualt -->
<spawns>
    <spawn team="blue" kit="blue" region="blue-spawn" yaw="-90"/>
    <spawn team="red" kit="red" region="red-spawn" yaw="90"/>
    <default kit="obs" region="obs-spawn" yaw="-135"/>
</spawns>

<spawns safe="true" sequential="true">
    <spawn team="blue" kit="blue" yaw="180">
        <regions>
            <cuboid min="-10,71,5" max="12,126,27"/> <!-- Players will spawn here first -->
            <cuboid min="-10,6,5" max="12,6,27"/> <!-- Secondary spawn if the first isn't available -->
            <point>1.5,8,0.5</point> <!-- Tertiary spawn if all other team spawns aren't safe -->
        </regions>
    </spawn>
    <spawn team="red" kit="red">
        <regions>
            <cuboid min="-10,71,-27" max="12,126,-5"/>
            <cuboid min="-10,6,-27" max="12,6,-5"/>
            <point>1.5,8,0.5</point>
        </regions>
    </spawn>
</spawns>
```

--------------------------------

### XML Net Configuration Example for Classic CTF

Source: https://github.com/pgmdev/website/blob/master/docs/modules/objectives/ctf.mdx

This XML snippet demonstrates the configuration of nets for a classic Capture The Flag (CTF) game mode. It includes score limits, flag definitions with pickup restrictions, and net configurations that specify which flag can be captured and which flag is rescued.

```xml
<score>
    <limit>3</limit>
</score>

<flags>
    <flag id="blue-flag" name="Blue Flag" owner="blue-team">
        <post pickup-filter="red-only">2,5,11</post>
    </flag>

    <flag id="red-flag" name="Red Flag" owner="red-team">
        <post pickup-filter="blue-only">24,5,11</post>
    </flag>

    <flags points="1">
        <net region="red-net" flag="blue-flag" rescue="red-flag"/>
        <net region="blue-net" flag="red-flag" rescue="blue-flag"/>
    </flags>
</flags>
```

--------------------------------

### XML Example: Deny Yellow Explosions with 'not' and 'all' Modifiers

Source: https://github.com/pgmdev/website/blob/master/docs/modules/mechanics/filters.mdx

This XML snippet demonstrates the use of the '<not>' and '<all>' filter modifiers. The '<not>' modifier inverts the result of its child filter, while '<all>' requires all its child filters to match. This specific example denies matches where the team is 'yellow' AND the cause is 'explosion'.

```xml
<filters>
    <not id="deny-yellow-explosions">
        <all>
            <team>yellow</team>
            <cause>explosion</cause>
        </all>
    </not>
</filters>
```

--------------------------------

### XML Constant Comparison Examples

Source: https://github.com/pgmdev/website/blob/master/docs/modules/general/preprocessing.mdx

Illustrates various ways to compare constants using the 'constant-comparison' attribute within an '<if>' element. This includes checking for defined values, specific values, regular expressions, and ranges.

```xml
<if constant="const" constant-value="a,b,c" constant-comparison="contains"/>
```

```xml
<if constant="const" constant-value="[0-9]+" constant-comparison="regex"/>
```

```xml
<if constant="const" constant-value="0..12" constant-comparison="range"/>
```

--------------------------------

### General Score Increment and Notification Example

Source: https://github.com/pgmdev/website/blob/master/docs/modules/mechanics/variables.mdx

This example demonstrates incrementing team and player scores upon region entry and sending a notification when a score threshold is met. It defines variables for scores, actions for score updates, and filters to trigger events based on score values.

```xml
<variables>
    <!-- Initializes the variables -->
    <variable id="team_score" scope="team"/>
    <variable id="player_score" scope="player" default="5"/>
</variables>
<actions>
    <action id="score-points" scope="player"/>
        <!-- team_score = team_score + player_score -->
        <!-- Adds the player's score to the team score -->
        <set var="team_score" value="team_score+player_score"/>
        <!-- Adds 5 points to the player's score -->
        <set var="player_score" value="player_score+5"/>
    </action>
    <!-- Triggers the above score-points action when a player enters region-a -->
    <trigger filter="region-a" action="score-points" scope="player"/>
    <!-- Sends a message to the team once the filter reached-score passes Allow -->
    <trigger filter="reached-score" action="completed" scope="team"/>
    <message id="completed" text="The team reached 100 points!"/>
</action>
<filters>
    <!-- Allows when the t_score variable is greater than or equal to 100 -->
    <variable id="reached-score" var="t_score">[100,oo)</variable>
</filters>
```

--------------------------------

### Pulse Filter Examples

Source: https://github.com/pgmdev/website/blob/master/docs/modules/mechanics/filters.mdx

The Pulse filter creates a repeating signal, activating and deactivating within a defined period. It requires a period, duration, and a child filter. The examples show pulsing activation for 15 seconds within a 60-second period and another pulse with an inner match filter.

```xml
<filters>
    <!-- Pulses activation for 15 seconds in a 60 second time period -->
    <!-- ie. on for 15 seconds, off for 45 seconds -->
    <!-- Filter turns off if condition doesn't meet after 60 seconds -->
    <pulse id="pulse-filter" period="60s" duration="15s" filter="second-filter"/>

    <!-- Pulse activates for 20 seconds in a 40 second time period -->
    <!-- With the inner filter, it is always active until the match ends -->
    <pulse id="other-pulse" period="40s" duration="20s">
        <match-running/>
    </pulse>
</filters>
```

--------------------------------

### Defining Actions and Triggers with XML

Source: https://context7.com/pgmdev/website/llms.txt

Sets up in-game actions and triggers based on specific conditions or events using XML. This includes sending messages, applying kits, or triggering effects based on player actions or game state.

```xml
<actions>
    <!-- Message action -->
    <action id="welcome-message">
        <message text="`aWelcome to the game!"/>
    </action>

    <!-- Trigger based on filter -->
    <trigger filter="match-running" scope="match">
        <action>
            <message text="The match has started!"/>
        </action>
    </trigger>

    <!-- Kit application trigger -->
    <trigger filter="carrying-flag" scope="player">
        <action>
            <kit>
                <effect duration="oo" amplifier="1">slowness</effect>
            </kit>
        </action>
    </trigger>
</actions>
```

--------------------------------

### Offset Filter Examples

Source: https://github.com/pgmdev/website/blob/master/docs/modules/mechanics/filters.mdx

The Offset filter checks for blocks at specific coordinates relative to the player or absolute positions. It can use exact vectors, relative coordinates (with '~'), or directional vectors (with '^'). Examples include checking for bedrock at an exact location, cobblestone below the player, and water in front of the player.

```xml
<filters>
    <!-- checks for bedrock placed at this exact coordinate vector (dynamic) -->
    <offset id="hardFilter" vector="10.5,5,15.5">
        <material>bedrock</material>
    </offset>
    <!-- checks for cobblestone placed 1 block beneath the player -->
    <offset id="blockUnderFeetFilter" vector="~0,~-1,~0">
        <material>cobblestone</material>
    </offset>
    <!-- checks for water placed 2 blocks *in front* of the player -->
    <!-- ^<+left/-right>, ^<+up/-down>, ^<+front/-behind> -->
    <offset id="inFrontFilter" vector="^0,^0,^2">
        <material>water</material>
    </offset>
</filters>
```

--------------------------------

### Player Kit Configuration (XML)

Source: https://github.com/pgmdev/website/blob/master/docs/examples/ozone.mdx

Defines the starting kit for players, including unbreakable stone sword, bow with infinity, arrows, golden apple, and team-colored leather armor. It also applies projectile protection and speed effects.

```xml
<kits>
    <kit id="spawn-kit">
        <clear/>
        <item slot="0" unbreakable="true" material="stone sword"/>
        <item slot="1" unbreakable="true" material="bow">
            <enchantment>infinity</enchantment>
        </item>
        <item slot="28" material="arrow"/>
        <item slot="2" material="golden apple"/>
        <!-- Helmet and chestplate will be automatically colored based on the player's given color -->
        <helmet unbreakable="true" team-color="true" material="leather helmet"/>
        <chestplate unbreakable="true" team-color="true" material="leather chestplate"/>
        <leggings unbreakable="true" material="chainmail leggings">
            <enchantment level="3">protection projectile</enchantment>
        </leggings>
        <boots unbreakable="true" material="iron boots"/>
        <effect duration="5" amplifier="10">damage resistance</effect>
        <effect>speed</effect>
    </kit>
</kits>
```

--------------------------------

### Define Blocks an Item Can Be Placed On (XML)

Source: https://github.com/pgmdev/website/blob/master/docs/modules/gear/items.mdx

The `<can-place-on>` element allows an item to be placed on specific block materials. It can use individual `<material>` tags or the `<all-blocks/>` tag to permit placement on any block. Using `show-can-place-on="false"` is recommended with `<all-blocks/>` to avoid large tooltips.

```xml
<item material="lever">
    <can-place-on>
        <all-blocks/>
    </can-place-on>
</item>
```

--------------------------------

### CTF XML Configuration Example

Source: https://github.com/pgmdev/website/blob/master/docs/modules/objectives/ctf.mdx

This XML snippet demonstrates the basic structure for configuring flags, posts, and nets in a Capture the Flag gamemode. It defines a red flag, its associated respawn post, and the capture net for the opposing team. Filters can be applied to control interactions.

```xml
<flags>
    <post id="red-flag-post" pickup-filter="blue-only">2,5,11</post>
    <flag id="red-flag" name="Red Flag" color="red" post="red-flag-post"/>
    <net post="red-flag-post" points="1" region="blue-net" capture-filter="blue-only"/>
</flags>
```

--------------------------------

### XML Block Drops for Kit Assignment

Source: https://github.com/pgmdev/website/blob/master/docs/modules/blocks/blockdrops.mdx

A rule that assigns a specific 'kit' to the player when a certain block is broken. This example assigns the 'chest-kit' when a chest block is broken.

```xml
<block-drops>
    <!-- When a chest is broken give the player the 'chest-kit' -->
    <rule kit="chest-kit">
        <filter>
            <material>chest</material>
        </filter>
    </rule>
</block-drops>
```

--------------------------------

### XML Protocol Versioning Examples

Source: https://github.com/pgmdev/website/blob/master/docs/modules/general/proto.mdx

Demonstrates how built-in filters are referenced in different PGM protocol versions. In proto 1.5.0, filters like 'alive' are recognized by default, eliminating the need for explicit definition in the <filters> tag. For older versions (e.g., 1.4.2), the filter must be explicitly defined.

```xml
<!-- Sample proto 1.4.2 XML -->
<filters>
    <alive id="alive"/> 
</filters>
<some-other-feature filter="alive"/>

<!-- Sample proto 1.5.0 XML -->
<filters>
  <!-- Defining the alive id is not necessary, as it's a built-in now -->
</filters>
<some-other-feature filter="alive"/>
```