Create your own maps and campaigns for KeeperFX and DK1 with Unearth.

You can find it here.

KfxApiTool

Submitted by Yani
Category Application
Rating 5 / 5 4 ratings
Submission date 2024-06-14
Last updated 2024-06-27
Min. game version Latest KeeperFX alpha patch
Filesize 8.96MiB
Downloads 33
This workshop item uses unreleased KeeperFX functionality and requires the latest alpha patch to work correctly.
File Filesize Downloads Date
KfxApiTool-v1.1.0.7z 8.96MiB 15 2024-06-27
KfxApiTool-v1.0.0.7z 8.79MiB 18 2024-06-14
Description

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:

  1. Set API_ENABLED to TRUE in your keeperfx.cfg
  2. Take note of API_PORT, it's best to leave it at 5599 but you can change it if you want
  3. Start a KeeperFX map
  4. Use KfxApiTool and connect to the API You can use 'Connect to 127.0.0.1:5599' if you did not change the port.
  5. 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)**

Comments

Login or register to comment on this workshop item.

^This tool is super useful.

Yani 🇧🇪 Submitter Admin

Thank you. You use it?

Yes! It saves a lot of hassles. 😎

Yani 🇧🇪 Submitter Admin

Updates

Yani 🇧🇪 Submitter Admin

v1.1.0:

  • Implement application update check (and easier versioning)
  • Add 'Unsubscribe' menu action when right clicking on a subbed variable
  • Add clear all menu options for vars/events/commands
  • Add button to open KeeperFX.net workshop page of this tool
  • Fix About dialog hiding behind the main window
Yani 🇧🇪 Submitter Admin

v1.0.0:

  • 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

Very cool! ✅