Getting Started

MiniModes is a framework for Minecraft mini‑games.
This guide walks you from zero to first game:

1. Installing the plugin
2. Adding some game extensions
3. Playing your first match

---

Prerequisites

Before installing MiniModes, make sure you have:

• A Paper server (supported Minecraft version)
• Access to the server’s plugins/ folder
• Permission to restart the server (you only have to do this once)
• Basic familiarity with installing plugins

If you’re hosting with a panel (Pterodactyl, Multicraft, etc.), use its file manager or SFTP to upload files.

---

1. Install MiniModes

1.1 Download MiniModes

• Download the latest MiniModes.jar from Modrinth.
• Make sure the version matches your server’s Minecraft / API version.

1.2 Drop into plugins/

• Stop your server.
• Upload the MiniModes.jar file into the server’s plugins/ folder.
• Do not unzip it.

1.3 Restart the server

• Restart your server.
• Watch the console for lines mentioning MiniModes.
• You should see it create a MiniModes folder in plugins.

When the server is up, verify the plugin is loaded:

• Run /plugins in‑game or in console.
• You should see MiniModes in the list and colored as enabled.

If it’s missing or red, check the console log for errors (wrong Minecraft version, missing dependencies, etc.).

---

2. Add game extensions

MiniModes itself is a framework.
Actual mini‑games are provided by extensions.

2.1 Find or create extensions

You have two options:

1. Use existing games

   • Download pre‑built MiniModes extensions (e.g. Spleef or Pillars) from your chosen source.
   • They will be in the .mmx file format, which is short for MiniModes Extension.

2. Write your own

   • Use the MiniModes API to build custom games as extensions.
   • See: “Creating Extensions” guide once you’re comfortable with the basics.

For this guide, assume you have at least one ready‑to‑use extension.

2.2 Install extensions

1. Locate the MiniModes data folder created on first start (typically found in plugins/MiniModes/).
2. Put your extension files in the extensions folder inside that directory.
3. Run /minimodes reload for the extensions to be loaded.

MiniModes will:

• Scan its extensions folder
• Load each extension
• Register the games defined in them

You should see logs indicating how many extensions and games were loaded.

---

3. Your first MiniModes game (player flow)

Once MiniModes and one or more extensions are loaded, join the server as a player.

We’ll go through:

1. Creating or using a party
2. Opening the MiniModes menu
3. Starting a game
4. Leaving or spectating

3.1 Ensure you’re in a party

MiniModes always treats you as part of some party:

• If you’re alone, it silently creates a solo party for you.
• For group play, you’ll use /party commands.

Typical flow for a party leader:

1. Run:

   • /party invite <player> to invite your friends

2. Invited players run:

   • /party accept <leaderName> or click on the invite message.

3. Confirm members with:

   • /party list

Note: Only the party leader can start games, invite/kick players, and control Mashup mode.

3.2 Open the game selection menu

As the party leader, open the MiniModes game menu:

• /minimodes

You’ll see a GUI like this:

• Title: “MiniModes – Select a Game”
• One icon per loaded game

Each game icon shows information if you hover over it:

• Game name
• Short description
• Min/max players
• Whether your current party is allowed to start it
  • Too few/many players
  • You’re not the leader
  • Members already in another game, etc.

If a game can’t be started, MiniModes will always tell you why using the lore or chat messages.

3.3 Start a game

To launch your first match:

1. Make sure:

   • You are the party leader
   • Your party size fits the game’s min/max players

2. Click on a game icon in the /minimodes menu.

You will be teleported to the game and see titles/messages about what to do next.

---

4. Basic in‑game commands

During a game, players can use:

• /mm game leave
  Leave the current game and return to the lobby / spawn.

• /mm game spectate <player>
  Teleport to another player’s current game to watch as a spectator.

• /mm game stop
  Game leader only; stops the running match without any winners.

• /mm game win <players…>
  Game leader only; marks one or more players as winners and ends the game. Useful for custom or “judged” games.

Some games support runtime settings: These are settings that can be changed after the game already started, for example when you made a mistake during pre-game setting selection.

• /mm game settings
  • Everyone can open the settings UI to view options.
  • Only the leader (and only for settings that are marked as runtime‑mutable) can change them.

---

5. Try Mashup mode (automatic playlists)

Once you’ve become familiar with the MiniModes system, try Mashup mode to keep your party playing random games with no extra clicks.

From the party leader account:

1. Start Mashup:

   • /party mashup start

2. What happens:

   • MiniModes continuously picks Mashup‑compatible games from your loaded extensions.
   • It only chooses games that:
     • Support your current party size
     • Allow Mashup mode
   • It avoids repeating the same game twice in a row when possible.
   • For games with settings, it usually randomizes settings automatically (no voting).

3. Stop Mashup:

   • /party mashup stop

Mashup stops automatically if the party disbands or members go offline, but using the explicit stop command is recommended when you’re done in order to get an overview leaderboard of the mashup session.

---

6. Quick troubleshooting checklist

If you don’t see what you expect, check these first:

The plugin doesn’t show in /plugins

• Make sure MiniModes.jar is in the server plugins/ folder, not a subfolder.
• Confirm you’re running a supported Paper version.
• Check the latest console log for MiniModes errors or dependency issues.

/minimodes does nothing or says “unknown command”

• Confirm MiniModes is enabled in /plugins.
• Ensure there’s no conflict with another plugin:
  • Temporarily remove conflicting plugins to test.
• For non‑op users, verify permissions are granted.

No games appear in the menu

• Confirm you placed your extensions in the correct MiniModes directory.
• Check the startup log:
  • Does MiniModes log that it “found 0 games” or show errors loading extensions?
• Make sure your extensions are built for the same MiniModes major version.

Party / Mashup issues

• Confirm who is the party leader (/party list).
• Ensure the party size fits the game’s min/max players.
• If Mashup never starts a game:
  • Check that at least one game is marked as Mashup‑compatible and supports your party size.

---

7. Where to go next

Once you’ve successfully run a few games:

Learn player workflows

Deep dive into parties, rematches, spectating, and Mashup from a player perspective.

Server owner best practices

Configure worlds, performance, permissions, and integration with other plugins.

Build your own games

Use the MiniModes API to write custom mini‑games that plug into the shared menus and flows.

With MiniModes set up, you have a framework, not just a single mini‑game.
Add more extensions, experiment with Mashup, and start shaping your server’s game library.