Void Crew Modding Documentation

Welcome to the official documentation for Void Crew Modding!

Use the table of contents on the left or the search function to learn about more specific modding topics.

The site covers documentation for how to create mods for Void Crew and how to use:

• The Void Crew Common Library: Public library used by Void Crew that mods can utilize for increased capabilities.

• The Void Crew Samples Project: Public sample Unity project which includes the common library, and features examples and helpers to get you started making Void Crew assets.

Disclaimer: much of the documentation is still WIP.

Follow the guides below in order to get started and progress through the full modding workflow.

Documentation Topics

• Getting Started
  Introduction and initial setup required before creating mods.

• Creating Asset Bundles
  Introduction on how to create asset bundles for Void Crew, including:

  • Carryable Weapon Mods and Relics

  • Custom Cosmetics

  • Custom Ship Visuals

• Asset Mods
  Introduction on how to make mods without custom code, using only asset bundles.

• Compiling Mods
  Introduction on how to compile your own mods, which can include your own custom scripts.

• Code Injection with Harmony Patching
  Introduction on how to inject code into Void Crew using Harmony.

• Testing Mods Locally
  Steps for testing your mods locally before publishing.

• Uploading Mods
  How to upload and share your mods.

• Stat Modifiers
  Documentation on Void Crew Stat Modifiers (StatMod).

• Dynamic Modifiers
  Documentation on how dynamic stat modifiers work in Void Crew.

• Tags
  Documentation on Void Crew’s tag system.

License and Contribution

The documentation is licensed under our Void Crew Modding Documentation License.
This allows anyone to contribute and improve the documentation!
Contribution can be done via the GitHub repository where the documentation is hosted.