oraide

what's in a name? what the heck is an oraide?

The oraide moniker is simply a shortened form of "OpenRA IDE."

project plan

A suite of tools to aid in the development of OpenRA-based games.

OpenRA is a general-purpose RTS game engine with strong modding support.

(copied from https://www.openra.net/about/)

The goal of this project is not to produce libraries for developers, although that will happen, but to create tools (such as command-line applications, editor extensions, etc.) that reduce friction in game development.

actual project status

Exposes functionality to componentize MiniYaml, a textual file format custom to OpenRA, into spanned lines which can be used to implement basic linting, but not much else currently.

See the running the command-line application section of this file for more information.

---

Note that although half of the name "MiniYaml" is "Yaml", and the .yaml file extension is used, it is not YAML.

Due to the fact that MiniYaml and YAML are indentation-based, syntax-highlighting a MiniYaml file as YAML generally works well enough.

technologies used

• the Rust programming language (see the rust-toolchain file for version info)
  • Cargo for project management / building / etc
• Microsoft's Visual Studio Code (some snippets in-tree)
  • use whatever works best for you
  • Visual Studio Code Remote - Containers so the project can be worked on remotely and without polluting the maintainer's local machine / environment

running the command-line application

Note that this command-line application primarily exists currently to manually test functionality as it is implemented.

From the root of this repository (the directory containing the file you're currently reading), execute the following in your shell.

cargo run --manifest-path=./crates/cli/Cargo.toml -- check ./test-miniyaml-files/exploding-barrel.yaml

You should see output similar to the following.

command output

Notice that the lines have been split into components (indent, key, etc.). Internally these components are byte index spans, but the text of those spans is displayed here.

raw     = "exploding-barrel:\n"
indent  = None
key     = Some("exploding-barrel")
key_sep = Some(":")
value   = None
comment = None
term    = Some("\n")

raw     = "    Tooltip:\n"
indent  = Some("    ")
key     = Some("Tooltip")
key_sep = Some(":")
value   = None
comment = None
term    = Some("\n")

raw     = "        Name: barrels\n"
indent  = Some("        ")
key     = Some("Name")
key_sep = Some(":")
value   = Some("barrels")
comment = None
term    = Some("\n")

raw     = "    Health:\n"
indent  = Some("    ")
key     = Some("Health")
key_sep = Some(":")
value   = None
comment = None
term    = Some("\n")

raw     = "        HP: 5\n"
indent  = Some("        ")
key     = Some("HP")
key_sep = Some(":")
value   = Some("5")
comment = None
term    = Some("\n")

raw     = "    Explodes:\n"
indent  = Some("    ")
key     = Some("Explodes")
key_sep = Some(":")
value   = None
comment = None
term    = Some("\n")

raw     = "        Weapon: large-barrel-explode\n"
indent  = Some("        ")
key     = Some("Weapon")
key_sep = Some(":")
value   = Some("large-barrel-explode")
comment = None
term    = Some("\n")

raw     = "    MapEditorData:\n"
indent  = Some("    ")
key     = Some("MapEditorData")
key_sep = Some(":")
value   = None
comment = None
term    = Some("\n")

raw     = "        Categories: props, dangerous-props\n"
indent  = Some("        ")
key     = Some("Categories")
key_sep = Some(":")
value   = Some("props, dangerous-props")
comment = None
term    = Some("\n")

contributing

oraide is not yet ready for contributions.

license (AGPLv3)

Read LICENSE-AGPLv3 for details.