Amethyst Tools

Command-line interface for the Amethyst engine to create and deploy game projects. This project is a work in progress and is very incomplete; pardon the dust!

Vision

One of the goals of Amethyst is to split up the traditional "mega-editor" seen in many other game engines into several small but well-integrated tools, adhering to the Unix philosophy. This approach allows for nifty things like:

• Piping and streaming data between tools like regular Unix commands.
• Network transparency (e.g. mirroring gameplay from your development machine onto a testbed computer or smartphone).
• Customizing your workflow to your liking with plain ol' shell scripts.
• Stripping out tools you don't want or need, or easily supplanting them with third-party utilities.
• Serving as backends for various "mega-editors" provided by third parties or written in-house.

Installing

By executing

cargo install amethyst_tools

a binary called amethyst will be placed in your ~/cargo/bin folder.

Usage

Creating a new project

amethyst new <project_name>

Contributing

Note: Any interaction with the Amethyst project is subject to our Code of Conduct.

Amethyst is a community-based project that welcomes contributions from anyone. If you're interested in helping out, please read the contribution guidelines before getting started.

We have a good first issue category that groups all issues or feature requests that can be made without having an extensive knowledge of Rust or Amethyst. Working on those issues is a good, if not the best, way to learn.

If you think you are not ready to code yet, you can still contribute by reviewing code written by other members of the community. Code reviews ensure that code merged into Amethyst is of the highest quality as possible. Pull requests that are available for reviews can be found here.

If for some reason we don't have any open PRs in need of a review nor any good first issues (that would be a good thing), feel free to consult our issue tracker.

License

Amethyst is free and open source software distributed under the terms of both the MIT License and the Apache License 2.0.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.