Features
- Multiple function definitions in a single file
- Shorthand to call functions without namespace prefix (
func_1
instead ofnamespace:func_1
) - Transpile single files or entire folders
- Variable definitions via scoreboards
- Shorthand for objective creation
- Shorthand for testing variables in
if
commands - Configuration options
Building and Running
This project requires cargo.
To build the project, clone the repo and run cargo build
in the root directory.
To build for release, run cargo build --release
.
To run Databind after building it with cargo build
, use cargo run
.
Installation
From crates.io
To download Databind from crates.io, run cargo install databind
. If Rust is
in your PATH,
then running databind
from a command line will work.
Locally
To install Databind from a cloned repository, run cargo install --path .
in the root directory.
Documentation
Documentation is build using reStructuredText and Sphinx. Requires Python. Built documentation is hosted on Read The Docs.
Building Docs
To build the documentation, go to the /docs folder and run pip install -r requirements.txt
.
Then run make.bat html
or make html
, depending on platform.
Viewing Docs
To view the documentation, open the index.html
file generated in /docs/_build/html.
License
Databind is licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.