Skip to content

Commit

Permalink
Merge pull request #8 from BlackPhlox/0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
BlackPhlox authored Nov 22, 2021
2 parents 4f70e46 + 166c579 commit c209c16
Show file tree
Hide file tree
Showing 19 changed files with 699 additions and 541 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@

# These are backup files generated by rustfmt
**/*.rs.bk

package-lock.json
9 changes: 6 additions & 3 deletions Cargo.lock

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

11 changes: 6 additions & 5 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[package]
name = "bevy_midi"
version = "0.1.0"
authors = ["BlackPhlox <theluja@gmail.com>"]
edition = "2018"
license = "MIT OR ISC"
version = "0.2.0"
authors = ["Black Phlox <bphlox@gmail.com>"]
edition = "2021"
license = "MIT OR Apache-2.0"
readme = "README.md"
repository = "https://github.com/BlackPhlox/bevy_midi"
documentation = "https://docs.rs/bevy_midi"
Expand All @@ -22,13 +22,14 @@ name = "bevy_midi"

[dependencies]
midir = "0.7.0"
crossbeam-channel = "0.5.1"

[dependencies.bevy]
version = "0.5"
default-features = false

[dev-dependencies]
bevy_config_cam = "0.1.2"
bevy_config_cam = "0.1.3"

[dev-dependencies.bevy]
version = "0.5"
Expand Down
13 changes: 13 additions & 0 deletions LICENSE-APACHE
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Copyright 2021 Mikkel Rasmussen

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
23 changes: 23 additions & 0 deletions LICENSE-MIT
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the
Software without restriction, including without
limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice
shall be included in all copies or substantial portions
of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,44 +6,44 @@
<div align="left">
<a href="https://crates.io/crates/bevy_midi"><img src="https://img.shields.io/crates/v/bevy_midi" alt="link to crates.io"></a>
<a href="https://docs.rs/bevy_midi"><img src="https://docs.rs/bevy_midi/badge.svg" alt="link to docs.rs"></a>
<a href="https://github.com/BlackPhlox/bevy_midi/blob/master/credits/CREDITS.md"><img src="https://img.shields.io/crates/l/bevy_midi" alt="link to license"></a>
<a href="https://github.com/BlackPhlox/bevy_midi/blob/master/LICENSE-MIT"><img src="https://img.shields.io/crates/l/bevy_midi" alt="link to license"></a>
<a href="https://crates.io/crates/bevy_midi"><img src="https://img.shields.io/crates/d/bevy_midi" alt="downloads/link to crates.io"></a>
<a href="https://github.com/BlackPhlox/bevy_midi"><img src="https://img.shields.io/github/stars/BlackPhlox/bevy_midi" alt="stars/github repo"></a>
<a href="https://github.com/BlackPhlox/bevy_midi/actions/workflows/master.yml"><img src="https://github.com/BlackPhlox/bevy_midi/actions/workflows/master.yml/badge.svg" alt="github actions"></a>
<a href="https://github.com/bevyengine/bevy/blob/main/docs/plugins_guidelines.md#main-branch-tracking"><img src="https://img.shields.io/badge/Bevy%20tracking-released%20version-lightblue" alt="tracking bevy release branch"></a>
</div>
</br>

A bevy plugin using [midir](https://github.com/Boddlnagg/midir). This plugin allows you to read or write midi data for a selected midi input.</br>(Currently, write is not implemented yet)

A bevy plugin using [midir](https://github.com/Boddlnagg/midir) and [crossbeam-channel](https://github.com/crossbeam-rs/crossbeam). This plugin allows you to read or write midi data for a selected midi input.</br>(Currently, write is not implemented yet)
## Showcase

Run the examples using:</br>

`cargo run --release --example minimal`
,</br>
`cargo run --release --example simple` or</br>
`cargo run --release --example piano`
Terminal only:
`cargo run --release --example minimal`</br>
Virtual Piano: `cargo run --release --example piano`

Running the piano example:</br>

https://user-images.githubusercontent.com/25123512/122971334-3bae6100-d38f-11eb-9605-4c314b088ff2.mp4

Notice: Sustain is not handled by the example

Browser support: Still work in progress.
# Setup

Todo
See examples

# Support
[![Bevy tracking](https://img.shields.io/badge/Bevy%20tracking-released%20version-lightblue)](https://github.com/bevyengine/bevy/blob/main/docs/plugins_guidelines.md#main-branch-tracking)

|bevy|bevy_midi|
|---|---|
|0.5|0.1.X|
|0.5|0.2.X|

# Licensing
The project is under dual license MIT and ISC (functionally equivalent, though ISC removing some language that is no longer necessary), so yoink to your hearts content, just remember the license agreements.
The project is under dual license MIT and Apache 2.0, so joink to your hearts content, just remember the license agreements.

# Contributing
Yes this project is still very much WIP, so PRs are very welcome
13 changes: 0 additions & 13 deletions credits/CREDITS.md

This file was deleted.

21 changes: 0 additions & 21 deletions credits/licenses/bevy_MIT.md

This file was deleted.

7 changes: 0 additions & 7 deletions credits/licenses/bevy_midi_ISC.md

This file was deleted.

21 changes: 0 additions & 21 deletions credits/licenses/bevy_midi_MIT.md

This file was deleted.

21 changes: 0 additions & 21 deletions credits/licenses/midir_MIT.md

This file was deleted.

Loading

0 comments on commit c209c16

Please sign in to comment.