1. Introduction

The Xinada Project consists of a plugin for the Minecraft game. The plugin organizes and starts rounds of a mini-game based on the well-known Murder Mystery. For those unfamiliar with the Murder Mystery game, here's a brief explanation: At least 3 players are required and there are 3 different roles. The Cop, the Murderer and the Innocent. The Murderer must wipe all players out, while the Cop must identify and arrest the Murderer before he achieves his goal. The Innocent will be just watching and trying to survive. In case there are 5 players, for example, 3 of them would be Innocent.

The Murder Mystery game is already quite fun in itself. But what if all Innocents had a unique ability? What if in addition to Innocents, there were other roles that may help or frame the Murderer? That's where the Xinada plugin comes in! With over 30 different aroles, Xinada offers a mini-game with great replayability! At least 3 players are required, the more the better (maximum 10).

Visit my Github page to learn how to properly setup this plugin:

This plugin is free for everyone, but feel free to donate, if you feel like it
Also, don't forget to rate my plugin!

2. Screenshots





3. Setup

To properly setup the plugin follow these steps:

1 - Make sure you're using the 1.17 version of Minecraft;

2 - Put xinada-X.X.X.jar in your Spigot server plugins folder (. ../server_folder/plugins/);


3 - Run the server once. When the server loads up, you should see somewhere in the console: "[Xinada] Enabling Xinada vX.X", "X.X" being the version of the plugin;


4 - Close the server;

5 - Back in your server folder, you'll see the plugin created the world Xinada, as well as Xinada_nether and Xinada_the_end. This happened because the default world for this plugin is called Xinada. This can be changed in the plugin's config files. More on that after these instructions.



6 - Also, inside the plugins folder, you'll see a new folder called **Xinada**. This folder has important config files inside. They all have flags you can mess with, except for the stringsXX.yml files. You don't want to mess with those, since they contain translations of Xinada's supported idioms. More on the Configuration Files after these instructions.


7 - Now that you know how to use the Configuration Files, all that's left is add maps to maps.yml. All you have to do is create a world containing various different small maps (this would be easier with mcedit). You can find lots of small maps on planetminecraft.com, if you search for something in the lines of "Murder Mystery map" or "TTT map" or "Call of Duty map". You can add whatever maps you like. Just make sure players won't be able to walk out of them in-game. You can use this Dropbox link to download the world compatible with the default maps.yml the plugin generated.

8 - Then, you'll have to choose 10 spawn points for each small map and fill maps.yml with that information. You can see how after these instructions. You don't need to do this if you are using the world provided by the last step's Dropbox link.

9 - That's it! Now use the commands to start playing! Enjoy!

10 - For a better experience, use the NoNameTag plugin to prevent players from seeing name tags through walls.

If you run into any issues, feel free to contact me.



4. Configuration

4.1. Game Configuration

In the game.yml file, you may adjust some game related flags.

4.2. World Configuration

These are the world configurations. In the world.yml file is where you may change the name of the default world Xinada will use. You can also adjust lobby coordinates. These are the coordinates to which the players will be teleported when they join and when a Xinada game ends. It's the lobby in its essence.

4.3. Maps Configuration

The **maps.yml** file is where you setup and add your maps. All maps must be contained inside the same minecraft world (this easier to achieve using mcedit). The template in maps.yml is really easy to follow. Just add the name of the map (whatever you like) and 10 different spawn points where players may spawn in the beggining of a Xinada round. Example of a map:

Code (Text):

whatever_name_i_like:
  location1:
    x: 287.5
    y: 56
    z: 857.5
  ...
  location10:
    x: 331.5
    y: 56
    z: 847.5
 

4.4. Strings Configuration

Unless you don't want to play the plugin in english or portuguese, you won't need to mess with the stringsXX.yml files. If you are, let's say, italian and want to play Xinada in italian, you'll need to generate your own strings. Just create a stringsIT.yml file with the same content as the others stringsXX.yml files, but in italian. Then, go to game.yml and add "IT" to the language list.



5. Roles





6. Commands

1. Use /start to start a game with the players that are in the server. A game starts in 5 seconds.
2. Use /end to end the current game.
3. Use /next to jump to the next round. No points are assigned to any players.
4. Use /role to see your role and objective, if you forgot.
5. Use /lang <country code> to change the language of the plugin (for example, /lang en or /lang pt). There has to be a file strings<country code in uppercase>.yml containing all translated Strings, for the command to work.



7. Videos showcasing plugin