Crawlspace 2 Modding Wiki

Appearance

Modding APIs Overview ​

As the Crawlspace 2 modding community grows, developers may create reusable libraries and APIs to make modding easier. This page will serve as a reference for available modding APIs.

Types of APIs ​

There are two main types of modding APIs:

  • Asset API: Tools that allow content creation without writing code. Good for non-programmers who want to add custom assets.
  • Programming API: C# libraries that can be integrated into your Crawlspace 2 mod to simplify common tasks.

Creating Your Own API ​

If you're developing a reusable library for Crawlspace 2 modding, consider:

  • Making it open source
  • Providing clear documentation
  • Publishing to Thunderstore for easy distribution
  • Following BepInEx plugin best practices

Common API Categories ​

As the modding community develops, APIs may emerge for:

Asset Management ​

  • Custom model loading
  • Texture replacement
  • Audio replacement
  • Asset bundle utilities

Networking ​

  • Multiplayer synchronization helpers
  • Network message utilities
  • State synchronization

Configuration ​

  • Config file management
  • Host-client config syncing
  • In-game configuration menus

Game Integration ​

  • Enemy AI helpers
  • Player interaction utilities
  • Scene management
  • VR interaction helpers

Contributing to This Wiki ​

If you've created a modding API for Crawlspace 2 and want it listed here, you can contribute to this wiki. APIs should be:

  • Open source
  • Well documented
  • Actively maintained
  • Useful to the broader modding community

For now, this section will grow as the Crawlspace 2 modding community develops more tools and libraries.