Game development tools for the Amethyst engine
Rust
Switch branches/tags
Nothing to show
Clone or download
bors[bot] and termhn Merge #57
57: Make template follow fn main() -> Result convention r=Xaeroxe a=termhn

Title. Seems the Amethyst examples are set up like this already, but this tool has not yet been updated

Co-authored-by: Gray Olson <gray@grayolson.com>
Latest commit 166a2d7 Jun 9, 2018

README.md

Amethyst Tools

Build Status Crates.io MIT/Apache License Join the chat

A suite of game development tools written in Rust, intended for use with the Amethyst engine. 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.

Toolchain

At the moment, there is only one tool available in this distribution. Please suggest ideas for more tools on our issue tracker.

  • Amethyst CLI - Command-line interface for creating and deploying game projects, intentionally very similar to Cargo.

Installing

Requirements

  • Ensure that you have the OpenSSL development headers installed (check for openssl-devel or something similar)

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

We are a community project that welcomes contribution from anyone. If you're interested in helping out, please read the CONTRIBUTING.md file before getting started. Don't know what to hack on? See the Development Roadmap on our wiki, or search though our issue tracker.

All contributions are assumed do be dual-licensed under MIT/Apache-2.0.