ReelAPI
A Misc API for WEBFISHING.
About this mod Author’s original text
A Misc API for WEBFISHING.
Right now, ReelAPI only allows for registering UIs, so making custom UIs is easier.
This API will have more stuff later on.
How to install
- Install the repository, and put Kikin.ReelAPI into your mods folder in Godot.
- Autoload it - Select Kikin.ReelAPI/main.gd and set the name as "KikinReelAPI"
- done:3
UI
For registering custom UIs, you need to firstly get ReelAPI in your script.
var ReelAPI
func _ready():
ReelAPI = get_node_or_null("/root/KikinReelAPI")
Now lets actually register the UI.
var ReelAPI
func _ready():
ReelAPI = get_node_or_null("/root/KikinReelAPI")
ReelAPI.register_window({
"window_id": "example_window", # Every UI needs to have an ID to represent itself.
"window_scene": preload("res://mods/Kikin.ReelAPI/Scenes/ExampleWindow.tscn"), # The scene of the UI.
"keybind": KEY_END, # The keybind that will be used to open the UI.
"mod_id": "ReelAPI", # This is just for debugging purposes, but i recommend settings this to your Mod ID
"silent_print": false, # If you don't want ReelAPI to yap about some debug stuff, set this to True.
"animation_start": "start" # In your UI you --> need <-- to have an AnimationPlayer. Set this to the animation name you want to play at start, if you don't want to play anything then create an empty animation.
})
Install & use Install: follow the bundled instructions
- Unzip the archive from playbuff and read the bundled readme / instructions first.
- Most mods rely on the game's mod loader — the usual route is a community mod manager (such as r2modman): pick this game, install, and it handles the loader and dependencies.
- For a manual install, put the mod files into the matching Mod / plugins folder inside the game directory.
- Launch the game to confirm it loaded; mods with listed dependencies need those installed as well.
Install locations vary a lot between mods — the bundled readme is the most reliable guide. Most WEBFISHING mods need the GDWeave loader; the bundled readme explains where files go.
Install these first, or the mod will not work: