Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Validation, CI and new README for assets #105

Merged
merged 7 commits into from
Jun 1, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: CI

on:
pull_request:

jobs:
check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master

- name: "Install Asset Validator"
run: cargo install --git https://github.com/bevyengine/bevy-website/ --bin validate

- name: "Check Assets"
run: validate ./
15 changes: 15 additions & 0 deletions .github/workflows/deploy-website.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: Deploy

on:
push:
branches:
- main

jobs:
deploy-website:
runs-on: ubuntu-latest
steps:
- name: trigger website deploy
run: gh --repo bevyengine/bevy-website workflow run deploy.yml
env:
GITHUB_TOKEN: ${{ secrets.CART_PAT }}
2 changes: 1 addition & 1 deletion Apps/Games/arugio.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
name = "arugio"
description = "Prototype multiplayer server-authoritative networked 'game' with Browser (WebGL) client and native server"
description = "Multiplayer server-authoritative networked 'game' with Browser (WebGL) client and native server"
link = "https://github.com/ostwilkens/arugio"
2 changes: 1 addition & 1 deletion Assets/Animation/bevy_easings.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
name = "bevy_easings"
description = "A plugin for easing a component value to another value, mainly used to animate transition between two transforms, but usable for other components."
description = "Easing (or tweening) a component value to another value."
link = "https://crates.io/crates/bevy_easings"
2 changes: 1 addition & 1 deletion Assets/Development tools/autodefault.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
name = "autodefault"
description = "annotate functions to have them automatically insert `..Default::default()` into struct expressions. Useful when instantiating large, deeply nested components or component bundles."
description = "annotate functions to have them automatically insert `..Default::default()` into struct expressions"
link = "https://github.com/Lucretiel/autodefault"
2 changes: 1 addition & 1 deletion Assets/Input/Kurinji.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
name = "Kurinji"
description = "Input Map for bevy. Converts user input from different input hardware into game specific actions, eg. keyboard 'Space' or joystick 'A' can be mapped to 'Jump' Action. This allows decoupling of the game code from device specific input api."
description = "Input Map for bevy. Converts user input from different input hardware into game specific actions."
link = "https://crates.io/crates/kurinji"
2 changes: 1 addition & 1 deletion Assets/Physics/physme.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
name = "physme"
description = "A simplistic physics engine for both 2D and 3D simulation. Physically inaccurate, but feels satisfying and is easy to use."
description = "A simplistic physics engine for 2D/3D sims. Physically inaccurate, but satisfying and easy to use."
link = "https://github.com/walterpie/physme"
2 changes: 1 addition & 1 deletion Assets/Templates/bevy_game_template.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
name = "bevy_game_template"
description = "An opinionated template repository for a Bevy game including a workflow for Windows, Linux, macOS and Web (WASM) releases"
description = "An opinionated template for a Bevy game with workflows for Windows, Linux, macOS and WASM releases"
link = "https://github.com/NiklasEi/bevy_game_template"
1 change: 1 addition & 0 deletions Learning/Migration Guides/0.3-to-0.4-(unofficial).toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
name = "0.3 to 0.4 (unofficial)"
link = "https://sburris.xyz/posts/bevy-update-0-4/"
order = 0
description = "Migration guide to 0.4"
1 change: 1 addition & 0 deletions Learning/Migration Guides/0.4-to-0.5-(official).toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
name = "0.4 to 0.5 (official)"
link = "https://bevyengine.org/learn/book/migration-guides/0.4-0.5/"
order = 1
description = "Migration guide to 0.5"
2 changes: 1 addition & 1 deletion Learning/Tutorials/Bevy-Cheatbook.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
name = "Bevy Cheatbook"
description = "Practical reference to programming in bevy! Covers basic concepts, syntax, and solutions to common game dev tasks!"
description = "Practical reference to bevy! Covers basic concepts, syntax, and solutions to common game dev tasks!"
link = "https://bevy-cheatbook.github.io"
1 change: 1 addition & 0 deletions Learning/Tutorials/Official-Bevy-Examples.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ name = "Official Bevy Examples"
description = "Learn each Bevy feature from minimal illustrative examples"
link = "https://github.com/bevyengine/bevy/tree/latest/examples"
order = 0
image = "official-bevy-examples.png"
1 change: 1 addition & 0 deletions Learning/Tutorials/Using-Rapier-for-Physics.toml
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
name = "Using Rapier for Physics"
link = "https://sburris.xyz/posts/bevy-gravity/"
description = "Gravity and Physics in the Bevy Game Engine"
Binary file added Learning/Tutorials/official-bevy-examples.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 30 additions & 0 deletions NEW_README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Bevy Assets

A repository of cool Bevy projects. If you would like to share what you're working on, submit a PR! Feel free to create new categories where it makes sense.

This repository can be explored in the [Bevy Asset website](https://bevyengine.org/assets/).

## Asset Format

Assets are described in a toml file:

```toml
# Name of your asset.
name = "My Cool Plugin"

# Description of your asset. It should be less than 100 characters and not contain formatting.
description = "A short and sweet description of My Cool Plugin"

# Where can your asset be found. It can be a link to crates.io, github, gitlab or similar.
link = "https://github.com/me/my_plugin"

# Optional image to showcase your asset. Should be a png/jpg/gif located next to your toml file.
image = "my_plugin_icon.png"
```

## Categories

Assets are organised in the following categories:
* [Learning](./Learning) - Anything that can help learn Bevy.
* [Assets](./Assets) - Crates that can be used in a Bevy project. These plugins offers additional functionality, see [Bevy plugin guildelines](https://github.com/bevyengine/bevy/blob/main/docs/plugins_guidelines.md) on how to create your plugin crate.
* [Apps](./Apps) - Games and Tools made with Bevy.