Skip to content

Commit

Permalink
Add instructions and feature for wayland
Browse files Browse the repository at this point in the history
  • Loading branch information
Piturnah committed Jan 8, 2025
1 parent 08b5b63 commit cfb4fad
Show file tree
Hide file tree
Showing 3 changed files with 201 additions and 28 deletions.
206 changes: 180 additions & 26 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 5 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ rand = { version = "0.8", default_features = false, features = ["std", "small_rn
[dependencies.bevy]
version = "0.9"
default_features = false
features = [ "png", "x11" ]
features = ["png"]

[features]
default = ["x11"]
dev = ["bevy/dynamic"]

x11 = ["bevy/x11"]
wayland = ["bevy/wayland"]

[profile.dev.package."*"]
opt-level = 3
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,22 @@ This game is part of the [Fish Folk](https://spicylobster.itch.io/jumpy/devlog/4
- [Folly](https://github.com/fishfolks/folly)
- [Ballsy](https://github.com/fishfolks/ballsy)

## Getting Started

The easiest way to build and run *Bomby* is by using Cargo. The easiest way to set cargo up is by using [rustup](https://rustup.rs/).

Then, you can run the game with

```console
$ cargo run --release
```

If you are using wayland, you can use

```console
$ cargo run --release --no-default-features --features wayland
```

## Contributing

Anyone involved in the Fish Folk community must follow our [code of conduct](https://github.com/fishfolks/jumpy/blob/main/CODE_OF_CONDUCT.md).
Expand Down

0 comments on commit cfb4fad

Please sign in to comment.