# amphora

An **opinionated** meta crate for creating graphically minimal
_Rogue-li\[ke|te\]_ games.

## Usage

⚠️ **Work in progress**: This crate does not yet provide any functionality.

## Features

- [ ] Algorithms for path-finding, field of view, etc.
- [ ] Component systems for game entities.
- [ ] Color types and conversions.
- [ ] Geometry types and computations.
- [ ] Input and output.
- [ ] Random number generation.

## Background

There are a lot of existing Rust crates for creating games, everything from
fully featured engines to simple 2D graphic or math libraries. However, most of
these crates are designed for creating 3D games, or games with a lot of
graphical complexity, and require learning a rather large API surface.

_Amphora_ is a meta-crate that re-exports `amphora-*` crates that are designed
to be used together to create simple 2D games. The goal is to let others focus
on the game mechanics and story, rather than graphics, UI, or fiddling with
underlying libraries.

<!-- cSpell:words Francesco Lapi -->

> The origin of the `@` symbol evolved from an abbreviation of "each at" -
> the "a" being encased by an "e". The first documented use was in 1536, in a
> letter by Francesco Lapi, a Florentine merchant, who used `@` to denote units
> of wine called _amphorae_.
>
> \- [The Accidental History of the @ Symbol](https://www.smithsonianmag.com/science-nature/the-accidental-history-of-the-symbol-18054936/)

## Developing

See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to this
project.