/SiscosHooks

A library for hooking into events within the SlimeRancher game.

Primary LanguageC#

SiscosHooks

Please note
If you make a plugin that relies on this mod then the Players will need to also install this mod for your plugin to work!

Additionally plugin creators do not need any of the code from this library, they only need to add the .dll file as an assembly reference.
For more information on how to do this read our wiki.

What?

This is a library for hooking into events within the SlimeRancher game.
More specifically this mod intercepts certain events and functions in SlimeRancher and then allows plugins to register callbacks for those events, even going so far as allowing plugins to alter any of the event functions parameters or return values!

  • Alter weapon behaviour
  • Change plort prices
  • Alter entity spawning logic.
  • (Soon) Add custom upgrades
  • And much more!
Read the WIKI for more information.

Installing

The library comes with an installer which will inject it into your game much like a plugin loader would.
To download the installer click HERE.
If you need more information about installing visit the wiki.

Developers

Visit the wiki for a guide on how to use this library!
I also made a plugin loader (https://github.com/dsisco11/SR_Plugin_Loader) that includes a guide on creating plugins for SlimeRancher!

License

SiscosHooks is released under the Apache 2.0 license

Donate

If you would like to help support me then you can Donate!

Help & Support

If you need help with anything dont be afraid to create an issue report!

FAQ

"An event I need isn't implemented yet!"

File an issue on this project github page and I'll see what I can do about it.