https://github.com/rust-wii/ogc-rs

Rust on Nintendo Wii - A safe, idiomatic Rust wrapper for devkitPro's libogc
https://github.com/rust-wii/ogc-rs

gamedev-library homebrew powerpc rust wii

Last synced: 1 day ago
JSON representation

Rust on Nintendo Wii - A safe, idiomatic Rust wrapper for devkitPro's libogc

• Host: GitHub
• URL: https://github.com/rust-wii/ogc-rs
• Owner: rust-wii
• License: mit
• Created: 2019-06-02T21:34:35.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T12:53:36.000Z (about 2 months ago)
• Last Synced: 2024-10-29T15:20:56.431Z (about 2 months ago)
• Topics: gamedev-library, homebrew, powerpc, rust, wii
• Language: Rust
• Homepage:
• Size: 7.98 MB
• Stars: 51
• Watchers: 7
• Forks: 10
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ogc-rs

![Crates.io](https://img.shields.io/crates/v/ogc-rs)

A Rust wrapper library for devkitPro's [libogc](https://github.com/devkitPro/libogc).

To get started, you'll first need to install the following dependencies on your system:

* [Rust, along with rustup and cargo](https://www.rust-lang.org/tools/install)

* the Clang compiler

  * from your local package manager,

  * or from [LLVM themselves](https://clang.llvm.org/get_started.html)

* [devkitPro toolchain](https://devkitpro.org/wiki/Getting_Started)

Then you'll need to fork this repo and `git clone` your fork into your local machine.

When that's done, do the following:

```sh

$ cd ogc-rs

$ rustup override set nightly

$ rustup component add rust-src

$ cargo check

```

If everything's working properly, `cargo check` should run successfully.

See the [Wii testing project](https://github.com/rust-wii/testing-project) for an example on how to use this library.

## Structure

This repository is organized as follows:

* `ogc-rs`: Safe, idiomatic wrapper around `ogc-sys`.

* `ogc-sys`: Low-level, unsafe bindings to libogc.

## License

See [LICENSE](LICENSE) for more details.