CommonAPI-CommonAPI icon

CommonAPI

A modding library for Dyson Sphere Program. Currently is under development.

Last updated 3 weeks ago
Total downloads 47946
Total rating 4 
Categories Libraries
Dependency string CommonAPI-CommonAPI-1.5.1
Dependants 26 other mods depend on this mod

This mod requires the following mods to function

xiaoye97-BepInEx-5.4.17 icon
xiaoye97-BepInEx

BepInEx5.4.17 mod plugin framework, Mod框架

Preferred version: 5.4.17
xiaoye97-LDBTool-2.0.5 icon
xiaoye97-LDBTool

Library that allows mods to add and edit Proto data. Also allows you to see Proto data, config ID's of mod Protos and change localized strings

Preferred version: 2.0.5
CommonAPI-DSPModSave-1.1.4 icon
CommonAPI-DSPModSave

Library that allows to store mod save data separately from vanilla saves

Preferred version: 1.1.4

README

CommonAPI

A modding library for Dyson Sphere Program. Provides multiple features to make adding custom content to DSP easier.

List of features

  • Easily register new items, recipes and more using ProtoRegistry system
  • Create new buildings with custom behavior and custom UI using ComponentSystem
  • Register new recipe types. This allows to create new machine types without writing almost any code.
  • Register and use custom tabs.
  • Register new KeyBinds that players can rebind
  • Easily create new systems that exist in each Planet or Star. An example of such system is ComponentSystem
  • Picker Extension tool allows to extend behavior of Item and Recipe pickers. For example use any filter defined by a function.
  • Support translation for at least for English, Chinese and Franch by using String Protos

Full list of modules and other utilities can be found here. More will come in the future. If want write your own module and add it to the list you can open a Pull Request. Contrubitions are welcome.

Installation

With Mod Manager

