Readable Osiris - Script Formatter Readability Tool

Abstract

Osiris formatter.

A command-line tool (.exe file) that takes Osiris files and formats them to be more readable and searchable, using my own best practices for Osiris formatting.

This is not a validator. It will attempt to format your file regardless of whether the Osiris syntax is valid or not.

Helps with readability and in-file text searches (since the results are per line, and the line has more context).

Install

• []Download (or use git mirror).

  []Unpack.

  []Place in a convenient location (same location for both files).

Usage

Option #1: (simple) Just drag Osiris files onto it.

You can drag multiple files, but not folders. All files will be assumed to be Osiris files.

Option #2: (advanced) Write a batch file that calls it.

(It’s a normal command-prompt executable)

Note that Osiris files use the .txt extension and are located in

...\Data\Mods\\Story\RawFiles\Goals

Game modules are: Shared, SharedDev, Gustav, and GustavDev.

You may need to use LSLib to unpack game pack files first.

Features

• []Formats all standard story sections: INITSECTION, KBSECTION, EXITSECTION.

  []Cleaner KB structure: consistent IF/PROC/QRY blocks, AND grouping, THEN separation, and predictable semicolons.

  []Newlines inside argument lists: normalizes wrapped argument lists, keeping line breaks aligned under the opening parenthesis where needed.

  []INIT/EXIT action readability: auto-aligns arguments across consecutive calls of the same action (pads columns, then inserts a blank line when the action name changes).

  []Boolean normalization: “no literal 0” rule for boolean-flag queries (read the advanced section for more on that).

  []Safer output controls: auto-creates osiris_formatter.ini, supports in-place or mirror output, and can keep .bak backups (default on).

  []Batch-friendly: pass multiple files in one run (drag-and-drop or a .bat).

• []Does not validate logic.

  []Assumes file is Osiris-like text.

• No GUI (yet).