Minecraft Lockout

Minecraft Lockout with over 300 goals, inspired by SmallAnt's Lockout Bingo mod. Compatible with Fabric 26.3.

This mod is based on the work of marin774, Specnr, and RasmusAntons This fork is maintained by Truffle.

Installation

Client

Make a 26.3 instance, add Lockout and Fabric API to your mods folder.

This mod supports players on Vanilla or Bedrock clients (via Geyser) thanks to the API feature which allows the board to be viewable from the web. See the "Lockout Web Integration" section below.

Recommended Performance Mods

• Sodium
• Lithium

Server

If running Lockout on a dedicated server, make sure to install Fabric. Add Lockout and Fabric API to server's mods folder.

NOTE: You can host the server from your own computer by opening a world to LAN and using TCP tunneling services or mods such as e4mc.

Commands

Game Setup

Create teams using the vanilla /team command. Two teams are automatically created for you when the world loads.

• /team add <team name> - Create a team
• /team join <team name> <player name> - Add a player to a team
• /team modify <team name> color <color> - Change team's color (optional)

Start a Lockout match:

• /lockout teams <team name> <team name> ... (only two teams are supported presently. Future updates may provide support for up to 16 teams)
• /lockout players <player name> <player name> ... - 1v1

Start a Blackout match:

• /blackout team <team name>
• /blackout players <player name> <player name> ...

Gameplay

Chat with your team:

• /chat team

Forfeit from an active game:

• /resign - Allows teams to forfeit. All players on a team must resign for the team to forfeit.
  • Recalculates goals if needed
  • Removes player(s) from in progress goals
  • Removes player(s) from compass

Offer a draw:

• /draw - All players must use this command to cause the game to end in a draw.

Pause the game:

• /pause - Pause (or resume) the game. Players and the world will be frozen.

Change board position:

• /BoardPosition <left/right> - changes the position of the board. If you select left, board will be hidden when you enable debug hud (F3).

Utility

Get biomes nearby required for goals:

• /GetNearbyBiomes

Get structures nearby required for goals:

• /GetNearbyStructures

Reload the Goal Pool after changes to goal-pool.yml:

• /ReloadGoalPool

Lockout Web Integration

This mod integrates with lockout-web to sync game stats and preserve a record of your games. More information about the stats site will be available in the future.

To upload stats while playing, set the game number and league id with the following command before the game starts.

• /UploadStats <game_number> <league_id>

Configuration

There are a bunch of configurable options in config/lockout.json. Values in this file will be global defaults and can be overridden per-world using the /LockoutConfig command.

• /LockoutConfig <setting> - Query the current value of a setting.
• /LockoutConfig <setting> <value> - Change the value of a setting.

Settings

• boardSize (default 5)
• boardDifficulty (default 5)
• boardPosition (default right)
• startTime (seconds, default 60)
• hasTimeLimit (default false)
• maxTime (minutes, default 120)
• allowDraw (default true)
• allowResign (default true)
• endOnWin (default true)
• allowVanillaPlayers (default false)
• midgameJoinBehavior (default "spectate", can be set to "prompt" or "kick")
• giveCompasses (default false)
• enforceModList (default false)
• allowedMods (default "lockout", "sodium", "lithium", "fabric-api", "modmenu", "placeholder-api")
• enableHMAC (default false)
• verificationBehavior (default "kick", can be set to "ban" or "log")
• apiURL (default unset)
• apiKey (default unset)

Board Builder

You can create and play custom boards in-game. Boards are saved client-side, in .minecraft/lockout-boards

Open the Board Builder:

• /BoardBuilder
• or press the Open Board hotkey (before any match starts)

Set a custom board:

• /SetCustomBoard <custom board name> - this board will be used for the next match, but server restarts will unset this.

Unset a custom board:

• /RemoveCustomBoard

Generating Boards

Coming soon...

Goal Pool Customization

You can pick and choose which goals you want the random board generator to select from.

• The config file can be found here: .minecraft/config/goal-pool.yml
• Set goals to 'true' to enable, 'false' to disable
• The default values are based off the behavior in the original mod

Vanilla Modifications

• Piglin barter rates are the same as 26.3 but with some modifications:
  • Pearl weight is doubled, amount is 4-6 instead of 2-4
  • String trade amount is 6-12 instead of 3-9
• Raids replicate those on Normal difficulty (guarantees all Illagers)
• Zombies always convert Villagers into Zombie Villagers

Credits

• Lockout Concept by SmallAnt
• Original mod by marin774
• Edits done by Specnr, RasmusAntons, and Truffle
• Coreybirdo, Tharve and EnderRouge - Additional goal ideas and suggestions