Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rust-gamedev/arewegameyet
The repository for https://arewegameyet.rs
https://github.com/rust-gamedev/arewegameyet
ecosystem gamedev rust zola
Last synced: about 22 hours ago
JSON representation
The repository for https://arewegameyet.rs
- Host: GitHub
- URL: https://github.com/rust-gamedev/arewegameyet
- Owner: rust-gamedev
- License: cc-by-4.0
- Created: 2016-08-30T21:45:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-01-20T00:54:07.000Z (6 days ago)
- Last Synced: 2025-01-21T00:06:57.431Z (5 days ago)
- Topics: ecosystem, gamedev, rust, zola
- Language: SCSS
- Homepage: https://arewegameyet.rs
- Size: 68.2 MB
- Stars: 709
- Watchers: 16
- Forks: 154
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- AwesomeCppGameDev - arewegameyet
README
# README
## What is this?
The Rust community has a number of websites dedicated to keeping track of the state of the ecosystem for specific purposes. (e.g. [arewewebyet](https://www.arewewebyet.org) and [arewelearningyet](https://www.arewelearningyet.com))
This one tracks the state of the ecosystem for Game Development in Rust.
You can find the site at [arewegameyet.rs](https://arewegameyet.rs/).
## Contribute
Arewegameyet? uses [semantic-ui](https://semantic-ui.com/), and [zola](https://github.com/getzola/zola) the Rust static site generator.
1. Navigate to whichever folder in `/content` best fits your project.
2. Edit that folder's `data.toml` file in any plain text editor or straight through [GitHub's editor](https://help.github.com/articles/editing-files-in-another-user-s-repository/).
3. Create a new entry, following the schema described below. Note that all entries should be sorted alphabetically by the `name` field, ignoring case. There is a CI check to ensure this is done correctly - you can use the `sort_data.py` script to automatically fix a file.
**All done!** We do greatly appreciate PRs, but if you're not comfortable with this process, you're welcome to open an issue requesting the addition of your project instead.
### Schema
```toml
[[items]]
# The name of the item. Mandatory.
name = "My crate"
# A short description of the item. Optional, but recommended.
description = "My extremely cool Rust crate"
# The categories that your item should be assigned to. Mandatory.
categories = ["2drendering", "engines"]
# An image representing the item. Files should be checked in to
# /static/assets/img/, and the path should be absolute.
# Optional, but highly recommended for games!.
image = "/assets/img/logo.png"
# A link to the item's page on Crates.io. Optional.
crate_url = "https://crates.io/crates/mycrate"
# A link to the item's VCS repository. Optional.
repository_url = "https://github.com/username/repo"
# A link to the item's homepage. Optional.
homepage_url = "https://mycrate.com"
# A link to the item's Gitter chat. Optional.
gitter_url = "https://gitter.im/mycrate"
```
You can also tell the site to pull data directly from an external source:
```toml
[[items]]
# Pull data from Crates.io:
name = "mycratename"
source = "crates"
categories = ["mycategory"]
[[items]]
# Pull data from GitHub:
name = "username/repo"
source = "github"
categories = ["mycategory"]
```
Extra keys can be added to items that are pulled from external data (e.g. to add a homepage URL, or override some of the fetched data).
### Enhance this website
If you're comfortable with semantic-ui and Zola please reach out to us in the Issues with your enhancement ideas or just to state your willingness to contribute.
### Errors
It's very likely there are mistakes around, if you find one please file an issue.
*Thanks for helping us map the Rust game development ecosystem!*