rms-check

A linter and language server for Age of Empires 2 random map scripts.

Usage - Status - Install - License: GPL-3.0

Usage

rms-check is available both as a command-line program and as an extension for VS Code.

VS Code Extension

Please see vscode/ for the VS Code extension.

CLI

rms-check 0.0.4
Syntax checking and linting tool suite for Age of Empires 2 random map scripts

USAGE:
    rms-check [FLAGS] [file] [SUBCOMMAND]

FLAGS:
        --aoc        Set the default compatibility to Age of Conquerors. Scripts can override this using `/*
                     Compatibility: */` comments
        --de         Set the default compatibility to Definitive Edition. Scripts can override this using `/*
                     Compatibility: */` comments
    -h, --help       Prints help information
        --hd         Set the default compatibility to HD Edition. Scripts can override this using `/* Compatibility: */`
                     comments
        --up14       Set the default compatibility to UserPatch 1.4. Scripts can override this using `/* Compatibility:
                     */` comments
        --up15       Set the default compatibility to UserPatch 1.5. Scripts can override this using `/* Compatibility:
                     */` comments
    -V, --version    Prints version information
        --wk         Set the default compatibility to WololoKingdoms. Scripts can override this using `/* Compatibility:
                     */` comments

ARGS:
    <file>    The file to check, when not using any subcommand

SUBCOMMANDS:
    check     Syntax check and lint a random map script
    fix       Auto-fix problems with a random map script
    format    Format the given file
    help      Prints this message or the help of the given subcommand(s)
    pack      Pack a folder into an Zip-RMS map
    server    Start the language server
    unpack    Unpack a Zip-RMS map into a folder

rms-check "/path/to/aoc/Random/Everything_Random_v4.3.rms"

Status

There is a simple parser and some lints for highlighting common problems.

There is also a language server implementation that provides diagnostics, folding ranges, and rudimentary formatting. In the future, I'd like to support more things, like context-aware completions and hover help.

Install

Currently no binaries are provided. Installation must be done by compiling this repository from source.

First, get rustup: https://rustup.rs/

Then do something like:

# download rms-check:
git clone https://github.com/goto-bus-stop/rms-check.git
cd rms-check
# build it:
cargo build --release
# run it!
./target/release/rms-check FILENAME

License

GPL-3.0