Eclipse Modding

Create equipment, perks, battles, and other content for Eclipse using Lua and namespaced assets. Add custom behavior through the API’s supported callbacks.

Start with a working weapon mod, then explore the systems you need.

Your first weaponSet up a manifest, register a weapon, and find it in the shop.

Understand the APILearn namespaces, typed handles, capabilities, and when your code runs.

Combat callbacksReact to rounds and hits with reusable Lua behavior.

Working examplesLearn from complete equipment, combat, and progression mods.

Choose your next step

• New to coding? Read Lua basics, then create your first weapon using complete copyable files.
• Adding content? Browse the Content reference for equipment, shop listings, fights, quests, and presentation.
• Adding gameplay logic? Start with reusable behaviors, then choose the callback that matches your event.
• Looking for one function? Use the alphabetical function index or the search box.
• Something failed? Read troubleshooting and fix the first error before testing again.

How to read the reference

Every public function and combat callback has its own section. Signature shows how to call it, Requires lists permissions and dependencies, When explains the valid time to call it, and Returns explains the result. Field tables mark required inputs, defaults, and limits. Reference snippets may use handles defined earlier on the page; the beginner tutorial supplies complete files.

This wiki documents the implemented Eclipse API. It covers supported behavior and clearly labels current limits.