game-music-emu

Crates.iogame-music-emu
lib.rsgame-music-emu
version0.2.0
sourcesrc
created_at2021-02-28 07:40:22.904177
updated_at2021-02-28 07:40:22.904177
descriptionRust bindings for Game Music Emu
homepage
repositoryhttps://github.com/JayPavlina/Game-Music-Emu-Rust
max_upload_size
id361704
size956,480
Jay Pavlina (JayPavlina)

documentation

README

Game Music Emu Rust

Game Music Emu Crate Game Music Emu Documentation

This crate contains Rust bindings for Game Music Emu. It is pretty barebones at the moment and does not cover everything, but eventually it will have bindings for most of the functions in gme.h.

Getting Started

Add the following to your Cargo.toml.

game-music-emu = "0.2"

Conditional Compilation

Just like the regular version of Game Music Emu, you can choose which emulators are included by adding features to your Cargo.toml.

For example, if you only want to use Nintendo and Game Boy emulators, you'd write:

gme = { version = 0.1, default-features = false, features = ["gbs", "nsf"] }

See Cargo.toml for all available features. The build logic is in build.rs. You can call gme::type_list() at runtime for a list of emulators you compiled with.

##Usage

See the example for usage.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Game Music Emu is licensed under LGPLv2.1. See its license for details.

Acknowledgments

  • Shay Green for creating Game Music Emu
  • Michael Pyne for maintaining Game Music Emu
Commit count: 24

cargo fmt