SpeedRun+

SpeedRun+

SpeedRun+ (SpeedRunPlus) is a plugin for Minecraft (1.16.1) multiplayer servers which provides several speedrun-related game modes to your server. SpeedRun+ manages isolated, temporary worlds when speedrunning and supplies a range of quality of life utilities such as: In-game timers, AFK detection, leaderboards, filtered seeds, and more. Game modes include:

- Co-op - A classic single-player speedrun where you aim to defeat the Ender Dragon in the shortest time possible. - Co-op - A head-to-head race between two players in identical worlds. Each player rushes to defeat the Ender Dragon first — the first to do so wins the match. - Co-op - A cooperative speedrun for up to two players sharing the same world. The run ends when the team defeats the Ender Dragon together.

With more coming!

A great solution for providing fun and competitive game modes to a proxy-based server network (Velocity / BungeeCord) or simply on a 1.16.1-native server!

---

🖼️ Preview

<p align="center"> <img src="https://raw.githubusercontent.com/Fx-Costa/SpeedRunPlus/main/.config/resources/solo-preview.png" width="400" alt="Solo preview" /> </p>

<p align="center"> <img src="https://raw.githubusercontent.com/Fx-Costa/SpeedRunPlus/main/.config/resources/battle-preview.png" width="400" alt="Battle preview" /> <img src="https://raw.githubusercontent.com/Fx-Costa/SpeedRunPlus/main/.config/resources/coop-preview.png" width="400" alt="Battle preview" /> </p>

🖥️ Installation

> ⚠️ SpeedRun+ does not support Minecraft Bedrock servers. > SpeedRun+ works on a Bukkit server such as SpeedRun+ or %%MD1%%.

1. Download the plugin

2. Add the JAR file to your server's `plugin`-folder

3. Restart / Reload the server and start speedrunning by executing the provided commands!

⚙️ Prerequisites

SpeedRun+ relies on SpeedRun+ and %%MD1%% to create isolated speedrun worlds. These plugins must be present on the server, for this plugin to work:

- GitHub - Multiverse-Core v. 4.3.16 / Modrinth - Multiverse-Core v. 4.3.16 - GitHub - Multiverse-NetherPortals v. 4.2.3 / Modrinth - Multiverse-Core v. 4.3.16

🏃️ Commands

SpeedRun+ uses the following in-game command structure: ``` /srp <gamemode> <action> [player] ```

For additional info and help, see the subsections below or use the `/srp help` command in-game.

🕹️ Player commands

👤 Solo

| Command | Description | |:------------------|:----------------------------------------| | `/srp solo start` | Start a new solo speedrun | | `/srp solo reset` | Reset the world of the current speedrun | | `/srp solo stop` | Stop the current speedrun |

👥 Battle

| Command | Description | |:-------------------------------|:-----------------------------------------------------------------------| | `/srp battle request [player]` | Challenge a player to a battle (1v1) speedrun | | `/srp battle accept` | Accept a challenge and start the battle speedrun | | `/srp battle decline` | Decline a request to a battle speedrun | | `/srp battle reset` | Reset the player's world in the current speedrun battle | | `/srp battle surrender` | Surrender and stop the battle speedrun - awarding the opponent the win |

🫂 Co-op

| Command | Description | |:-----------------------------|:-------------------------------------------------------| | `/srp coop request [player]` | Request a player to join you in a cooperative speedrun | | `/srp coop accept` | Accept a request and start a cooperative speedrun | | `/srp coop decline` | Decline a request to a cooperative speedrun | | `/srp coop surrender` | Stop the current cooperative speedrun - no winners |

🛡️ Admin commands

Administrative commands exist for managing runs, troubleshooting issues, and performing maintenance actions. The player must have the administrative permission `srp.admin` (disabled by default) to allow use of these.

For the full list of admin commands, use: ``` /srp admin help ```

️🛠️ Configuration & Permissions

SpeedRun+ is highly configurable, allowing server owners to fine-tune game rules, world generation, timer behavior, AFK handling, podiums to display top leaderboard contestants, and more. All settings can be adjusted through the plugin’s `config.yml`, giving you control over how speedruns operate on your server.

Below is a complete example configuration file to help you understand the available options and their default values. You can use this as a reference when customizing your own setup.

🔑 Permissions

SpeedRun+ includes a set of permissions, that integrate seamlessly into SpeedRun+, and let server owners control which features and gamemodes players can access. Most servers will likely grant solo, battle, or co-op permissions based on player ranks, while administrative permissions should be reserved for staff.

Below is a brief overview of permissions, but be sure to see the `plugin.yml` for the full list:

| Permission | Description | Default | |--------------|-----------------------------------------------------|---------| | `srp.use` | Allows the player overall usage of SpeedRun+ | True | | `srp.solo` | Allows the player to use all Solo commands | True | | `srp.battle` | Allows the player to use all Battle commands | True | | `srp.coop` | Allows the player to use all Co-op commands | True | | `srp.admin` | Allows the player to use all administrator commands | False |

🤝 Support & Contact

If you encounter issues, have suggestions, or want to request new features, please use the official issue tracker on:

GitHub Issues

For anything else—questions, feedback, or general discussion—feel free to open an issue as well. This helps keep all support requests organized and ensures nothing gets lost.

📜 Licensing and Contributions

This project is licensed under the AGPL-3.0 License, allowing open use, modification, and redistribution under the terms of the license.

Contributions are welcome! However, all contributions must follow the rules outlined in CONTRIBUTING and are subject to the Contributor License Agreement. Only contributions approved by the project owner will be merged into the official version.