Introduction

This mod is for PVP matches. It is (hopefully) designed to be modular and flexible, and give control to the user.

Core cycle

The mod centers around a core gameplay cycle:

1 - Lobby time. This is where all the players are in a designated "lobby" area, it is meant as a little break between matches to rest, along with voting for the next map and such.

2 - Matches. This is the real meat of the mod, what it was all built for. The match can either last for a certain amount of time, or end when a certain score is reached. Players battle each other (depending on the gamemode), and rack up points. The person at the end of the game with the most point wins! Then everyone goes back to the lobby to wait for the next round.

Now that you know the gist of how the mod works, let's look at how to get started.

Lobby

The very first thing to do is to make the lobby. You can decorate it however you want, but the important thing is to set the position using /arena setLobbyPos <position>.

Maps

Maps are the locations players will fight in. The mod does not come with any built-in; instead, it is left to you to create them (or download them from somewhere). It is important to remember that maps are not stored as separate files, they only store some information such as the gamemode and location, and the map itself is simply whatever you put inside the designated area. Any changes made to the map outside a match will persist, just like the rest of the world. However, during a match, the mod keeps a backup of the map right before the match started, which replaces the map once the match ends, to revert any changes made while in the match. This includes entities; they are saved and loaded just like the blocks, so keep that in mind when creating your maps.

To create a map, you will first want to find a nice area to build it in. This is where the map will stay, unless you use schematics or the like to copy-paste it somewhere else. You can choose anywhere, from an underground cave to a map in the sky, or just stick with some natural terrain. The next step is optional but highly recommended: surround the map area with barrier blocks. If the bottom of the map is open, place some Kill Barriers instead, players will die as soon as they step foot on them, otherwise they might get trapped. Make sure to also put barriers over the top of the map, otherwise players may leave the map by going over the walls.

Once you have your area walled off, the next step is to choose a Gamemode. This will affect the rest of the requirements, as each gamemode has different requirements for the map. Once you have a gamemode selected, make sure your map meets the requirements. One requirement is consistent across all gamemodes: spawnpoints. Spawnpoints are designated with the Spawnpoint block; just place one down wherever you want a player to be able to spawn. The spawns can be colored to specific teams by clicking on them with a dye, as long as there is a team for that color.

Once you have met the requirements, you can create the map. Use /arena map create <Map name (can have spaces if there are quotes)> <gamemode> <corner 1> <corner 2>. This will create the map if it's valid, or tell you why it isn't.

It's good to note that when you create a map, it will take a screenshot of it to display when voting. If you don't like the screenshot, you can update it by using /arena map update <name>, and it will update the time, weather, and screenshot of the map.

You can also use /arena map load <name> to "load" a map, setting the time and weather to the stored values, and teleporting you to the center.

Loadouts

Loadouts are sets of items that are given to the player when they respawn. To make one, simply arrange your inventory into the loadout, then use /loadout add <name> to add it to the list of available loadouts.

Each player can choose a loadout using '''/loadout select '''.

Conclusion

Now that you have a lobby, some maps, and at least one loadout, you are ready to get started! Use /arena start to initiate the cycle, and /arena stop to stop it at any time. The cycle will not persist across sessions, so if the world closes then it stops anyways. Gather some friends and start playing!

If you'd like to dive a little deeper, take a look at the mod configs and tweak them to your liking, or if you want to make an addon, take a look at Addons.