https://github.com/olsonpm/starbound_lua-hooks
https://github.com/olsonpm/starbound_lua-hooks
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/olsonpm/starbound_lua-hooks
- Owner: olsonpm
- License: other
- Created: 2018-01-16T02:59:13.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-01-21T23:35:34.000Z (over 8 years ago)
- Last Synced: 2025-01-20T23:45:40.179Z (over 1 year ago)
- Language: Lua
- Size: 8.79 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
## Starbound - Lua Hooks
#### Table of Contents
- [What is it?](#what-is-it)
- [Why create it?](#why-create-it)
- [How to install it?](#how-to-install-it)
### What is it?
This mod enables dependent mods to run code inside vanilla starbound files
without modifying the file themselves.
### Why create it?
To have a reliable way for all mods to run code in the context of vanilla files
which can't be wrapped via json patches.
*Initially I created this to modify player_primary.lua - however bk3k pointed*
*out this method may break compatibility with existing mods which wrap vanilla*
*files via json patches. Not all vanilla files can be wrapped via json*
*patches so this library is still relevant, however I don't currently have a*
*need to modify any vanilla behavior besides player_primary.lua so I removed*
*the vanilla hooks. I also removed the examples previously listed in the*
*readme because they're not very useful without existing code to reference.*
### How to install it
[Like this](https://github.com/olsonpm/starbound_health-monitor/blob/master/docs/how-to-install.md)