Modding

From Plan B Terraform Wiki
Jump to navigation Jump to search

This page tells you how to download and install mods, and gives a quick overview of what you should keep in mind when creating a mod. For more detailed instructions on creating mods, you may view the modding tutorial page.

Introduction

Installing mods

Installing C# mods

Installing the BepInEx modding framework

1. [One time only] Download the 64-bit BepInEx 5.4.21+ from BepInEx releases

2. [One time only] Unpack the BepInEx zip into the game's folder

  • Example: c:\Program Files (x86)\Steam\steamapps\common\Plan B Terraform\

3. [One time only] Run the game. Quit the game

  • You should now see the BepInEx\plugins directory in the game's directory

Installing mod binaries

1. Find the mod binaries on the authors' website or modding portals (such as NexusMods)

  • Download the zip.
  • Make sure you don't mistake the source code with the mod binaries.

2. Unpack the mod zip into the BepInEx\plugins directory.

  • I highly recommend keeping the directory structure of the zip intact, so, for example, it will look like BepInEx\plugins\akarnokd - (Feat) Add City Names
  • It makes updating or removing mods much easier.

3. If the mods don't appear to work, check the BepInEx\OutputLog.log for errors.

  • Also check the game's own log in %USERPROFILE%\AppData\LocalLow\Gaddy Games\Plan B Terraform\Player.log

4. Many mods have configuration files you can edit under BepInEx\config.

  • [Once per mod] For the config file to show up, run the game and quit in the main menu.
  • The config file will be under the BepInEx\config (for example, BepInEx\config\akarnokd.planbterraformmods.feataddcitynames.cfg). You can edit with any text editor.
  • If something stops working, delete the cfg file and the mod will create a default one the next time the game is run.

Installing Lua mods

TBD

Installing Workshop mods

Currently, the game doesn't support Steam Workshop, but it is in the plans.

Developing mods

Developing C# mods

See: Developing C# Mods

Developing Lua mods

TBD

Known modders and mods

akarnokd

Repository location: https://github.com/akarnokd/plan-b-terraform-mods

Latest releases: https://github.com/akarnokd/plan-b-terraform-mods/releases/latest

Documentation: https://github.com/akarnokd/plan-b-terraform-mods#current-mods

Feature mods

  • Add City Names - Customize the selection of city names the game will use to generate the map.
  • City Population Label - Display the population number underneath the city label in the main view and/or minimap.
  • Depot Priority - Set priorities on depots so containers will be force-transferred towards higher priority depots.
  • Disable Building - Enable and disable production buildings via a on-screen button or keyboard shortcut.
  • Go to Exhausted Extractors - Shows a blinking panel (bottom left) if there are any extractors that have run out of minable ore.
  • Hotbar - Adds a bar at the bottom of the screen with 3 subpanels and 9 slots each for quickly selecting a building to be built.
  • More Cities - Generate more cities for a new game.
  • More Ore Fields - Generate more and bigger ore fields.
  • Multiplayer - Lan/Internet-based co-op multiplayer where one player is the host. (Opens wiki).
  • Live GUI Scaler - Scale the GUI by holding CTRL and pressing Numpad Plus, Numpad Minus or via Mouse wheel
  • Navigate to Points of Interest - Shows a panel on the right side of the screen with cities and landmarks. Clickable/Scrollable.
  • Production Limiter - Limit the production items that go into the global storage.
  • Production Statistics - Show the production and consumption speed of items.
  • VSync Limit Framerate - Reduce the framerate when vsync is turned on to 1/2, 1/3 or 1/4 of the system's default framerate.

Translation mods

  • Hungarian Translation - Hungarian Translation (Magyar fordítás).
  • Traditional Chinese Translation - Traditional Chinese Translation (繁體中文).

Cheat mods

  • Build Ice Extractors Anywhere - allows building Ice Extractors anywhere on the map, not just on ice.
  • Edit Ore Cells - Place and remove ores from the surface.
  • Endless Resources - all resource nodes being extracted will have a minimum amount and never run out.
  • Progress Speed - speed up extractors, factories, drones and vehicles.

Valoneu

Repository location: https://github.com/Valoneu/Plan-B--Terraform-mods

Latest releases: https://github.com/Valoneu/Plan-B--Terraform-mods/releases

Documentation: https://github.com/Valoneu/Plan-B--Terraform-mods/blob/main/README.md#lisf-of-my-mods

Feature mods

  • Larger cities - Makes the cities larger with same pops.
Retrieved from "https://planbterraform.wiki.gg/index.php?title=Modding&oldid=1573"