Skip to content

Settings files ​

SystemConfiguration directory
macOS, Linux~/.config/TypewriterNocturne/
Windows%APPDATA%\Typewriter Nocturne\

It holds:

  • hyper.json: the terminal (shell, environment, keymaps, plugins), as in Hyper,
  • nocturne.json: everything the Studio sets,
  • archive/: kept folios, one JSON file each.

An existing Hyper installation is never read or changed, and your shell's start-up files are never touched.

nocturne.json ​

The Studio writes this file; you can also edit it by hand. Every value is checked when it is read, and anything unknown or out of range falls back to its default.

json
{
  "theme": "paper-and-ink",
  "focusMode": false,
  "effects": true,
  "paper": { "style": "onionskin", "texture": 1, "width": 0 },
  "lighting": {
    "enabled": true,
    "preset": "balanced",
    "intensity": 1,
    "spread": 74,
    "beam": "pointed",
    "aim": 0,
    "reach": 1,
    "window": { "columns": 3, "rows": 2, "slant": 0, "x": 0.34, "y": 0.23 },
    "softness": 0.65,
    "particles": 0.45,
    "grain": 0.1,
    "quality": "auto"
  },
  "typography": {
    "font": "courier-prime",
    "customFamily": "",
    "fontSize": 15,
    "lineHeight": 1.4,
    "cursorStyle": "block",
    "selectionStyle": "ink"
  },
  "typewriter": {
    "sound": true,
    "volume": 0.45,
    "voice": "standard",
    "marginBell": true,
    "carriage": true,
    "impression": 0.8
  },
  "print": {
    "keepInArchive": true,
    "style": {
      "paper": "laid",
      "sealColor": "crimson",
      "monogram": "TN",
      "emblem": "moon",
      "seal": true,
      "ribbon": true,
      "ribbonStyle": "tails",
      "ribbonColor": "wax",
      "font": "typewriter",
      "customFont": "",
      "signature": ""
    }
  },
  "chrome": { "pullCord": true },
  "focus": { "background": "paper", "color": "#1c1916", "paper": true, "lighting": false },
  "scrollbar": { "style": "clip", "finish": "silver", "barOpacity": 0.45, "barWidth": 6 }
}
KeyValues
themepaper-and-ink, midnight-study, moonlit-poetry, or classic for Hyper's own look
paper.styleonionskin (default), cotton, laid, linen, parchment, night
lighting.qualityauto, high, medium, low
lighting.spread / aimbeam angle 20–160°, swivel −45° to 45°
typography.fontcourier-prime, ibm-plex-mono, jetbrains-mono-nf, fira-code-nf, hack-nf, meslo-nf, caskaydia-nf, custom, …
typewriter.voicestandard, portable, electric, whisper
typography.selectionStyleink (dissolving ink), classic (xterm's box)
print.style.paperlaid, cotton, vellum, parchment, night
print.style.sealColorcrimson, oxblood, black, gold, emerald, sapphire
print.style.emblemmoon, rose, quill, none
print.style.fonttypewriter, sonnet, display, plex, terminal, custom (uses customFont)
print.style.signaturethe name after “set at the typewriter, by”, up to 40 characters
focus.backgroundpaper, dark, custom (uses focus.color)
scrollbar.style / finishclip, bar, native / silver, brass, gold, black
scrollbar.barOpacity / barWidth0.1–0.9 / 3–12 px
typography.cursorStyleblock (default: the ink block), quill, bar, underline
lighting.beampointed (default), soft
print.style.sealtrue to seal folios in wax, false to print without a seal
print.style.ribbonStyletails (default), loop, band, cross, banner, pendant
print.style.ribbonColorwax (default: the silk that goes with the wax), crimson, burgundy, navy, emerald, gold, ivory, black
paper.width0 (the narrowest sheet, default) to 1 (the full length of the platen)
lighting.sourcetheme (default), carriage, desk-lamp, moonlight
lighting.windowmoonlight's window: columns and rows 1–6, slant −35° to 35° (0 = upright), x and y 0–1

Released under the MIT licence. Built on Hyper.