Simply open the mod manager (if you don't have it install it here), select CommonAPI by CommonAPI, then Download.

If prompted to download with dependencies, select Yes. Then just click Start modded, and the game will run with the mod installed.

Manually

Install BepInEx from here
Install LDBTool from here
Install DSPModSave from here

Unzip folder patchers into Dyson Sphere Program/BepInEx/patchers/CommonAPI/ (Create folder named CommonAPI)
Unzip folder plugins into Dyson Sphere Program/BepInEx/plugins/CommonAPI/. (Create folder named CommonAPI)

Feedback and Bug Report

Feel free to contact me via Discord (Kremnev8#3756) for any feedback, bug-reports or suggestions.

How develop mods using CommonAPI

All features are written as self-contained modules (Inspired by R2API). By default NO modules are loaded. To use a module at the top of your BepInEx plugin class add an attribute CommonAPISubmoduleDependency. That will ensure that specified modules are loaded. Make sure you don't ask to load modules that you are not using.

How to setup development environment

  1. Download and install CommonAPI and its dependencies
  2. Create development environment. You can find how to do that here
  3. Add LDBTool, DSPModSave and CommonAPI assemblies to your references. You can use NuGet to get them. You can find them by typing DysonSphereProgram.Modding into nuget package search.
  4. You also likely will need a Unity Project. You can find instructions on setting that up here

Usage Example

[BepInPlugin(GUID, NAME, VERSION)]

[BepInDependency(CommonAPIPlugin.GUID)]
[CommonAPISubmoduleDependency(nameof(ProtoRegistry), nameof(CustomDescSystem))]
public class MyPlugin : BaseUnityPlugin
{
    public const string MODID = "myplugin";
    public const string GUID = "org.myname.plugin." + MODID;
    public const string NAME = "My Plugin";
    
    void Awake()
    {
        //Make use of modules here
    }
}

This library is still under development.

Changelog

v1.5.1

  • Testing release, no changes

v1.5.0

  • Updated to work with game version 0.9.25.11985 or higher

v1.4.9

  • @Raptor: Prevent creation of delegates every tick using alternate logic for Pool, which should improve performance of Various Facility.

v1.4.8

  • Add checks to container export. Any mod issues should be logged and contained.
  • Fix Registry exporting data of empty items

v1.4.7

  • Add public method to make other mods compatibility easier. Internal refactor.

v1.4.6

  • Fix dynamic KeyBind ID assignment and migration being broken. Playes might lose some of previously rebound keybinds.

v1.4.5

  • Fix issues adding multiple techologies with the same pretech
  • KeyBinds now dynamically assign ID's. To all modders using Custom KeyBinds: please stop assigning ID's when calling RegisterKeyBind()
  • FactoryComponent now has a method UpdateNeeds() that allows to set entityNeeds.

v1.4.4

  • Add extension methods for customId and customType fields on EntityData class

v1.4.3

  • Fixed GetTabId being impossible to call
  • Improved appearance of mod created tabs

v1.4.2

  • Fix NRE in UISingalTip

v1.4.1

  • Added UIWindowResize class, made by Raptor
  • Added ability to specify iconPath and name for recipes manually

v1.4.0

  • Fix lava ocean type being displayed as missing item
  • Allow submodules have dependencies
  • Add AssemblerRecipeSystem
  • Refactor PickerExtensionSystem
  • Allow adding Signal Proto using ProtoRegistry

v1.3.4

  • Fix missing items appearing instead of no item id 0

v1.3.3

  • Fix missing items being broken. Also make it possible to delete them

v1.3.2

  • Change StartModLoad function behavior

v1.3.1

  • Now Machines added by mods will be automatically removed from save game if mod is uninstalled.
  • Corrected Game version CommonAPI is built for.

v1.3.0

  • Add ability to register Audio using ProtoRegistry
  • Updated LDBTool to 2.0.1. Please make sure you are using 2.0.0 or higher.

v1.2.2

  • Added plugin catergories on Thunderstore page.

v1.2.1

  • Added ability to load modules manually. Useful for testing with ScriptEngine.

v1.2.0

  • Migrated to CommonAPI-DSPModSave package.

v1.1.0

  • Renamed CustomPlanetSystem to PlanetExtensionSystem
  • Renamed CustomStarSystem to StarExtensionSystem
  • Add show locked item and recipes feature to PickerExtensionModule
  • Improved Icon Generator

v1.0.1

  • Fix issues selecting recipes in Assembler UI

v1.0.0

  • Initial Release

Available versions

Please note that the install buttons only work if you have compatible client software installed, such as the Thunderstore Mod Manager. Otherwise use the zip download links instead.

Upload date Version number Downloads Download link  
2022-5-1 1.5.1 5396 Version 1.5.1 Install
2022-4-22 1.5.0 3197 Version 1.5.0 Install
2022-4-4 1.4.9 4088 Version 1.4.9 Install
2022-3-20 1.4.8 3597 Version 1.4.8 Install
2022-3-19 1.4.7 938 Version 1.4.7 Install
2022-3-16 1.4.6 1138 Version 1.4.6 Install
2022-3-14 1.4.5 932 Version 1.4.5 Install
2022-3-7 1.4.4 2179 Version 1.4.4 Install
2022-2-15 1.4.3 5125 Version 1.4.3 Install
2022-2-14 1.4.2 782 Version 1.4.2 Install
2022-2-13 1.4.1 426 Version 1.4.1 Install
2022-1-26 1.4.0 4535 Version 1.4.0 Install
2022-1-24 1.3.4 1456 Version 1.3.4 Install
2022-1-24 1.3.3 88 Version 1.3.3 Install
2022-1-24 1.3.2 496 Version 1.3.2 Install
2022-1-24 1.3.1 155 Version 1.3.1 Install
2022-1-20 1.3.0 2462 Version 1.3.0 Install
2022-1-2 1.2.2 3579 Version 1.2.2 Install
2021-12-7 1.2.1 3392 Version 1.2.1 Install
2021-11-29 1.2.0 1553 Version 1.2.0 Install
2021-11-26 1.1.0 904 Version 1.1.0 Install
2021-11-19 1.0.1 1364 Version 1.0.1 Install
2021-11-19 1.0.0 164 Version 1.0.0 Install