Text Pack Patching - PrimeSonic/PrimeSonicSubnauticaMods GitHub Wiki

How to make a custom battery mod using Text Packs

(!) Sample plugin packs can be found here

Step 1. Create the containing folder

You will need a new folder inside QMods/CustomBatteries/Packs to hold your files.
This folder can be named anything you want but it would be best to give it a unique name.

Step 2. Create the text file

Inside the folder you created, make a new, empty text file named CustomBatteriesPlugin.txt. It must be named CustomBatteriesPlugin.txt.

Step 3. Edit the plugin text file

You can copy and paste this template or the sample packs to get started

CustomBatteriesPack:
(
    PluginPackName: MyPluginPackId;
    BatteryCapacity:120;
    UnlocksWith:Peeper; # Optional #
    BatteryID:MyBatteryId;
    BatteryName:"My First Battery";
    BatteryFlavorText:"Flavor text for my battery.";
    BatteryParts: Peeper,Titanium,Copper,WhiteMushroom;
    BatteryIconFile:"MyBattery.png";
    PowerCellID:MyPowerCellId;
    PowerCellName:"My First Power Cell";
    PowerCellFlavorText:"Flavor text for my power cell";
    PowerCellAdditionalParts:WiringKit;  # Optional #
    PowerCellIconFile:"MyPowerCell.png";
    UseIonCellSkins:true; # Optional #
);

Explaining each line of the plugin file:
PluginPackName This is an internal ID for your entire pack.
BatteryCapacity This is how much energy your custom battery will hold.
Your power cells will always hold twice (2x) as much energy
UnlocksWith This sets an item that must be scanned or picked up before the battery and power cell are unlocked for crafting.
This line is optional and can be omitted.
If omitted, the items will be unlocked at the start of the game.
BatteryID This is an internal ID for your battery. Make sure it is unique.
BatteryName This is the name of the battery as displayed in-game.
This text should be wrapped in quotes ".
BatteryFlavorText This is the battery description displayed in-game when you are in the inventory or crafting menus.
This text should be wrapped in quotes ".
BatteryParts This is a comma , separated list of materials required to craft the battery.
If you want to to require more than one of an item, just include that item multiple times in the list.
BatteryIconFile The name of the png file to be used as the icon for the battery when viewed in the inventory and crafting menu.
PowerCellID This is an internal ID for your power cell. Make sure it is unique.
PowerCellName This is the name of the power cell as displayed in-game.
This text should be wrapped in quotes ".
PowerCellFlavorText This is the power cell description displayed in-game when you are in the inventory or crafting menus.
This text should be wrapped in quotes ".
PowerCellAdditionalParts This is a comma , separated list of additional materials required to craft the power cell.
All power cells will always require 2 batteries and a Silicone Rubber to craft.
This list is only what materials to require on top of that.
This line is optional and can be omitted.
PowerCellIconFile The name of the png file to be used as the icon for the power cell when viewed in the inventory and crafting menu.
UseIonCellSkins Set this to true if you want your battery and power cell to use the textures for the Prescursor Ion Battery and Power Cells.
This line is optional and can be omitted.
By default, the textures for the regular battery and power cell are used.

Step 4. Add custom icons

  • In the same folder you created in Step 1, add a png file for your battery and your power cell.
  • The file names must match what you set for BatteryIconFile and PowerCellIconFile in your plugin pack file.

You can look up the Spawn IDs for various items on the Subnautica wiki
https://subnautica.fandom.com/wiki/Raw_Materials

⚠️ **GitHub.com Fallback** ⚠️