Skip to content

PulseBeat02/MurderRun

Repository files navigation

Murder Run

GitHub Actions CodeFactor Quality Gate Status

Minigame Inspiration

Inspired by the popular game Dead by Daylight, Murder Run is an advanced mini-game revolving around killers and survivors. In a desolate map, survivors must find all the vehicle parts and throw them back onto the truck before the killers murder everyone. Both killers and survivors have access to a 100+ different gadgets, which can be used in combination to try and win. This game took inspiration from SSundee's "Murder Run" series on YouTube.

Discord Banner 3

Features

  • Free and Open Source
  • Over 100+ Killer/Survivor Gadgets
  • Easy Lobby / Arena Creation and Customization
    • Either use GUI's or Commands to Create and Modify Arenas / Lobbies
  • Resets Arenas Automatically using WorldEdit
  • Customize Item Drop Locations
    • Supports Automatic Item Drop Locations
    • No Setup Required for Arenas
  • Pre-made NPC Gadget Shop with Adjustable Prices
    • Prevent Certain Gadgets from Showing Up
  • Game Creation with Quick Join System or Private Games
    • Either use GUI's or Commands to Create Games
  • Integration with PlaceholderAPI, LibsDisguises, Citizens, and WorldEdit
    • Integrates with PlaceholderAPI for Custom Statistics
      • %%fastest_win_killer%%, &&fastest_win_survivor&&, %%total_kills%%, %%total_deaths%%, %%total_wins%%, %%total_losses%%, %%total_games%%, %%win_loss_ratio%%
    • Integrates with LibsDisguises for Custom Gadgets
    • PlaceholderAPI and LibsDisguises Not Required
  • No Dependencies / Setup Involved, Just Drop the JAR into Plugins Folder
  • Customisable Resource Pack
    • Customisable Item Textures, Sounds
    • Customisable Resource Pack Provider Method
    • No Server Hosting or Setup Required
      • Hosted on Server Automatically
      • Gives Option to Host via Other Options
    • Caches Resource Pack for Faster Loading Times
  • Customisable Locale (Change / Reformat Messages)
    • Uses MiniMessage for Easy Formatting
  • Support for Multiple Languages
  • Customisable Gadget Properties
    • Ability to Disable Gadgets
    • Ability to Modify Gadget Cooldowns, Sounds, and Potion Effects
  • Customisable Game Properties
    • Ability to Set Game Timer
    • Ability to Set Extra Resource Packs
  • Customisable Alive / Dead Chat
  • Allows for Multiple Killers / Survivors
  • Database Support via Hibernate (MySQL, SQLite, PostgreSQL, H2)
    • Customisable Database Properties
  • And so much more...

Usage

  1. Download the plugin from the latest releases here
  2. Drop the plugin into your server's plugins folder and start the server. Make the plugin generate the default files for you.
  3. Configure the plugin properties to your liking inside the murderrun folder.
  4. Run the /murder gui command to open a GUI. Create and modify any arenas and/or lobbies to your liking. In your lobby, you can run /murder npc spawn survivor and /murder npc spawn killer to spawn both the survivor and the killer gadget shop, which can be used to buy gadgets.
  5. Run the /murder gui command and configure and create a new game.
  6. Click on the bold aqua message in chat to invite other players. Close the menu and re-open the menu to update the player list. You can also change the roles of other players from survivor to killer and vice versa by clicking on their player head (assuming that they have joined the game already).

Configuration

There are multiple ways to configure the plugin. You can customize the locale by editing the messages in the murderrun/locale/murderrun_XX_XX.properties file, and change formatting using MiniMessage. You are also able to edit game-specific properties in the murderrun/settings/game.properties file, such as gadget sounds, durations, effects, pauses, and much more. Modify the resource pack sounds and textures by changing their respective files in the murderrun/sounds and murderrun/textures folders. Resource packs are built at runtime and served using MC Packs by default, but you are able to self-host an HTTP server on your server if wanted. Check the config.yml file to configure JSON or database options, HTTP server options, languages, and so much more.

Commands

Use the /murder help command to generate a list of commands in-game, and see what each command does. You are able to retrieve specific gadget items, handle lobbies/arenas/games, create default NPC shops, and so much more via this plugin.

Permissions

Permissions are based on the command. For example, the /murder command gadget retrieve-all command would have the murderrun.command.gadget.retrieve-all permission. Follow the same format for the rest of the plugin commands. It's recommended that you use LuckPerms to handle your permissions.

Compilation

  1. Install Jetbrains Runtime (Java 21)
    • Used for hot swapping purposes and faster development. Set the project JDK to be this for Gradle to work.
  2. Run /gradlew build

Sponsors

BisectHosting

Want to show your support for me and the development of MurderRun? Check out BisectHosting and use the pulse for a 25% discount on your first month of a gaming server as a new customer. With their 24/7 support and quick response times, you can count on excellent assistance for all your gaming requirements.

Contributors

Name Contribution
GTedd__ Created Simplified and Traditional Chinese Locale Translations