Skip to content

Introduction

MarC0 edited this page Feb 14, 2019 · 3 revisions

KKAPI (also referred to as "the API") is split into multiple parts based on what each part controls.

  • KoikatuAPI provides overall information about the game and the API itself, and gives some useful tools like synchronization of threads or checking if required plugins are installed.
  • MakerAPI provides a way to add custom items to the in-game Character Maker, and gives useful methods for interfacing with the maker.
  • StudioAPI provides a way to add custom menu items to CharaStudio, and gives useful methods for interfacing with the studio.
  • CharacterApi provides an easy way to add custom logic to all characters in the game and in studio. It takes care of all the error-prone plumbing and lets you easily save and load data to the character cards. It's used by many mods to great effect, for example by the Koikatu Overlay Mods and KK_BecomeTrap.

Most mods make use of at least CharacterApi for implementing their logic, and MakerAPI for giving the user a way to configure them.

To learn how to use the API in your own plugin check the next page.

Clone this wiki locally