Realm Kits

Starting and respawn kits for multiplayer servers.

Friends who join a long-running game late shouldn't start with a pistol while everyone else flies around in power armor, and they shouldn't get gear the team hasn't earned either. Realm Kits gives each new character a kit when they first appear. The default kit, Newcomer, matches what the team has researched: the best armor it has, filled with the equipment it has, plus guns, ammo and robots to match.

Everything is a runtime Mod setting, so an admin can change it mid-game without restarting the server.

What it does

• First join kit. Given once to each new character. Players who were already in the save when you add the mod aren't new, so they don't get one; give them one with /realm-kit.
• Respawn kit. Given every time a player respawns. Off by default.
• Never lost. A kit waits until the player is in the game with a character, so the intro cutscene or a disconnect doesn't swallow it. A first-join kit is never given twice.
• Optional bonuses. Extra worker robot speed and inventory slots for the player force. They stack with research, and changing or removing them later only undoes what this mod added.

Settings

Under Settings → Mod settings → Map (admins, in game or on the server):

The kits

• None: nothing.
• Survival: a pistol, 20 firearm magazines, 2 burner mining drills, 2 stone furnaces and 10 wood.
• Newcomer (follows research): the best of power armor MK2, power armor, modular armor, heavy armor or light armor the team has researched, its grid filled with whatever the team has researched of a fission reactor, 2 personal roboports, 2 exoskeletons, 2 batteries, 6 portable solar panels and night vision. Plus a pistol and 50 firearm magazines, an SMG (Military), 50 piercing rounds (Military 2), 20 construction robots (Construction robotics), 50 transport belts, 2 burner mining drills and 2 stone furnaces.
• Full: power armor MK2 with 2 fusion reactors (fission without Space Age), 5 exoskeletons, 4 personal roboport MK2s, 2 battery MK2s, personal laser defense and night vision, all charged. Plus 100 construction robots, an SMG and 200 uranium rounds.
• Pacifist: the Full kit without the SMG, ammo or laser defense, and with 4 battery MK2s.

Items that don't fit in the inventory are dropped at the player's feet.

Commands

/realm-kit <player> <kit> gives a player a kit now, or when they next join. Admins only; it also works from the server console and RCON.

/realm-kit Alice newcomer

For scenario and mod authors

remote.call("realm-kits", "give", player, "newcomer") -- true if given now, false if queued
remote.call("realm-kits", "kits")                     -- {"none", "survival", "newcomer", "full", "pacifist"}

player can be a LuaPlayer, a name or an index.

Credits

The Full kit is inspired by Zerdex's Robot Quick Start. Realm Kits is part of a larger, experimental "Realm" project for the hacktorio server.

MIT licence.