Pinata & new showcase

config/_default/params.toml

@@ -1,6 +1,6 @@
 editURL = "https://github.com/GamesInTheBox-MC/Docs/edit/main/content/"
 description = "The Documentation for GamesInTheBox & its expansions"
-author = "HSGamer"
+author.name = "HSGamer"
 showVisitedLinks = true
 disableSearchHiddenPages = true
 disableSeoHiddenPages = true

content/_index.md

@@ -21,6 +21,7 @@ Games In The Box is a certain minigame system for Spigot servers, with the idea
 ![Block Rush](showcase-rush.png)
 ![Defuse the Bomb](showcase-dtb.png)
 ![Shoot the Bat](showcase-stb.png)
+![Pinata](showcase-pinata.png)
 
 ## Video
 

content/game/block-rush/_index.md

@@ -1,6 +1,6 @@
 +++
 title = "Block Rush"
-weight = 2
+weight = 1
 +++
 
 {{% button href="https://github.com/GamesInTheBox-MC/BlockRush/releases" style="green" icon="download" %}}Download{{% /button %}}

content/game/defuse-the-bomb/_index.md

@@ -1,6 +1,6 @@
 +++
 title = "Defuse the Bomb"
-weight = 3
+weight = 1
 +++
 
 {{% button href="https://github.com/GamesInTheBox-MC/DefuseTheBomb/releases" style="green" icon="download" %}}Download{{% /button %}}

content/game/pinata/_index.md

