Giter VIP home page Giter VIP logo

kfxapitool's Introduction

KfxApiTool

A client to interact with the KeeperFX API. It is mostly useful during mapmaking. You can subscribe to variables and monitor them in real time. You can also add preset commands to interact with the game.

It is crossplatform and made using Qt6 C++.

Screenshot

image

Features

  • Set variables
  • Subscribe to variables (live read)
  • Subscribe to events (pretty useless atm)
  • Execute map commands
  • Execute console commands
  • Auto reconnect (just leave it on and you can keep using the same vars/commands while working on a map)

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. Connect to the API with KfxApiTool. 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

Todo

  • Read map data
  • Save var/command presets (Ex: have a preset for each map)

Author's note

This is my first test trying out the Qt framework. That's why it's quite messy. If this tool takes off I'll probably refactor it.

kfxapitool's People

Contributors

yani avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.