Package Description

This is a module which integrates Kanka.io, a free worldbuilding and tabletop RPG campaign management tool, with Foundry Virtual Tabletop, allowing you to import entries written in Kanka as journal entries into Foundry VTT. this module imports Kanka entries including their main entry text, their main image and some metadata, which will be included as a table above the main entry text.

Screenshot of a journal entry after importing it from Kanka.

This module is based loosely on the Forundry Virtual Tabletop - World Anvil Integration module.

Installation

This module can be installed from the Foundry Virtual Tabletop module browser, or by using the following module manifest url: https://github.com/eXaminator/kanka-foundry/releases/latest/download/module.json.

Configuration

This module provides many configuration options to handle authentication to Kanka as well as what to import.

Screenshot of the settings view.

Additionally, the settings provide a list of all supported Kanka entry types to allow you to deselect certain types hand have the module hide those in the import view. Deselecting types has two advantages:

  1. It reduces the amount of lists you have visible, especially if you don't use certain modules in Kanka itself.
  2. It reduces the amount of API requests this module has to send to Kanka. Please see below for more information on API limitations for the amount of requests.

Usage

After installing and configuring the module, you will find a button with the Kanka icon next to the buttons to create new journal entries.

Screenshot of the kanka button in the Foundry VTT user interface.

Clicking this button will open an overview of all your Kanka entries based on their category. The exact entries that show up here depends on what you have selected in the settings of this module. Each entry has a button to link the entry. This will create a journal folder and import that entry into that folder. After linking an entry you will now see a button with the entries name instead. Clicking that button will open the linked journal entry. You will also find a button to refresh the journal entry, which will start a new import of this entry.

Warning: You can change journal entries after you have imported them as much as you like. But keep in mind that refreshing an entry will overwrite any changes you have made to that journal entries text field or image.

Next to each category you will also find buttons to link all entries in a category that have not been linked before or to refresh all entries that have already been linked. Please beware API request limits, see below.

Screenshot of the kanka browser from which entries can be imported.

API limitations

The Kanka API enforces certain rate limits. For most users this means that you cannot make more than 30 requests per minute. Kanka subscribers have a higher limit of 90 requests per minute (which is currently not supported by this module, but it will be soon!). I have tried to limit the number of requests as best as possible, but there is always room for improvement, and some entries simply require more requests than others. This module monitors the amount of requests it is making against the Kanka API and will simply wait if the limit was reached. This can sometimes create wait times, especially when linking or refreshing many entries at once.



Tagged Categories

  1. Content Importers
  2. Journals and Notes
  3. External Integrations

Available Versions

  1. Version 1.1.1

  2. Version 1.2.0

  3. Version 1.3.0

  4. Version 1.4.0

  5. Version 1.4.1

  6. Version 1.5.0

  7. Version 1.5.1

  8. Version 1.5.2

  9. Version 1.5.3

  10. Version 1.6.0

  11. Version 1.6.1

  12. Version 1.6.2

  13. Version 1.7.0

  14. Version 1.8.0

  15. Version 1.8.1

  16. Version 1.9.0

  17. Version 1.9.1

  18. Version 1.9.2

  19. Version 1.9.3

  20. Version 1.9.4

  21. Version 1.9.5

  22. Version 1.9.6

  23. Version 1.9.7