@@ -0,0 +1,153 @@
++++
+title = "Pinata"
+weight = 1
++++
+
+{{% button href="https://github.com/GamesInTheBox-MC/Pinata/releases" style="green" icon="download" %}}Download{{% /button %}}
+
+## Install
+
+1. Go to [the download page](https://github.com/GamesInTheBox-MC/Pinata/releases)
+2. Choose the latest version
+3. Download the `-shaded` file
+4. Copy the downloaded file to the folder `plugins/GamesInTheBox/expansions`
+5. Restart the server
+
+## How to play
+
+A pinata would be spawned at the game arena. Players must hit them to earn points. Those who have the highest points would win the game.
+
+## Set up
+
+1. Build a place for the box
+
+![1-Build](1-build.png)
+
+{{% notice style="info" %}}
+The stones are for the two corners of the box
+{{% /notice %}}
+
+2. Look at the first corner and type `/gitbeditor action pinata set-pos1`
+
+![2-Set-Pos1](2-set-pos1.png)
+
+3. Look at the second corner and type `/gitbeditor action pinata set-pos2`
+
+![3-Set-Pos2](3-set-pos2.png)
+
+4. Configure [additional settings](#additional-settings)
+
+5. Save the settings as a new arena by typing `/gitbeditor save pinata <planner> <arena>`
+
+6. Clear the unnecessary blocks. Your new arena will be available after reloading
+
+![4-Final](4-final.png)
+
+## Additional Settings
+
+{{% notice style="note" %}}
+The settings below are available as the actions of the command `/gitbeditor action pinata <action> [args]`
+
+For example, the action `set-point <number> hit` is relevant to the command `/gitbeditor action pinata set-point <number> hit`
+
+Use the command `/gitbeditor usage pinata` to get the full list of available actions and their usage
+
+Use the command `/gitbeditor status pinata` to get the status of the settings, including the current values for each one of them
+{{% /notice %}}
+
+### Point
+
+* `set-point <number> hit` to set the points a player would receive when he hit the pinata
+* `set-damage-as-point <true/false>` to set whether to use the damage value as points
+
+### Reward
+
+* `add-reward <top> <command>` to add a new `<command>` to be executed when the player is at the position `<top>`
+
+{{% notice style="tip" %}}
+* You can use some placeholders for the `<command>`:
+  * `{top}`: Get the top position of the player
+  * `{name}`: Get the name of the player
+* `<top>` starts from `1`. A value of `-1` indicates that the reward is for all players
+{{% /notice %}}
+
+* `clear-reward <top>` to clear all commands at the position `<top>`
+* `clear-all-reward` to clear all commands at all the top
+* `set-min-players-to-reward <number>` to set how many players are required to start the reward
+
+{{% notice style="tip" %}}
+Set the `<number>` to `-1` to disable the limit
+{{% /notice %}}
+
+### Hologram
+
+* `new-hologram` to create a new hologram at your current location
+* `set-hologram-location <index>` to move the hologram at the `<index>` to your current location
+
+{{% notice style="tip" %}}
+The `<index>` of the hologram starts from `0`, and it is provided as the output of the action `new-hologram`
+{{% /notice %}}
+
+* `add-hologram-line <index> <line>` to add the `<line>` at the end of the hologram at the `<index>`
+
+{{% notice style="tip" %}}
+You can use default hologram lines provided by the `default-hologram-lines` setting at the file `messages.yml` in the expansion's folder
+
+To use these lines, set the `<line>` to `default:<name>`, with the `<name>` indicating the name of the default hologram lines
+
+For example, if you want to use the `description` hologram lines, the appropriate `<line>` will be `default:description`
+{{% /notice %}}
+
+* `clear-hologram-line <index>` to clear all lines of the hologram at the `<index>`
+* `remove-hologram <index>` to remove the hologram at the `<index>`
+* `clear-all-hologram` to clear all holograms
+
+### Time
+
+* `set-waiting-time <time>` to set the `<time>` before the game starts
+* `set-in-game-time <time>` to set the `<time>` the game runs
+* `set-ending-time <time>` to set the `<time>` before the game ends
+
+{{% notice style="tip" %}}
+The unit of `<time>` is millisecond by default
+
+You can set the `<time>` in seconds by adding `s` after the time. For example, `30s` is for 30 seconds
+
+Similarly, you can set the `<time>` in minutes by using `m` (`30m` for 30 minutes)
+{{% /notice %}}
+
+### Pinata & Pinata Spawning
+
+* `set-pinata-type <entity>` to set the entity type of the pinata
+* `set-ai <true/false>` to set whether the pinata has AI
+* `set-min-x <number>` to set the X offset between the minimum corner of the game box and that of the spawning box
+* `set-max-x <number>` to set the X offset between the maximum corner of the game box and that of the spawning box
+* `set-min-y <number>` to set the Y offset between the minimum corner of the game box and that of the spawning box
+* `set-max-y <number>` to set the Y offset between the maximum corner of the game box and that of the spawning box
+* `set-min-z <number>` to set the Z offset between the minimum corner of the game box and that of the spawning box
+* `set-max-z <number>` to set the Z offset between the maximum corner of the game box and that of the spawning box
+* `add-name-tag <name>` to add a name tag that would be set to the pinata
+* `clear-name-tags` to clear all the name tags
+
+## Variable
+
+| Variable | Description |
+| --- | --- |
+| `{game_point}` | The points of the player |
+| `{game_top}` | The top position of the player |
+| `{game_time_left}` | The time left of the game arena |
+| `{game_min_players_to_reward}` | The minimum players to start the reward |
+| `{game_point_hit}` | The points to give when a player hit the pinata |
+| `{game_top_name_<number>}` | The name of the player at the top position `<number>` |
+| `{game_top_value_<number>}` | The value of the player at the top position `<number>` |
+
+## Action
+
+{{% notice style="note" %}}
+The actions below are used in the command `/gitb action <planner> <action> [args]`
+
+For example, the command to use the action `skip-time` is `gitb action <planner> skip-time`
+{{% /notice %}}
+
+* `skip-time` to skip the time on a state of the current arena
+

content/game/shoot-the-bat/_index.md

@@ -1,6 +1,6 @@
 +++
 title = "Shoot the Bat"
-weight = 4
+weight = 1
 +++
 
 {{% button href="https://github.com/GamesInTheBox-MC/ShootTheBat/releases" style="green" icon="download" %}}Download{{% /button %}}