Inkline

by viell
5
4
3
2
1
Score: 52/100

Description

An Obsidian plugin for drawing symbols that no font has and writing with them inline in your notes like characters, saved as plain PNG images. Agent-maintained.

Reviews

No reviews yet.

Stats

0
stars
37
downloads
0
forks
3
days
0
days
0
days
188
total PRs
0
open PRs
4
closed PRs
184
merged PRs
198
total issues
30
open issues
168
closed issues
1,100
commits

Latest Version

a day ago

Changelog

A fix release for 1.0.1. The file format is unchanged: symbols open and look as they did, and a symbol saved with 1.0.2 opens in 1.0.0 and 1.0.1 too.

To update, let Obsidian update Inkline under Settings → Community plugins, or install inkline-1.0.2.zip from this release's assets: extract it into your vault's .obsidian/plugins/ directory, replacing the three files of the version before, as the install guide says.

Fixed

  • The eraser takes away exactly what its circle passes over, and what it has taken stays taken as you go on, but for a straight part that Shift draws, which follows the pointer until you let go of Shift, as with the pen. Behind a large brush moving along a curve, the edge it left in the ink used to shift while erasing, and a little ink came back beside its way, some of it for good. An eraser stroke drawn freehand is now saved as the area its brush swept, as a filled shape the file format already has, so symbols stay in the same format and open in earlier versions of Inkline as before, and what the editor shows while you erase is what it saves, unless Zoom is pressed during the stroke, which can move where any stroke ends (#382). In the strokes measured, such a stroke held about three times the points of a pen stroke as long, and up to nearly seven times for a slow curve with the largest brush. A tap with that brush holds a few dozen points, where the pen's holds one. A reopened symbol places its grid by where such a stroke ends, and no longer by where it starts. A tap with the eraser is the brush's circle saved the same way. An eraser stroke that starts with Flat ends and the grid both on is drawn as before, so that its ends can stop flush with a row, and its edge can still shift along a curve, as Known limits says; turn Flat ends off to erase along a curve. Pen strokes, the eraser's shapes, and eraser strokes saved before are as they were, and so is the grid that a symbol saved before places when it opens again (#341).
  • Inkline follows a canvas card's own editor from the moment it appears, rather than once it takes the focus, tens of milliseconds later. A symbol that changed in between kept its old picture there, and an editor that never took the focus would never have been followed, its symbols keeping their old pictures without Inkline's menu or double-click (#336).
  • A symbol that changes, as through sync, while some of its images are out of the page now shows its new picture in them when Obsidian puts the same images back with the addresses they had, as it does with parts of Reading view as it lays a note out again, and with a canvas card's own editor, which it moves into a frame of its own as it opens. Those images kept the old picture until the note or the editor was shown again. An image that Obsidian makes anew, rather than puts back, is not covered: one made with an address from before the change can still show the old picture until the note is shown again (#281).

README file from

Github

Inkline

An Obsidian plugin for symbols that no font has: draw one once, then write it in your notes as easily as a letter, as often as it comes up. Each symbol sits inside the line of text like a character, by default at the text's size and in its color.

Install

Inkline runs in Obsidian 1.13.4 or later on desktop. 1.0.0 is its first stable release, and its file format is frozen: symbols saved by 0.9.2 or later open as they are, and every symbol saved from now on keeps opening and looking the same. A symbol saved by a version before 0.9.2 opens as a picture to draw over, without its strokes.

  1. In Obsidian, open Settings → Community plugins, turn community plugins on if needed, and select Browse.
  2. Search for Inkline, select it, then select Install and Enable.

Its page in the directory is https://community.obsidian.md/plugins/inkline.

If Inkline does not show there yet, install the ZIP from the latest release:

  1. Download the install ZIP, inkline-<version>.zip, from the assets of the release marked Latest on GitHub releases: the newest public release, such as 1.0.0.
  2. Extract it into your vault's .obsidian/plugins/ directory. The ZIP holds its own inkline/ folder, so the plugin's three files end up in .obsidian/plugins/inkline/.
  3. In Obsidian, open Settings → Community plugins, turn community plugins on if needed, and enable Inkline.

Once Inkline shows in Obsidian's community plugins, Obsidian offers its updates, however you installed it; until then, update a ZIP installation by hand. The installation guide covers updates, pre-releases, older versions, and installing with BRAT. Release notes describe compatibility changes.

A public release has an even minor version, as 1.0.0, and a pre-release an odd one, as 1.1.0, for trying changes before the next public release. Obsidian's community plugins offer public releases only. Every release, public or not, stays on GitHub with its install ZIP.

Your first symbol

  1. In a note, put the cursor where the symbol goes, and run Inkline: Insert symbol from the command palette (Ctrl+P, or Cmd+P on macOS).
  2. Draw the symbol with a mouse or a trackpad. The lines across the drawing area are guides at the text font's lines.
  3. Type a name, such as tower, in the field at the top, and press Save, or Ctrl+Enter (Cmd+Enter on macOS). Inkline saves it as tower.ink.png and puts its embed, ![[tower.ink.png]], where the cursor was. The note shows it in the line, like a character.
  4. To use it again, type the insert trigger and the first letters of its name in any note, as ;;tow with the default trigger, and press Enter.

Your first symbol in the guide goes on from there, and Saving and recovery says how to get unsaved work back.

What it is for

Inkline is for writing notes in a script that no font has, so you cannot type it. That is the same work from two directions:

  • Working a script out. Some games are built around an invented language, and working it out is the game. You draw the symbols that someone else made.
  • Making a script up. A constructed language (a conlang) can have a script of its own. You draw the symbols that you make.

Either way, Inkline does two things:

  • Write a symbol down easily. Draw it where you need it, or trace it from a picture, and it sits in the line like a letter.
  • Use it again easily. A symbol has a name, and can record how it is read and what it means. Type the insert trigger, ;; unless you change it in the settings, and a few letters of any of them to write the symbol again in any note. Its readings and translations can be edited at any time without changing a note, and the library finds every note that uses it.

A cipher or a personal shorthand works the same way.

An invented inscription transcribed as inline symbols, beside the library showing the renamed sign and both notes that use it.

Each symbol is a normal PNG file in your vault, embedded with a normal image link, so your notes still show it if you disable or uninstall the plugin.

Paste a picture to trace, then turn each sign into ink with Make ink and Next, or draw over it yourself:

The drawing editor tracing the first sign of the synthetic inscription, with font guides and the Make ink button.

Documentation

The user guide covers installing the release ZIP, drawing and inserting symbols, saving and recovery, the keyboard, known limits, and reporting a problem. It describes the newest public release, and marks what is not in it yet Unreleased.

Contributing

Inkline is written and maintained by AI agents, and no person reviews the code. CONTRIBUTING.md explains reporting problems, requesting features, development setup, checks, and pull requests. AGENTS.md adds the agents' maintenance and review rules; RELEASING.md describes publication and its gates. Planned work and decisions live in the issues.

For theme, plugin, and tool authors

docs/rendering.md describes the classes and properties Inkline gives symbols in text, and how a plugin's own view of a note can show them as text. docs/file-format.md specifies what a symbol file holds, for tools that read or write them.

License

MIT. The outline of a stroke is adapted from perfect-freehand, copyright 2021 Stephen Ruiz Ltd, under the MIT licence; its notice is in src/ink/freehand.LICENSE.txt and at the top of the plugin's main.js.