Code Monkey home page Code Monkey logo

piplib's Introduction

Piplib

Powerful Modding Library for Klei's Oxygen Not Included

License PipLib Version Pipeline


Features

PipLib, on its own, does not do much to change up the game (there are some though, see below), but it provides a powerful foundation for mods to add new and exciting things to Oxygen Not Included.

  • Streamlined Mod Loading
    • Have your mod loaded by the library, not the other way around
    • Simply mod class to implement rather than having to register your mod with anything
  • Custom Elements
    • Create new elements and substances within the game with ease
  • Overhauled Research Tree
    • New dynamic research tree that is built on-the-fly instead of hard-coded in the assets
    • Ability to add new custom techs for your new stuff!
  • Utilities for Buildings and Tags
    • Utility methods for buildings, such as adding to plan screens and techs.
    • Ability to easily augment tags, both custom and vanilla.

Changes to the Game

PipLib does make some minor changes to the game to facilitate new things.

  • The vanilla research tree has been reorganized: This is a result of the tree now being dynamic
  • Element files are .yml not .yaml: To avoid a bug with the vanilla YAML loader, a different extension is used

Usage

To learn how to create mods using PipLib, you can either read through the documentation located on each method or view some examples over on my other mods. Many of these mods are excellent examples of how to use PipLib and different aspects of it.

Steam versions are unlisted but are available on the workshop here. You can find both non-Steam mod versions as well as the release DLL/XML on our Lab.

Do not pack PipLib with your mod: this will break things!. Instead, upload your mod by itself to the workshop, then use the Add/Remove Required Items option when editing the item.

Contributing

Please bear in mind when contributing: this project was designed to work in Visual Studio Code >=1.38 (with OmniSharp), not Visual Studio. Attempting to build or edit this project in VS will fail and any PRs will be rejected.

If you have a suggestion, feel free to submit an issue, fork, or contact me on Discord (see below). Contribution guidelines will appear when submitting an issue.


Designed and Developed by @CynicalBusiness.
Reach me on Discord at CynicalBusiness#0001 or the Oxygen Not Included Discord Server.

Myra ta Hayzel; Pal, Kifitae te Entra en na Loka

piplib's People

Contributors

cynicalbusiness avatar

Stargazers

Nikolay Epifanov avatar Pierre Haufe avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.