# Getting started

Welcome to **RageMode** documentation page! This plugin brings the "old-style" forgotten RageMode project back in 2015 (originally from [this](https://www.spigotmc.org/resources/12690/)), where shooting with exploding arrows, items was a miracle to create. Now we brings back this minigame to Minecraft community.

This project has been continued by myself and released for testing purposes in 2019. I continued to develop it for about 1 year, but it stopped despite the little time. It's been 6 years since then, slowly and after a lot of thinking, I've finally started to rework this project.

Unfortunately, this product is no longer available as a **free version**.

**As I promised back in 2022**

<figure><img src="/files/I9G3moOOXllyQTrKKLko" alt=""><figcaption></figcaption></figure>

{% hint style="danger" %}
The plugin is designed specifically for Paper (and forks) <code class="expression">space.vars.mcversion</code> and JDK <code class="expression">space.vars.jdkversion</code>. Older versions (like 1.8) are not supported due to security issues and missing features.
{% endhint %}

{% hint style="info" %}
Users can access all Minecraft and JDK features without restrictions. I made this decision due to the complexity of the plugin, as well as the new JDK/Minecraft features and security fixes. There used to be a workaround for this to support 1.8, but since this project getting larger, it has been cancelled and those legacy codes has been removed from the source.
{% endhint %}

{% hint style="warning" %}
This product has not been tested with other plugins, compatibility issues may occur, such as chat, in-game world, player and entity modifications. These can be all-in-one plugins that may override the behaviour of this product. Such issue should be reported, but fix is less possible.

We recommend using this plugin on a separate server for better compatibility
{% endhint %}

{% hint style="info" %}
This project has tested on an **Intel Core i5-13500 CPU**, **DDR4 32GB 3733 MT/s of RAM**, **Samsung SSD 990 PRO 1TB** and with **Windows 11 Pro** system installed

* If your PC specifications can not handle large amount of zombies, players with abilities, skills, effects, server schedulers and many other things may cause your server to start lagging
  {% endhint %}

***

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><h4><i class="fa-discord">:discord:</i></h4></td><td><strong>Discord community</strong></td><td>Join our Discord community to post questions, get help about the plugin</td><td><a href="https://discord.gg/XsfT5cJ" class="button secondary">Join Discord</a></td><td></td></tr><tr><td><i class="fa-github">:github:</i></td><td><strong>GitHub issues</strong></td><td>Create RageMode related issues like features or bugs to improve our resource</td><td><a href="https://github.com/montlikadani/RageMode/issues" class="button secondary">Issues</a></td><td></td></tr></tbody></table>

***

{% embed url="<https://www.youtube.com/watch?v=SUUshdaJnxA>" %}

[bStats for data collection](https://bstats.org/plugin/bukkit/RageMode/5076)

## Terms of Use

* Redistribution of this plugin to other individuals, networks, or websites is strictly prohibited.
* This plugin is licensed for use exclusively on your server or network.
* Please refrain from leaving unconstructive reviews, such as complaints about missing features or updates not meeting your requests. The plugin's features are clearly listed on the documentation page, so you are fully informed before purchasing.
* Before purchasing this product, consider whether you really want to buy it. Refunds/charge-backs are prohibited, as one does not have a right to get a refund for such digital item as it has been used. All payments are final.
* While I strive to provide updates, they will be released as my schedule permits. Please understand that I have other commitments outside of this project. Updates and support will be provided on a best-effort basis but are not guaranteed. Responses and updates may require time and will not always be immediate.
* Author of this plugin has full right to change the price and the content of the plugin anytime.
* Decompiling, modifying, extracting plugin source code is not allowed.

## Prerequisites

Before installing this product, ensure your server environment meets this requirements:

* [**Java 25**](https://www.oracle.com/java/technologies/downloads/) or newer is required
* <code class="expression">space.vars.mcversion</code> minecraft version
* [**Paper**](https://papermc.io/) and its forks for server platform

{% hint style="warning" %}
**Paper** is the only supported platform over Spigot, Bukkit, since RageMode code base uses [Adventure API](https://docs.papermc.io/adventure/) for rich text formatting (minimessage, hex colors, gradients) and many Paper-only features. Paper comes with Adventure included, while Spigot does not
{% endhint %}

<mark style="color:$danger;">**Other platforms and versions are not supported and are not guaranteed to work.**</mark>

***

## **Installation**

1. Get the latest version from the official distribution page
2. Place the `ragemode.jar` file into your server’s `plugins/` directory
3. Restart your server to generate default configuration files
4. Verify installation by typing `/rm` when the plugin loaded correctly

### First-run configurations

After the plugin loaded correctly, a new folder will be created at `/plugins/RageMode`. This folder contains every possible files to customise your games

* `config.yml` - Main plugin settings, storage, bungee, gui, commands related options
* `arrow-trails.yml` - Stores all possible particle effects used for arrow trails
* `custom-items.yml` - Define and create specific unique items
* `discounts.yml` - Stores discount data related to lobby shop items
* `drop-crates.yml` - In game crates settings for drops
* `gamehistory.yml`  - Stores information about last played games
* `game-items.yml` - Configuration for game items
* `games.yml` - Stores game area, spawn locations and other data needed for games
* `global-game-settings.yml` - Global configuration for all types of games
* `holograms.yml` - Configure specific settings for holograms
* `npcs.yml` - Stores NPC information, like location, command and entity type
* `player-missions.yml` - Create and edit player missions
* `rewards.yml` - Configure rewards that players receives after specific action
* `signs.yml` - Configuration for signs
* `skills.yml` - Create and edit player skills
* `/locale` - A directory where all possible localisation can be found
* `/player games` - Folder where you can configure player game mode related settings
* `/playerdata` - A directory where all played players data will be stored (if storage type is YAML)
* `/zombie game` - Folder where you can configure zombie game mode related settings

***

## **Optional dependencies**

All plugins are optional since RageMode most features was built from scratch, so these dependencies are not required to be installed, it is included as an extra functionality to expand the plugin use case.

<table><thead><tr><th width="306">Name</th><th>Definition</th></tr></thead><tbody><tr><td><a href="https://www.spigotmc.org/resources/6245/">PlaceholderAPI</a></td><td>Allows using built in placeholders in other plugins</td></tr><tr><td><a href="https://www.spigotmc.org/resources/34315/">Vault</a>, <a href="https://www.spigotmc.org/resources/117277/">VaultUnlocked</a>, <a href="https://www.spigotmc.org/resources/84121/">ExcellentEconomy</a></td><td>Allows transferring money for players (receiving and take)</td></tr><tr><td><a href="https://www.spigotmc.org/resources/73355/">ItemsAdder</a>, <a href="https://www.spigotmc.org/resources/72448/">Oraxen</a>, <a href="https://www.spigotmc.org/resources/83070/">ExecutableItems</a></td><td>Allows using custom items</td></tr><tr><td><a href="https://www.spigotmc.org/resources/14280/">HeadDatabase</a></td><td>Allows using unique heads</td></tr></tbody></table>

***

## **Key features**

* Multi-language support in [wide range of selection](https://www.oracle.com/java/technologies/javase/jdk25-suported-locales.html#historicallocales)
  * Players can select and set their favourite language through command (if supported and translated, otherwise default English will be displayed)
  * Set a default global language that every new player receives
  * Edit translation files as you wish, missing translation keys will be set on reload
* Global server economy support for rewarding players and in-game purchases
* [PlaceholderAPI](https://www.spigotmc.org/resources/6245/) compatibility for servers to use RageMode related placeholders
* Over 30+ commands for creating, editing game-related settings, database handling, player commands which default players (unauthorised players) can access and use, in-game points editing, Graphical User Interface (GUI) for many options to configure and more
  * Option to disable any commands from config, so even operator players can not use it
* Create as many games as you want (we recommend creating one game for each server for full compatibility and to avoid conflict)
* [Bungeecord](https://www.spigotmc.org/threads/392/) compatibility for multi servers, players can join to games server to enter a selected game automatically
  * Option to enter a randomly selected game on join
  * Option to enter a selected game if any other game is unavailable for join
  * Option to join a selected lobby server on game end, where multiple lobby servers are available (fallback servers)
* Database compatibility for storing player, game data (MySQL, SQLite, YAML (default))
  * Option to convert database to selected type through command (make sure to create backup before converting)
  * Option to trigger database clean up after x amount of days
  * Logical option to determine whenever to save database on each game
  * Configure database table names individually
  * Option to include extra properties for better compatibility with other type of databases or for extra features
* Arena configuration
  * Area selection where games happening
    * Select using an item, manually through command or GUI
    * Option to display particle effects around selected area
    * Players can not move outside of area if they're playing in a game
    * Entities, explosions won't break, destroy environment, blocks inside the game area, explosions does not trigger outside
  * 2 game modes
    * Classic - Players fight with each other (PvP) and who has the highest points wins
    * Apocalypse - Players fight with different types of zombies with configurable lives (life)
  * Classic and Apocalypse game mode
    * Time limited game mode for a maximum of 1 hour (3600 seconds) and 3 minutes minimum (180 seconds)
    * Limited amount of players can participate with a maximum of 1000 and minimum of 2
    * Option for players to respawn after x amount of seconds
    * Game freeze option to completely freeze game and wait for ending phase
    * Kill streaks to give extra rewards, broadcast messages after x amount of kills
    * Points configuration for each items how many points the player receives with different types of items after kill
    * Option to display scoreboard, tablist for players for different game phases (status)
    * Joining options for per-game basis (join rules, random join)
    * Options to disable redstone activating blocks (doors, levers, pressure plate)
    * Player name tag customisation with unique condition at which condition should display or make it invisible
    * Option to restart or shutdown server after x amount of games (this is to free up unused memory used by this plugin)
    * Option to invite specific players to join game with expiration minutes
    * Option to allow or disallow spectators
    * Lobby configuration (shop, countdown reducer)
    * Game history to store information about played games with data purge option
    * In game chat rules and formatting for different types of game phases
    * Allowed and disabled commands that players can use in game
    * Rejoin delay option to limit joining repeatedly
    * Unique configurable broadcast phases for different types of game events
    * Option to save or clear player data (inventory, effects ...) on join
    * In game rewards for rewarding players with different types (custom items, money, points ...)
  * Apocalypse game mode
    * Configurable player lives how many times does players can respawn in a game
    * Lock day light cycle or set specific world time on game start
    * Zombies left notification to broadcast how many zombies alive
    * Ability to create wave-based games and define configurable zombie spawning, i.e. how many zombies and what type can spawn in each wave
    * General zombies
      * Chance to spawn baby or villager zombie
      * Options whenever zombies should burn in day, make them silent, target nearby players, set death sound, death commands
      * Option to set custom name which triggers on specific condition
      * Option to spawn zombies at specific world times
      * Drop bonus points on kill, which players can pick up and collect
      * Ability to make zombies immune to any damage, add specific attributes and custom equipments
    * Special zombies
      * Same features as general zombie
      * Chance and amount to spawn
      * Abilities which triggers after x seconds interval
      * Custom bossbar to display if this special zombie is a boss fight for example
      * Give potion effects
      * Create as many zombies as you wish
  * Interactive signs with configurable actions
    * Join, randomjoin, lobbyshop, stats, leaderboard, spectate action types
    * Option to delay interaction time between use for each type
    * Configurable permissions for each sign type
    * Option to configure text that appears on signs for each type
    * Join game status sign to append block behind sign and update text for each game status accordingly
  * Game items
    * Configure their display names, lore, quantity, slot
    * Some items can be purchased from shop with the set of price and points with configurable group limits by permission
    * Configurable damage, thrown sound, velocity for specific in game items
* Custom items
  * Create unique items with all possible item stack configuration available in server
    * These items can only be used in GUI and to receive them outside of game
    * quantity, enchantments, model data, firework colors, item flags, potion effects, banner and many others
    * Compatibility with different CustomItems plugins: [ItemsAdder](https://www.spigotmc.org/resources/73355/), [HeadDatabase](https://www.spigotmc.org/resources/14280/), [ExecutableItems](https://www.spigotmc.org/resources/83070/), [Oraxen](https://www.spigotmc.org/resources/72448/)
* Points configuration
  * Give points for new players
  * Conversion multiplier when converting points to money using command
  * Option to allow players having negative amount of points
* Rewards for different types of player actions
  * Players can receive bonus points, commands in game if they meet the requirements to get
  * Option for players to receive items, commands on game end
* **(Beta)** Built-in skills to apply for example extra damage for specific items or players only
  * Starting experience for new players
  * Configurable maximum experience possible for one player
  * Levelling progression based on mathematical operators
  * Experience gaining for both player and zombie based on math operators
  * Points gaining per level
  * Create unique skills as you wish
  * Mathematical based expressions on skill activation
  * Configurable maximum level for each skill
  * Option to append unique item in GUI for each skill for buy, upgrade and max upgrade
  * Buy and upgrade requirements for both money and points + skills to unlock before
* Lobby shop for purchasing in game items, skills, trails and many more
  * Discount options for all in-game items, effects, for both money and points
  * Option to purchase multiple items or remove them from purchasing
  * Purchasing happens at game start
* Lobby items
  * Players, spectators and operators have different types of items which can be
    * Force start - Forces starting the currently joined game
    * Player options - Opens GUI for player-related options
    * Shop item - Opens lobby shop menu
    * Missions item - Opens currently available missions menu
    * Skills item - Opens skills menu
    * Teleporter (spectators) - Opens a menu for spectator players to view playing players
    * Stop game (spectators) - Stops a currently running game
    * Leave game item - Leaves the game
* Special arrows that can be selected through player inventory (cycling through)
  * There is only limited amount of special arrows added
    * fire arrow - Makes entities blow on fire and cause damage
    * healing arrow - Heals you and your team mates in game
    * glowing arrow - Makes any entity in glowing state
    * lightning strike arrow - Summons lightning strike and causes damage to entities around
    * rage arrow (default) - Explosive arrow
* Drop crates which appears in game at random intervals which can contain points, effects and other configurable rewards
  * Option to disappear after x seconds
  * Chance to drop crate chests in game
  * Option to define times between drops in seconds
  * Option to limit how much the player can collect within x seconds
  * Firework effects on interaction
  * Hologram above chest
* Different types of statistics for tracking player use cases for specific items and actions
  * Player and zombie kills
  * Deaths, suicide, revives
  * Total damage, kill streaks, played games count
* Built-in holograms for players statistics specific leaderboard
  * Create holograms with specific display settings with unique texts applied
  * Update, remove and list commands included
* Built-in NPC creator
  * Create entity-based passive NPCs to execute specific ragemode related commands or open specific GUIs on interaction
  * Option to set custom name
  * List, edit and remove commands included
* Built-in player missions to complete and receive specific rewards
  * GUI for tracking missions progression and collect rewards from completed ones
  * Option to skip and reroll x amount of missions
  * Button to hide completed missions
  * Option to limit how many missions a player can have
  * Option to claim rewards automatically on completion
  * Option to give extra missions after all missions completed
  * Configurable reset time interval
  * Option to keep remaining uncompleted missions and to forget them after x days
  * Create unique missions as many as you wish
    * Chance that this mission can appear
    * Option to use custom item in GUI with description
    * Configurable condition goal with logical equal `=` operator
    * Configurable specific rewards for each mission (commands, items, potion effects)
    * Progression actionbar to display on mission progression
    * Different types of broadcast messages on mission completion (message, title, bossbar, actionbar)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://mdswork.gitbook.io/ragemode-docs/getting-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
