Cargo Features
Rust-GB has no features set by default.
[dependencies]
rust-gb = { version = "0.1.0-alpha.2", features = ["color", "prototype", "compiler"] }- color
-
Library features
GameBoy Color feature
This feature enables GameBoy Color only features. Such as VRAM bank or color palette.
Since the compiler does not yet support compilation in to GameBoy Color ROM, this will not actually work.
Affects
mmio::KEY1,mmio::VBK,mmio::HDMA1,mmio::HDMA2,mmio::HDMA3,mmio::HDMA4,mmio::HDMA5,mmio::RP,mmio::BCPS,mmio::BCPD,mmio::OCPS,mmio::OCPD,mmio::OPRI,mmio::SVBK,mmio::PCM12,mmio::PCM34… - prototype
-
Prototype feature
This feature enables the prototype APIs of Rust-GB.
Because it's a prototype, it won't work properly.Affects
rust-gb::memory… - compiler = clap, colored, include_dir, tree-sitter, tree-sitter-c
-
Binary features
Feature for compiler
This feature needed to enabled when you install Rust-GB compiler with
cargo install.DO NOT enable this feature in your GameBoy ROM package. It will cause compile error. This is because the Rust-GB compiler cannot be compiled for ATMega328 target.
Required by the cargo-build-rom binary
Features from optional dependencies
In crates that don't use the dep: syntax, optional dependencies automatically become Cargo features. These features may have been created by mistake, and this functionality may be removed in the future.
- clap compiler?
-
Enables clap
Binary dependencies
- colored compiler?
- tree-sitter compiler?
-
Enables tree-sitter ^0.23.0
- tree-sitter-c compiler?
- include_dir compiler?