Kanka Cookbook
My Links 🏷️
  • Welcome to the Kanka Cookbook
  • Guide to Summernote
  • General tips and tricks
  • External tools and scripts for Kanka
  • 🎨CSS
    • Introduction to campaign CSS
    • Dashboard customization
    • Styling tooltips
    • Adapting layout to context
  • 🛠️Plugin Creators
    • Character sheet creation guide
    • Generating tooltips
    • Localizing character sheets
    • Theme creation tips
    • JavaScript in character sheets
      • Exposing attributes and other entity information
      • Live-editing attributes via the API
      • Importing external libraries
  • đź§™Power Users
    • Extraordinary Tooltips User Guide
    • Using transclusion
    • Changing a Plugin Library template’s default values
Powered by GitBook
On this page
  • External tools
  • Discord Integrations
  • User scripts
  • Automatic Table of Contents
  • Custom Coloris Palette
  • Custom Keyboard Shortcuts for Summernote
  • Entity Privacy Setting on the Entry Tab
  • Gallery Alphabetical Sort
  • HTML Beautifier for Summernote
  • Jump to Post
  • Kanka Autosaves
  • Kanka Editor Toolkit
  • Map Path Helper
  • Mention Previewer
  • Search Upgrades
  • Subpage Elements Counter
  • Summernote Code View to the Top
  • Summernote to Markdown for Kanka
  • Tags Column for Kanka Entity Lists
  • Retired scripts

Was this helpful?

External tools and scripts for Kanka

Last updated 29 days ago

Was this helpful?

External tools

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

  • 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.

  • by NachtTheFerret: A JavaScript library for the API.

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

  • 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.

  • 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

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

  • 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 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.

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.

Custom Keyboard Shortcuts for Summernote

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

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.

Gallery Alphabetical Sort

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

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.

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).

Kanka Autosaves

Saves a snapshot of the editor’s content to your browser’s local storage at set intervals so you can recover it if you forget or fail to save the entity after making changes. Adds a toolbar button to view your saved snapshots and insert them into the editor in one click.

Kanka Editor Toolkit

Adds buttons to the Summernote editor toolbar that can be used to insert HTML elements or classes required by various Plugin Library 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.

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.

Mention Previewer

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

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.

Subpage Elements Counter

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

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.

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.

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.

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.

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.

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 Toolkit that only inserted predefined code snippets.

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!

Kanka Archive Explorer
Kanka Attribute Templates Designer
Kanka.js
Kanka Ruler Calculation
Tag the Untagged
Kanka-Wordcount
kanka-discord
kanka-view
Tampermonkey
View script and screenshots
View script and screenshots
View script
View script and screenshot
View script
View script and screenshots
View script and screenshots
View script and screenshots
View script and screenshots
View script and screenshots
View script and screenshots
View script and screenshots
View script and screenshot
View script
View script
View script and screenshot
View script and screenshots
View script and screenshots
View script and screenshots
View script and screenshots