Maraiah/README.md

22 lines
678 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# Maraiah
Public domain tools for editing data for the Marathon engine. The name "Maraiah"
is derived from the Japanese transliteration of "Mariah," and is pronounced
"mah-rye-uhh" (/mɑɹaɪʌ/ in IPA.) It has no special meaning.
## `maraiah`
The basis of this project is the Rust project `maraiah` which provides functions
and structures to build applications which work with Marathon's data.
See [the crate documentation](source/lib.rs) for more information.
## `maraiah-leela`
`leela` is a CLI utility that essentially allows for a direct user interface to
the underlying Maraiah library.
## `maraiah-tycho`
`tycho` is a map editor written in C++ and Rust using Qt.