Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/GoldenGamerLP/Minesumo

Sumo in Minestom with Stats
https://github.com/GoldenGamerLP/Minesumo

game gamemode minestom-extension mongodb sumo

Last synced: 12 days ago
JSON representation

Sumo in Minestom with Stats

Lists

README

        

# Minesumo [![CodeFactor](https://www.codefactor.io/repository/github/goldengamerlp/minesumo/badge)](https://www.codefactor.io/repository/github/goldengamerlp/minesumo) [![Java CI with Gradle and Upload](https://github.com/GoldenGamerLP/Minesumo/actions/workflows/gradle_build.yml/badge.svg)](https://github.com/GoldenGamerLP/Minesumo/actions/workflows/gradle_build.yml)

## Abstract

This is a Minecraft extension for the gamemode **Sumo**. The plugin was developed for [Minestom](https://github.com/Minestom/Minestom).

## Download Link
- [Latest Build of Minesumo](https://nightly.link/GoldenGamerLP/Minesumo/workflows/gradle_build/master/artifact.zip)

## Wanna test it yourself?
- Check it out at **www.strage.ovh:45565** with Minecraft Version 1.19.2!

## Features

- [x] Automatic Arena Queuing
- [x] Automatic Arena Selection
- [x] Full Players and Arena statistics
- [x] Async Programming in mind
- [x] Easy Party Implementation
- [x] Customizable Arenas
- [x] Customizable Messages (currently only German, English! Read more below)
- [x] [MongoDB Support](https://github.com/mongodb/mongo-java-driver) (for Stats)
- [x] **Easy to setup!**

## Setup
1. Download the lastest version of the [**extension**](https://nightly.link/GoldenGamerLP/Minesumo/workflows/gradle_build/master/artifact.zip)
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 **. 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

- [Example Configurations with Schematics](https://workupload.com/file/RRzXEPBhz68)

## 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.