KfxApiTool is a simple client that interacts with the new KeeperFX API. It allows you to easily monitor in-game variables and change them on the fly as well as allowing you to execute almost any map command instantly.
This tool is made to help support mapmakers that work with a lot of different flags and timers.
Features
- Set variables
- Subscribe to variables (live read)
- Subscribe to events (pretty useless atm)
- Load variables from a mapfile
- Execute map commands
- Execute console commands
- Auto reconnect (just leave it on and when you restart the game it will automatically connect again)
- Create and load presets of subscribed variables and commands
- Tool update checker
Upcoming features
- Read map data
- Simple Spawn system that generates commands
- Execute command (without adding it to the GUI)
Usage:
- Set
API_ENABLED
toTRUE
in your keeperfx.cfg - Take note of
API_PORT
, it's best to leave it at 5599 but you can change it if you want - Start a KeeperFX map
- Use KfxApiTool and connect to the API You can use 'Connect to 127.0.0.1:5599' if you did not change the port.
- Now you can monitor variables, change them and run commands
Notes:
- It's possible the app crashes when you close it. You shouldn't need to worry about it.
- Requires at least Alpha patch 3990 (or KFX version 1.2 or higher)**
Genuinely super useful if you get into advanced mapping. Makes testing for flags so much easier. Previously you'd need to use the console commands and cheat menus, which are comparatively limited.
^This tool is super useful.
Thank you. You use it?
Yes! It saves a lot of hassles. 😎
Updates
v1.1.0:
v1.0.0:
Very cool! ✅