Skip to content

kate.md

Latest commit

 

History

History
108 lines (80 loc) · 4.33 KB

kate.md

File metadata and controls

108 lines (80 loc) · 4.33 KB
Raw

Kate

Setup guide for using BGforge MLS with Kate (KDE text editor).

Prerequisites

pnpm install -g @bgforge/mls-server

Requires Kate 25.08+ for settings support. Older versions (21.12+) provide basic LSP features but cannot pass settings to the server.

Syntax highlighting

Download bgforge-mls-kate-<version>.zip from the latest GitHub release and extract the .xml files to:

  • Linux: ~/.local/share/org.kde.syntax-highlighting/syntax/
  • Windows: %USERPROFILE%\AppData\Local\org.kde.syntax-highlighting\syntax\
  • macOS: ~/Library/Application Support/org.kde.syntax-highlighting/syntax/

Restart Kate after installing. The definitions provide keyword, function, and constant highlighting plus code folding. The zip also includes highlight-only definitions (no LSP provider) for Fallout MSG (.msg), WeiDU TRA (.tra), Infinity 2DA (.2da), and Fallout scripts.lst (scripts.lst).

Note: .h files default to C++ in Kate. Use Tools > Highlighting > Fallout SSL manually for Fallout header files.

Language server

Enable the built-in LSP Client plugin in Settings > Configure Kate > Plugins > LSP Client.

Add a server in Settings > Configure Kate > LSP Client > User Server Settings:

{
  "servers": {
    "ssl": {
      "command": ["bgforge-mls-server", "--stdio"],
      "highlightingModeRegex": "^(Fallout SSL|WeiDU BAF|WeiDU D|WeiDU TP2|Fallout-Worldmap)$"
    }
  }
}

The highlightingModeRegex must match the language names from the installed KSyntaxHighlighting definitions. The Fallout Worldmap KSH definition matches worldmap.txt by filename. For scripts.lst, use Tools > Highlighting > Fallout scripts.lst manually since the extension is generic.

File icons

Kate draws file icons from the desktop icon theme via XDG MIME types - it has no per-filetype icon setting of its own. The Kate KSH zip (from Syntax highlighting above) includes a mimetypes/ folder with shared-mime-info definitions and matching icons. Installing them adds the icons for all KDE/XDG apps (Dolphin too), not just Kate. Linux only:

# run from the extracted bgforge-mls-kate-<version> directory
install -Dm644 mimetypes/bgforge-mls.mime.xml ~/.local/share/mime/packages/bgforge-mls.mime.xml
update-mime-database ~/.local/share/mime

mkdir -p ~/.local/share/icons/hicolor/scalable/mimetypes
cp mimetypes/application-x-*.svg ~/.local/share/icons/hicolor/scalable/mimetypes/
gtk-update-icon-cache ~/.local/share/icons/hicolor 2>/dev/null || true
kbuildsycoca6 2>/dev/null || kbuildsycoca5 2>/dev/null || true

Restart Kate. Notes:

  • .ssl and other common extensions can collide with MIME types other applications define. If the wrong type wins, raise the glob priority in bgforge-mls.mime.xml (<glob pattern="*.ssl" weight="60"/>) and re-run update-mime-database.
  • .h and .d are intentionally excluded (they collide with C headers and the D language).
  • WeiDU BAF (.baf) and TP2 (.tp2) ship no scalable icon (their assets are raster-only) and keep the generic file icon.

TypeScript plugins (TSSL/TD)

If you write .tssl or .td transpiler files, the server package includes TypeScript plugins that run inside tsserver. See TypeScript Plugins for setup.

Settings

Kate sends settings via workspace/configuration (requires Kate 25.08+). Add to the server configuration:

{
  "servers": {
    "ssl": {
      "command": ["bgforge-mls-server", "--stdio"],
      "highlightingModeRegex": "^(Fallout SSL|WeiDU BAF|WeiDU D|WeiDU TP2|Fallout-Worldmap)$",
      "settings": {
        "bgforge": {
          "validate": "saveAndType",
          "falloutSSL": {
            "compilePath": "",
            "compileOptions": "-q -p -l -O2 -d -s -n",
            "outputDirectory": "",
            "headersDirectory": ""
          },
          "weidu": {
            "path": "weidu",
            "gamePath": ""
          }
        }
      }
    }
  }
}

On older Kate versions, the server falls back to built-in defaults.

See Settings Reference for all available options.