Skip to content

GoldenGamerLP/Minesumo

Repository files navigation

Minesumo CodeFactor Java CI with Gradle and Upload

Abstract

This is a Minecraft extension for the gamemode Sumo. The plugin was developed for Minestom.

Download Link

Wanna test it yourself?

Features

  • Automatic Arena Queuing
  • Automatic Arena Selection
  • Full Players and Arena statistics
  • Async Programming in mind
  • Easy Party Implementation
  • Customizable Arenas
  • Customizable Messages (currently only German, English! Read more below)
  • MongoDB Support (for Stats)
  • Easy to setup!

Setup

  1. Download the lastest version of the extension
  2. Use a Minestom Server of your choice
  3. Put the extension in the extensions folder
  4. Start the server
  5. Stop the Server and edit the config.json in the extensions/minesumo folder. Put the MongoDB String and put "isInEditorMode" to true.
  6. Start the server again
  7. Get some Schematics of your choice and put them in the extensions/minesumo/schematics folder. Make sure the schematics are Sponge-schematics!!!
  8. Log into the Server and type /setup join <yourSchematic.schem>. This will create a new arena with the name of the schematic. You can now edit the arena.
    • Make sure to:
    • Set the spectator spawn of the arena. Via /setup spectator set
    • Add any spawn. Via /setup spawn add. Or remove any Spawn. Via /setup spawn remove
    • Set the death-height of the arena. Via /setup deathheight set
    • When done editing the arena, type /setup SAVE. This will save the arena, and you can now use it. The Server stops to save.
  9. Repeat step 7 for every arena you want to use.
  10. Edit the config.json again. Set "isInEditorMode" to false.

Commands

  1. /setup - The setup command. Use /setup to setup maps. Only available in editor mode.
  2. /start - Starts a Sumo match. Configure a custom amount of players in the config to start a match.
  3. /lives - Sets the amount of lives you have. Default is 3. Range and Default editable.
  4. /stats [player] | game [gameID] - Shows your stats or the stats of a player or arena.
  5. /gameid - Shows the ID of the current game you are in.
  6. /debug - Use on your own risk.

Messages

  • The messages are currently only available in German and English.
  • You cannot edit the messages until you edit the resources in the classpath.

Examples

Pictures

In-Game

Player Stats

Arena Stats

Main Configuration

Example Map Configuration

Folders created by Minesumo

Footnote

I worked about one month on this project. I hope you enjoy it. If you have any questions, feel free to contact me on Discord: GoldenGamerLP#1404 If you have any suggestions, feel free to open an issue or contact me on Discord.

License

This project is licensed under the GNU GENERAL PUBLIC LICENSE Version 3.