CircusStudios-ContentAPI icon

ContentAPI

A library of tools to help developers.

Last updated 18 hours ago
Total downloads 228
Total rating 1 
Categories Mods Tools Libraries Client-Only Host-Only Vanilla Compatible BepInEx
Dependency string CircusStudios-ContentAPI-0.0.4
Dependants 0 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2100 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2100

README

ContentAPI

Join our Discord for support.

Welcome to ContentAPI, a powerful extension designed to streamline modding by providing enhanced access to game components such as players, shops, and more. With built-in events and utility features, it simplifies game patching and improves the overall modding experience.

Installation

To install ContentAPI, follow these steps:

  1. Download the latest DLL.
  2. Place the downloaded file inside the BepInEx\plugins directory.

For Developers

To integrate ContentAPI into your project:

  1. Go to nuget and search for ContentAPI
  2. Add the nuget package to your project as a reference.
  3. Ensure it is also placed in the BepInEx\plugins directory.

In your code, set up the dependency as follows:

[BepInDependency(ContentPlugin.ContentGUID)] // Specify whether this is a hard or soft dependency. Note: BepInEx defaults to hard dependencies.
public class YourMod : BaseUnityPlugin 
{
    // Implement your mod logic.
}

Contributing

We welcome contributions! If you'd like to help improve ContentAPI, submit a Pull Request with your changes.


Reporting Issues

Encountered a bug or issue? Please let us know through one of the following:

  1. Use the GitHub Issues page.
    • Include a copy of the error message, a brief description of the issue, and any relevant context or expected behavior.
  2. Join our Discord for quick support from the community and developers.

Dependencies

This plugin requires BepInEx to function.