External tools and scripts for Kanka

External tools

  • Kanka Archive Explorer (KAREX) by Jonathan Garrison: A Python3 script that scans a campaign export Zip file to produce a human-readable HTML file.

  • Kanka Attribute Templates Designer by MaxJohnson: A rough and messy local workspace to approximate Kanka's layout and css capabilities for attribute template development. Uses JavaScript to replace some of the Blade logic with placeholder text to assist in developing and testing your template’s layout locally.

  • Kanka Ruler Calculation by BrandonEchols & The Quacken: Figure out what value to input for the map measurement setting based on your image's dimensions and desired metric.

  • Tag the Untagged by Kelaos: An API-based utility that adds a specified tag to all of your untagged entities so you can track them down more easily.

  • Kanka-Wordcount by Kuskus: A Typescript utility that computes the word count of your campaigns, supporting various options and filters. Installed and run locally via NPM.

Discord Integrations

  • kanka-discord by Fallayn: A bridge that automatically posts Kanka changes to a Discord channel.

  • kanka-view by Arconyx: A Red-DiscordBot cog that allows you to access your Kanka campaigns from Discord.

User scripts

The links that follow will take you to various Tampermonkey scripts designed specifically for Kanka. Those scripts are extensions that can be installed in your browser to give you additional features without affecting the actual website for other users.

Automatic Table of Contents

Automatically adds a Table of Contents block under the Pins sidebar of any entity on Kanka, with clickable links to each heading and optional "back to top" links. It integrates seamlessly with any official theme and can be customized further using campaign CSS.

View script and screenshots

Custom Coloris Palette

Modifies Coloris color pickers in Kanka to suggest the user’s choice of preset colors. This applies to forms such as Events, Relations and Map Markers, as well as the Theme Builder.

View script and screenshots

Custom Keyboard Shortcuts for Summernote

A customizable script to help you replace the key bindings for Summernote’s keyboard shortcuts.

View script

Entity Privacy Setting on the Entry Tab

Makes the entity Privacy checkbox visible on both the Entry and Permissions tabs, so you don’t need to leave the main tab to make an entity private, but the setting also appears with the rest of the permission settings.

View script and screenshot

Sorts folders and images alphabetically in the Kanka Gallery, keeping folders first.

View script

HTML Beautifier for Summernote

This simple script processes the HTML code of your Kanka entries every time you switch to Summernote's code view in order to add line breaks and indentation and make the code more legible.

View script and screenshots

Jump to Post

A nifty little script that adds an unobtrusive dropdown menu next to the Collapse All and Expand All post controls in entity headers, allowing you to quickly scroll down to the selected post (with optional "back to top" links).

View script and screenshots

Map Path Helper

Adds a button to the polygon marker editor in Kanka maps that manipulates coordinates in the text field in order to turn them into a single line. For example, you can click any three points on the map and activate the Helper to end up with a continuous line instead of an enclosed triangle.

View script and screenshots

Kanka Editor Toolkit

Adds buttons to the Summernote editor toolbar that can be used to insert HTML elements or classes required by various Marketplace themes with a simple click. Also provides convenient modals for the more complex plugins. Most features are compatible with both the visual and code editors, and you can also set up your own classes and HTML snippets in your campaign’s styles for quick access.

View script and screenshots

Mention Previewer

Allows viewing mentioned entities in a modal that contains the full entry, posts, pinned attributes and images, without leaving the current page.

View script and screenshots

Search Upgrades

Adds another link to search bar suggestions as you type. Said link will take you the Search page to look for your input in entity content rather than limiting itself to titles. Optionally, you can also use this script to quickly find campaign or user settings without navigating through the interface.

View script and screenshots

Subpage Elements Counter

Shows the count of attributes, relations, assets, etc. on each entity's corresponding submenu item.

View script and screenshot

Summernote Code View to the Top

A simple script that sets the cursor position to the start of the input field rather than the end when switching to Code View in the Summernote editor, which is more consistent with what happens when you switch back to the visual editor.

View script

Summernote to Markdown for Kanka

Adds a text field under editors where you can see your entry’s Markdown equivalent in real time, and edit the Markdown to send the changes back to Summernote as you type.

View script

Tags Column for Kanka Entity Lists

This script adds a Tags column to entity lists in table view, as is often requested on the official Discord.

View script and screenshot

Ideas and work in progress

  • The JSON Export option could be used to fetch limited additional data from an entity and display it on its front page (and/or display front page content in its subpages).

  • I’m considering using the above to add an entity’s entry to the new search pane’s result preview.

Retired scripts

Expand/collapse

Advanced Mention Name Reminder

Showed advanced mentions’ target entity name in Summernote in superscript or in a tooltip for easier editing. Reimplemented as a purple tag in Kanka 1.31.

View script and screenshots

Campaign CSS Splitter

A precursor to the new Theming area of Kanka, that allowed a user to split their campaign CSS into multiple form fields, with the ability to name and reorder sections, all while providing syntax highlighting.

View script and screenshots

Copy Post With Title

Changes the behaviour of the "Copy advanced mention" option on your Kanka entities’ posts to display the post’s title rather than the parent entity’s title. Kanka now offers both options out of the box.

HTML Inserter for Summernote

An earlier iteration of the Marketplace Toolbar that only inserted predefined code snippets.

View script and screenshots

Summernote code view save fix

Fixes the Summernote bug where saving from Code View discards any changes made since last viewing the visual editor. Implemented into Kanka itself in v.1.14!

View script and screenshots

Last updated