Note for older BepInEx Versions: It is not recommended to use older versions, as they may crash the game.
Note for newer BepInEx Version: General you can also use newer Versions. In the very most cases this will work but is simply not final reviewed to be working for this Wiki. WARNING: Do not use BepInEx 6.x. This major version is currently fully incompatible with 5.x mods from this Wiki!
Copy the .zip file into the Planet Crafter install folder (for example C:\Program Files (x86)\Steam\steamapps\common\The Planet Crafter)
Extract the .zip file. It should create a folder called 'BepInEx' and add some files to the folder highlighted in yellow. (Note: folder name no longer includes 'Prologue')If you only see a new directory named BepInEx_x64_5.4.22.0, you extracted the zip wrong. Open this directory and copy all files and directories to its parent directory.
On the Steam Deck, open the game's properties and put WINEDLLOVERRIDES="winhttp.dll=n,b" %command% into the launch options field. Start Planet Crafter and when it's done loading exit it again.
Inside the previously created 'BepInEx' folder should now be a 'plugins' folder. Place the .DLL and any other files required by the mod in that folder. For example, the AddCraftableObjects and AdvancedOreExtractor plugins would add these files.
An example of plugin files added to the BepInEx plugins folder.
After adding any mods you want, start Planet Crafter again and BepInEx will add any configuration files to the BepInEx/config folder. These need to be edited with a text editor like Notepad to change any settings you want to for the mod.
If mods don't work for you, find the BepInEx\config\BepInEx.cfg file, and in it, set HideManagerGameObject = true .
Find the line shown above and change false to true.
You can alternatively use BepInEx Unity Installer from Nexus Mods to install BepInEx for you.
Installing mods[]
Download the mod's zip file from NexusMods or the author's website.
Unpack it into BepInEx\plugins
Launch the game, quit the game
Find the mod's config file under BepInEx\config
Multiplayer Compatibility Matrix[]
Legend
OK: it is completely optional who has it.
Capable: it is completely optional who has it, but there are caveats.
Host only: the host needs to have it installed and enabled, having it on the client has no effect.
All or none: everyone either has to have it installed, or no one can have it installed.
Broken: having it installed and playing it in multiplayer can break the game.
Mod multiplayer compatibility matrix
Author
Mod
Status
Remark
akarnokd
(Cheat) Asteroid Landing Position Override
Host only
Disables itself in client mode
akarnokd
(Cheat) Auto Consume Oxygen-Water-Food
OK
akarnokd
(Cheat) Auto Grab and Mine
OK
akarnokd
(Cheat) Auto Launch Rockets
Host only
akarnokd
(Cheat) Auto Sequence DNA
Host only
akarnokd
(Cheat) Auto Store
All or None
akarnokd
(Cheat) Automatically Harvest Food n Algae
Host only
akarnokd
(Cheat) Craft From Nearby Containers
All or None
akarnokd
(Cheat) Hide Water in Photomode
OK
akarnokd
(Cheat) Highlight Nearby Resources
OK
akarnokd
(Cheat) Inventory Stacking
All or None
Make sure everyone has the same settings.
akarnokd
(Cheat) Machines Deposit Into Remote Containers
Host only
akarnokd
(Cheat) Minimap
OK
akarnokd
(Cheat) More Trade
All or None
akarnokd
(Cheat) Recyclers Deposit Into Remote Containers
Host only
akarnokd
(Cheat) Wreck Map
OK
akarnokd
(Feat) Command Console
Capable
Can mess up the world, play only with people who you trust
akarnokd
(Feat) Flatlands
All or None
akarnokd
(Feat) Space Cows
All or None
akarnokd
(Feat) Technicians Exile
Broken
akarnokd
(Fix) Unofficial Patches
All or none
akarnokd
(Item) Rods
All or none
akarnokd
(Lathrey) Auto Move
OK
akarnokd
(Lathrey) Disable Build Constraints
OK
akarnokd
(Misc) Customize Flashlight
Capable
Changes are not yet visible to other players.
akarnokd
(Misc) Mod Enabler
OK
akarnokd
(Misc) Plugin Update Checker
OK
akarnokd
(Multi) Player Locator
OK
akarnokd
(Perf) Startup
Host only
akarnokd
(Save) Async Save
Host only
akarnokd
(Save) Auto Backup
Host only
akarnokd
(Save) Automatic Save
Host only
akarnokd
(Save) Quick Save
Host only
akarnokd
(UI) Beacon Text
OK
akarnokd
(UI) Continue
Host only
akarnokd
(UI) Customize Inventory Sort Order
All or none
Make sure everyone has the same settings.
akarnokd
(UI) Czech Translation
OK
akarnokd
(UI) Estonian Translation
OK
akarnokd
(UI) Hotbar
Capable
Host has to install it to be able to save the client loadout.
akarnokd
(UI) Hungarian Translation
OK
akarnokd
(UI) Inventory Move Multiple Items
OK
akarnokd
(UI) Italian Translation
OK
akarnokd
(UI) Korean Translation
OK
akarnokd
(UI) Logistic Select All
OK
akarnokd
(UI) Menu Shortcut Keys
OK
akarnokd
(UI) Mod Config Menu
OK
akarnokd
(UI) Overview Panel
OK
akarnokd
(UI) Pin Recipe to Screen
Capable
Host has to install it to be able to save the client loadout.
akarnokd
(UI) Polish Translation
OK
akarnokd
(UI) Prevent Accidental Deconstruction
OK
akarnokd
(UI) Romanian Translation
OK
akarnokd
(UI) Save When Quitting
Host only
akarnokd
(UI) Show Consumable Counts
OK
akarnokd
(UI) Show Container Content Info
OK
akarnokd
(UI) Show Crash
OK
akarnokd
(UI) Show ETA
OK
akarnokd
(UI) Show Grab N Mine Count
OK
akarnokd
(UI) Show MultiTool Mode
OK
akarnokd
(UI) Show Player Inventory Counts
OK
akarnokd
(UI) Show Player Tooltip Item Count
OK
akarnokd
(UI) Show Rocket Counts
OK
akarnokd
(UI) Sort Saves On The Load Screen
Host only
akarnokd
(UI) Telemetry Font Sizer
OK
akarnokd
(UI) Ukrainian Translation
OK
Current Mods[]
Please note that game updates may break mods, and the links below may be outdated. Remember to back up your save before experimenting.
(Feat) Command Console - Press ENTER and type in commands to spawn items, teleport around or discover information about game data.
(Feat) Space Cows - Place a Grass Spreader (2 Water, 1 Magnesium, 1 Aluminium, 1 Lirma Seed) and a Space Cow will appear.
(Feat) Technician's Exile - After reaching 1.1 MTi, soon you'll get some company. Follow the in-game clues in this light expansion of the game's world.
Cheats
(Cheat) Asteroid Landing Position Override - asteroids land near the player, not all over the place.
(Cheat) Auto Consume Oxygen-Water-Food - no need to manually eat, drink or refill the O2 tank.
(Cheat) Auto Grab And Mine - grab and mine nearby items. Remake of various defunct grabber & miner mods. Press V to toggle.
(Cheat) Auto Harvest - automatically harvest Algae and Food, then place them into named containers such as *Vegetable0Growable and *Algae1Seed. The star (*) is mandatory.
(Cheat) Auto Launch Rocket - when you crafted a rocket, it will launch automatically; no need to press the launch button.
(Cheat) Auto Sequence DNA - Automatically grabs ingredients and sequences Tree Seeds, Butterfly Larvae, Bee Larvae and Silk Worms. Uses named containers.
(Cheat) Auto Store - Store items from the backpack into nearby containers having the same type of items. Press K. Quick Store replacement.
(Cheat) Craft From Nearby Containers - When crafting & building, consider nearby containers for ingredients. Press Home to toggle. Remake of Craft From Containers.
(Cheat) Highlight Nearby Resources - Press CTRL+F to show nearby resources with via banners.
(Cheat) Inventory Stacking - Show items stacked together in your and other inventories, backpack size indicates how many stacks of items you can carry.
(Cheat) Machines Deposit Into Remote Containers - Rename containers to *Osmium etc. and no need to run to the machine. The star (*) is mandatory.
(Cheat) Minimap - Shows a static minimap centered around the player which includes some points of interest.
(Cheat) More Trade - Add or modify trade items & their trade values via config.
(Cheat) Photomode Hide Water - workaround when items are not fully submerged and can't be picked up.
(Cheat) Recyclers Deposit Into Remote Containers - Recyclers deposit the decomposed ingredients into named containers. Supports automatic periodic recycling.
(Cheat) Teleport to Nearest Minable - Teleport to the nearest minable resource (F8). Hold Shift to also mine it. CTRL+F8 mine without moving.
(Cheat) Wreck Map - displays a map of wrecks as the player explores the hallways.
User Interface
(UI) Beacon Text - Customize beacons by showing a custom title and the distance from the player.
(UI) Continue - Adds a Continue button that let's one load the latest save. Save info is displayed next to it.
(UI) Customize Inventory Sort Order - Sort certain items before other items, such as O2, Water, Food, etc. The rest is alphabetical.
(UI) Hotbar - 9 slot bar to pin constructable items from the construction screen. Hold 1..9 while left clicking on an item to pin/unpin it. Press 1..9 on the main screen to build if possible. (Docs)
(UI) Inventory Move Multiple Items - Middle click to move all items of the same type (back and forth), Shift+Middle click to move 5, Ctrl+Middle click to move 50.
(UI) Menu Shortcut Keys - add shortcut keys to certain menus (backpack, containers, construction, machines). Available keys listed at the bottom of the screen.
(UI) Overview Panel - Pressing the F1 (configurable) shows an overview panel with the current status of the world, statistics and next unlocks.
(UI) Pin Recipe To Screen - On a crafting screen, press the Middle mouse button to pin/unpin a recipe.
(UI) Prevent Accidental Deconstruct - Hold the accessibility key (CTRL) while deconstructing to prevent unwanted deconstruct by a simple left click.
(UI) Save When Quitting - Automatically save when clicking on the "Exit to main menu" button in the pause screen.
(UI) Show Consumable Counts - next to the gauges on the bottom right, show how much food items, how many oxygen capsules and water bottles you have.
(UI) Show Container Content Info - Container tooltip shows how full the container is and what's in it.
(UI) Show ETA - Show the time unit the next terraformation stage given the current speed of terraformation.
(UI) Show Grab N Mine Counts - When grabbing items or mining resources, a small information text will pop up on the left side of the screen showing how many of the items you already have now in your inventory.
(UI) Show MultiTool Mode - on certain screen sizes, the 3D multitool is cut off. This mod adds a 2D text and image to the bottom right to show the current mode.
(UI) Show Player Inventory Counts - Show how many items the player carries on the bottom left next to the player coordinates.
(UI) Show Player Tooltip Item Count - In inventories, show how many items of the same kind are in the player's inventory.
(UI) Show Rocket Counts - On the Terraform screen, show how many boosting rockets have been launched for each category.
(UI) Telemetry Font Sizer - change the font size of the bottom left & right telemetry information for better readability.
Translations
(UI) Czech Translation - Překlad do češtiny.
(UI) Estonian Translation - Estonian Translation.
(UI) Hungarian Translation - Magyar fordítás.
(UI) Italian Translation - Italiano-traduzioni.
(UI) Korean Translation - Korean Translation (replaces the official translation).
(UI) Polish Translation - Polish Translation (replaces the official translation).
(UI) Romanian Translation - Traducere in romana.
Multiplayer
(Multi) Player Locator - show the list of connected players above the health bar. Show other players distance in the world as an overlay, toggled via H.
Other
(Fix) Unofficial Patches - Set of patches that fix game/UI bugs and shortcomings. See its documentation what's being fixed at any given time.
(Item) Rods - Adds Aluminium, Cobalt, Iron, Magnesium, Silicon, Sulfur, Titanium and Zeolite rods. Remake of cisox' mod.
(Misc) Mod Enabler - Sets the HideManagerGameObject = true in the BepInEx.cfg if necessary, allowing proper mod operations.
(Misc) Plugin Update Checker - Checks if newer versions of the installed plugins are available on the internet.
(Misc) Customize Flashlight - modify the color, size, brightness, reach of all the vanilla flashlights.
(Perf) Reduce Save Size - Removes unnecessary attributes when saving the world, saving disk space and Steam Cloud space.
(Save) Auto Backup - When saving the game, this mod will automatically make a backup copy (optionally compressed) in a specified directory. You can also control how many and how old backup saves to keep in this directory per world.
(Save) Automatic Save - This mod triggers a save automatically with a configurable period.
(Save) Quick Save - Press F5 (configurable) to quick save. Compatible with multiplayer.
(Lathrey) Disable Build Constraints - Disable collision constraints so you can build everywhere (rocks, other buildings, etc.). Toggle mode with Ctrl+G. (Remade with permission)
(Lathrey) Auto Move - The player character keeps moving without holding down the forward button. Toggle with CapsLock. (Remade with permission)
Mods by Shaklin[]
Warning Sounds - Custom low-amount warning sounds for health, thirst and oxygen.
AutoCrafterMod - Change the properties of Auto-Crafters.
Mods by Valriz[]
Storage Buffer - Set containers to both supply and demand to act as temporary storage.
Storage Display - Display the first item in the container visually above the container.
Grid Snap - Build anything either on or off the snapping build grid, and exactly where you want it without pesky collisions getting in your way.
Containers Plus - Adds additional storage options to help add some snaz to your base. Build your own tiny box, golden chest, wardrobe or safe!
Mods by WolvenScout[]
Eat Drink Sounds Minecraft Version - Replaces the eat and drink sounds from Shaklin's Eat Drink Sounds mod (required) with the appropriate effects from Minecraft
Mods by WarezLine[]
Spawn Items - This mod spawning items into the player backpack or world.
Spawn Meteore - This mod spawning meteore event and spawn resource list.
Inventory Plus - Configurable inventory for the containers in the game.
Mods by skrwoor[]
Recipe Library - This mod adds the ability to change the recipe(ingredients) of items and buildings.
Better Oxygen Warning Level - Lets you adjust the Warning Limit trigger and more. Also adds two new Oxygen Warnings ideal for Later Gameplay.
Water Collector Config - Lets you adjust the Frequency of Waterbootle Production on the Water Collectors.
Ore Extractor Focus - Adds Config Settings to the Ore Extractor. For all Settings check the Config File under "BepInEx/Config" You can adjust the Extractor Timer (How often you get a Ore), Focus on the Primary Ore or increase how often you get the Primare one.
Ore Breaker Focus - Adds Config Settings to the Ore Breaker. For all Settings check the Config File under "BepInEx/Config". You can adjust the Time Ore needs to break and how Many Ores you get back.
Defunct mods/modders[]
The following mods and modders have been abandoned or haven't been updated to the release version.
Check the other modders' arsenal for alternatives or remakes.
Plugins by akarnokd[]
(Cheat) Birthday - Re-enables the Birthday bunker and the oven.
As of v1.405, the vanilla no longer has this bunker so the mod can't work.
Mobile Crafter - Adds a chip that allows you to craft stuff with a press of a button you can change the key to use in config file
Warning: version 0.0.0.1 is not compatible with with the latest game version (0.6.008) and causes load-in crashes.
Lathrey[]
Warning (as of March 2023). The author has stopped updating his mods. We are in the process of remaking them within other mod suites. Please come to the official Discord #modding channel and vote for what mods to prioritize.
Note: As of 11/2022, it appears none of these have been updated since April 2022 on the github page, and several are no longer working with the newest versions of Planet Crafter. All mods renamed on April 14, 2022. Please delete old versions and copy over configs to the new file names.
Adds a UFO vehicle that provides oxygen, 40 inventory slots, and can be 'driven' around.
Unzip into the BepInEx\plugins folder to install (puts everything into a 'Lathrey-Vehicle' folder)
Ore Extractor Tweaks - Configurable changes to ore extractors. Remember to run once to generate the config file in the 'BepInEx/config' directory.
Alternative available. For example from (See Mod List) Desperationfighter - Ore Extractor Focus
Only_Extract_Detected_Ore (default true) - Prevents getting 'common' ores with extractor (waits and tries again). No effect for 'Iron' locations which still give all common ores.
Detected_Ore_Every_Tick (default false) - Detected rare ore is found every time (no waiting if it would have been a 'common' ore.)
Modify_Spawn_Rates (default false) - Enables changing rate of ore generation
T1_Spawn_Every_X_Seconds (default 70s) - Time between spawns of ore in the T1 ore extractor (if enabled above)
T2_Spawn_Every_X_Seconds (default 65s) - Time between spawns of ore in the T2 ore extractor (if enabled above)
Recycling Veggies - You can put a vegetable (Eggplant, Mushroom, Beans, Squash) into the recycler and get back the seed instead to duplicate seeds.
Asteroid Tweaks - Configurable debris removal rate (multiplier of current rate.) Adds hot key to trigger a random Meteo event. Flag to limit triggered Meteo events to ones that have asteroids.
To use the teleporters just build 2 or more of them. Click on any of the 4 blue balls on the 'arms' and it will bring up a GUI. Enter an address of one of the teleporters and click 'teleport' and off you go.
The energy usage and recipe list are configurable if they're too steep for your playstyle.
Unzip into the BepInEx\plugins folder to install (puts everything into a 'Lathrey-Teleporters' folder)
Warning! The mod is currently bugged with the Lore & Automation update and the author has stated they don't have time for mod fixes.
Reminder: When updating save your RecipesToModifyAndAdd.jsonc and any AssetBundles you added.
v2.2.0 Update - Writes a list of craftable items (name/game ID) to CraftableList.txt in the DataFiles directory.
Export/import item/building configuration information (recipe, icon/model, oxygen/pressure/heat/etc. generation, energy usage, etc.)
Modify any values of existing things in game or add new items/buildings by editing the DataFiles\RecipesToModifyAndAdd.jsonc file (comments inside and some examples).
Add AssetBundle files to the AssetBundles directory to load new models or icons to use with your new items/buildings.
Unzip into the BepInEx\plugins folder to install (puts everything into a 'Lathrey-RecipeExportImport' folder)
Export_Recipe_List = true in config file turns on the exporting. Defaults to false to save game loading time.
Notes:
Replaces Add Craftable Objects plugin (included as item/building additions for AdvancedBackpack, PalmTree, Coconut)
Replace Zeolite/Fabric plugin (included as recipe mod)
Remove previous non-folder versions (but save your RecipesToModifyAndAdd.jsonc file).
Updated to fix new game creation.
Day Night Cycle Tweaks - Configurable length of day, night, and the time it takes to go between them.
v2.4.0 Update: Fixes visible holes in top/bottom of merged 4 pods. Should detect save files prior to 2.3.0 and fix them to remove the old save file changes.
v2.3.0 Update: Should handle interior glass and door 'walls'.
'Merges' multiple pods together so the interior space has no 'pillars' and you can build in the entire interior space.
Spaces don't have to be a square and aren't limited to 2 pods (more will make bigger interior empty spaces.)
Minor graphical artifacts still appear similar to the in-game 4 pod large room. These can be fixed with more time in Blender but they don't currently bother me that much and I'm horrible in Blender. :)
NEWToggle Fog - Hotkey to disable distance fog, jetpack dust, and a couple other particle systems such as sulfur clouds
Configurable hotkey (defaults to Ctrl+F)
NEWFix Beacon - Fixes location of Beacon overlay when your field of view is not the default 60 degrees
aedenthorn[]
Warning (as of January 2024). The author has suspended his modding activity and none of the mods in the list below is expected to receive any update in the foreseeable future.
Auto Mine - Automatically mines nearby nodes on an interval or when pressing a hotkey.
Better Jetpack - Removes the sharp drop when jetpacking off a cliff, and adds a custom speed multiplier to the jetpack.
Better Meteorites - Lets you increase the resource drops from meteorites, and add iridium and uranium to ordinary meteorites and as separate random meteorite events.
Craft From Containers - Pulls items from nearby containers for construction purposes.
Custom Audio - Lets you change audio clips used in game non-destructively.
Custom Flashlight - Provides comprehensive light customization of the multitool flashlight.
Drill Sound - Lets you adjust the volume and pitch of the multitool drill sound.
Quick Rotate - Lets you quickly rotate objects to be built by a custom rotation (default 45, 90, 180) using customizable modifier keys.
Quick Store - Lets you quickly store items in nearby containers that contain at least one of the same item.
Remote Storage Access - Lets you access storage remotely and switch between storage containers using hotkeys.
Show Next Unlockables - Shows the next unlockable goal for each unit type on the progress display monitor.
Warning! Version 0.1.0 of this mod doesn't work with the Insects & Waterfalls (0.5.005+) update and may prevent you from starting a new or loading an existing save.
Spawn Objects - Lets you spawn any amount of any object in the database to the world or your backpack using a GUI with auto-suggest.
Storage Customization - Lets you set custom storage sizes for in-game containers and backpacks.
Zinal[]
Warning (as of January 2024). The functionality of the author's mods are now part of the vanilla game. In addition, no activity from the author for some time now.
Modding API - An attempt to unify common modding functionality. Required by all mods made by Zinal.
Warning! This mod was not updated for some time now and breaks Ore Extractors, possibly more.
MultiBuild - Build multiple objects in a row by holding down the shift-key while building.
Discord Presence - Adds a presence to your discord profile with informations about your current save and where you are (Main Menu, Options, In Game)
Terraformation Details Overlay - Adds a textbox below the Terraformation Index on the top right displaying the current Oxygen, Heat, Pressure and Biomass values
Recycle to Inventory - Transfers Items from the Recycle Process directly into your Inventory.
Creating Mods[]
In general modding involves changing or adding game logic by modifying the source code via a BepInEx 'plugin' and/or adding new models, textures, images, sounds, etc. with an 'AssetBundle'.
Many mod authors have provided the source code for their mods via links to GitHub above.
Creating AssetBundles[]
An AssetBundle is a collection of organized game content packaged into a single file with Unity3D (the game engine used to make Planet Crafter and many other games). In order to make sure the AssetBundle you make is compatible with Planet Crafter you need to use the same version of Unity3D that was used to make Planet Crafter. As of the time of writing this is 2020.3.26f. You can find it in the archives here: https://unity3d.com/get-unity/download/archive. To create an AssetBundle:
Install the right version of Unity3D above
Create a new empty 3D project
Open the Package Manager (Menu Window=>Package Manager)
Switch to view all packages in the Unity Registry by selecting the 'Packages: In Project' drop-down.
Unity3D Package Manager showing selection of all unity registry packages.
Create/add any assets you want to add to the game (see Create Assets below)
Tag those assets with an AssetBundle name (you can make a new one with the 'New...' option) - Make sure to tag at least any prefabs used for in-game objects and any icons used for those objects. Only tagged items (not auto-added items) will show up in mods like Recipe Export Import. Make sure to give prefabs and icons unique names to find them later.
Tag assets with an AssetBundle name.
Open the Asset Bundle Browser (Menu Window=>AssetBundle Browser)
Check what will be included in the bundle by expanding the bundle names on the left hand side.
View planned AssetBundle contents.
Select the 'Build' tab.
Use the 'Browse' button to choose where you want to store the AssetBundle (for example the plugin folder if you want to use it immediately.)
Select the 'Build' button and wait for the bundle to be created.
Building an AssetBundle.
Creating Assets[]
Note: This section currently assumes you know the basics of using Unity3D such as creating GameObjects and attaching components to them in the Scene Hierarchy.
There are a lot of details to creating assets and in general you can follow existing Unity3D tutorials as well as tutorials for your tools of choice for editing models, textures, sounds, etc. This section is just to cover how to structure content so that it works with Planet Crafter in a somewhat smooth fashion. For some of this to work you will need to have some of the game files added to your Unity3D project.
Extract it somewhere and run it by double-clicking on AssetRipper.exe
Load the game data files (Menu File=>Open Folder - choose C:\Program Files (x86)\Steam\steamapps\common\The Planet Crafter Prologue\Planet Crafter_Data)
Extract the data to a new Unity3D project (Menu Export=>Export all Files - pick a new empty folder)
Create a folder in your AssetBundle Unity3D project for all the files you need to copy below
Copy from the exported project the entire Assets/ScriptableObject folder
Copy from the exported project the entire Assets/Scripts/Assembly-CSharp folder
Copy from the exported project the entire Assets/Scripts/GameOptions folder
Copy from the game data folder (C:\Program Files (x86)\Steam\steamapps\common\The Planet Crafter Prologue\Planet Crafter_Data) the following DLL files:
Assembly-CSharp.dll
Assembly-CSharp-firstpass.dll
Beautify.Universal.Runtime.dll
GameOptions.dll
HSVPicker.dll
SimpleSQL_Runtime.dll
Now you will be able to attach scripts from the game by expanding the 'Assembly-CSharp' DLL and dragging scripts to GameObjects as new components.
Creating An Item[]
In general, items in the game show up in your inventory, your equipment, or are on the ground and can be picked up instantly by clicking on them (no 'mining' required.) Items are used as ingredients in recipes, equipment upgrades like backpacks or oxygen canisters, consumables like food, etc.
To create an item:
Make an empty 'root' GameObject and name it the name of your item
Add GameObject children under this object with all of the models that are part of your item
Attach a collider (usually capsule) to the 'root' GameObject that represents the physical boundary of the object (so it doesn't go through the terrain for example)
Attach the following scripts from Assembly-CSharp:
WorldObjectAssociated
ActionGrabable (decide if you want the name shown on hover via the checkbox)
Drag the 'root' GameObject to the project folder are to make a Prefab
An example of an item prefab with attached scripts in the inspector.
Select the Prefab and choose the associated AssetBundle in the Inspector
(No longer needed with Recipe Export Import) Create a new GroupDataItem (right click the project area Create=>Planet Crafter=>GroupDataItem)
(No longer needed with Recipe Export Import - set these values in the data file) Set the GroupDataItem properties
Id - The name of the item (technically this is used to lookup the name in the localization file)
Associated Game Object - Drag your prefab here
Icon - Import a 2D image for your item into Unity, set as a Sprite, drag it here
Recipe Ingredients - A list of GroupDataItems used to craft this item if it's craftable. You can select from items in the game here in the ScriptableObject directory from above.
Unlocking World Unit - What type of terraformation unit is used to enable this item if any. Setting to 'null' seems to break things after the update to 011 so choose 'Terraformation' if you want it always available.
Unlocking Value - When to unlock this based on the type of unit above. Note this is in the earliest unit type. So ppq for Oxygen, pK for heat, nPa for pressure, Ti, etc.
Terraform Stage Unlock - Unlock based on a named terraform stage instead of a world unit value
Inventory Size - How many slots of inventory this item has if it has inventory. Not sure if this is used?
Value - Depends on what this is. For eatable it's how much health. For backpacks its the number of slots, etc.
Craftable In List - A list of crafting stations that have this item in them. Note T1 is the station in the starting pod
Equipable Type - What kind of equipable it is (backpack, oxygen, jetpack, etc.)
Usuable Type - For consumables (eat, drink, breathe)
Item Category - Used for equipment (equipable), seeds
Growable Group - Not sure but believe this is for seeds that have an associated item for when they are grown (mushroom seed => mushroom)
Associated Groups - Not sure
Assign Random Group At Spawn - Not sure, leave false?
Replace By Random Group At Spawn - Not sure, leave false?
Multipliers (one for each type) and they are used for things like rockets and seeds that give a bonus.
An example of an item's associated GroupDataItem in the inspector.
(No longer needed with Recipe Export Import) Choose the associated AssetBundle in the Inspector
Creating A Building[]
Anything that can be created with the build menu (Q) is called a 'constructible'. There is more detail here depending on what you want the building to do. Machine Generators spawn objects at a certain rate, containers have an inventory and can be opened, etc. Over time this section might need to expand to cover what to do for different types of building. For now this covers a machine like the water collector or the ore extractor which creates items over time in an internal inventory the player can access.
To create a building (that makes items):
Make an empty 'root' GameObject and name it the name of your building
Add GameObject children under this object with all of the models that are part of your item
Attach a collider (usually capsule) to the 'root' GameObject that represents the physical boundary of the object (so it doesn't go through the terrain for example)
Attach the following scripts from Assembly-CSharp:
ConstraintOnSurfaces (Add what surfaces you can place your object on. Foundations are 'grid'.)
ConstraintNotColliding (Normally collide with minables and water)
ActionOpenable and InventoryAssociated (If it has an inventory the player can access)
WorldObjectAssociated
MachineGenerator (If it makes objects. If so specify the time between in seconds and the list of objects it can choose from.)
RequireEnergy (Required if you are a MachineGenerator or otherwise need energy to work. Default distance is 30 and turns off expensive rendering if the player is far away (lights, particles, etc.))
An example of a building prefab main game object with attached scripts in the inspector.
Add a GameObject child. On the child:
Add a collider with 'Is Trigger' set to true (I think this is to prevent other buildings from being built near this one)
Add a HomemadeTag script set to 'Constructible Collision Detector'
An example of a building deconstruction trigger game object with attached scripts in the inspector.
Add a GameObject child. On the child:
Add a collider with 'Is Trigger' set to true (I think this is for detecting where you can click to destroy the object)
Add a ActionDeconstructible script and set the root object to your root GameObject in step 1
An example of a building construction collider trigger game object with attached scripts in the inspector.
Drag the 'root' GameObject to the project folder are to make a Prefab
Select the Prefab and choose the associated AssetBundle in the Inspector
(No longer needed with Recipe Export Import) Create a new GroupDataConstructible (right click the project area Create=>Planet Crafter=>GroupDataConstructible)
(No longer needed with Recipe Export Import - set these values in the data file)Set the GroupDataConstructible properties
Id - The name of the building (technically this is used to lookup the name in the localization file)
Associated Game Object - Drag your prefab here
Icon - Import a 2D image for your building into Unity, set as a Sprite, drag it here
Recipe Ingredients - A list of GroupDataItems used to build this item. You can select from items in the game here in the ScriptableObject directory from above.
Unlocking World Unit - What type of terraformation unit is used to enable this building if any. Setting to 'null' seems to break things after the update to 011 so choose 'Terraformation' if you want it always available.
Unlocking Value - When to unlock this based on the type of unit above. Note this is in the earliest unit type. So ppq for Oxygen, pK for heat, nPa for pressure, Ti, etc.
Terraform Stage Unlock - Unlock based on a named terraform stage instead of a world unit value
Inventory Size - How many slots of inventory this item has if it has inventory.
Generation per second (one for each type) - negative to consume (like energy) and in the base units like above (ppq, nPa, etc.)
Rotation fixed - I assume prevents you rotating it when building
Group category - where to show in the build menu
World Unit Multiplied - Not sure.
An example of a building's associated GroupDataConstructible in the inspector.
