6.4 KiB
Rust for Arduboy
Running Rust on the Arduboy miniature game system.
The most important first. I didn't create this project from scratch, @Seeker14491 the legend has already done a lot in his old project ArduboyRust
I just updated and completed the project.
What do i mean by completed?
I provided all the important functions from the Arduboy2 library in a safe Rust API.
Most of the Arduboy2 funktions can be called the same way like in C.
How to use this Project
First clone the repo
git clone https://github.com/ZennDev1337/Rust-for-Arduboy
Install PlatformIO Core on your system. I recommend the pip install if you don't want to configure a new path variable for pio. Otherwise you will know how to do that.
The rust-analyzer will complain about a missing test crate to fix this add the following rule to the lsp settings :
{
"rust-analyzer.checkOnSave.allTargets": false
}
If your using Visual Studio Code: Create a folder named .vscode and a file named settings.json inside. Past the setting above in the new file. (I have excluded my .vscode folder because I have many different settings there that you don't need)
Your game is located in the Project/game folder. This is also the folder you are working in
Inside the game folder you will find a lib.rs file which contains the setup and loop function as you know it from a normal Arduboy C project.
You can use the following command to open the Rust doc of the arduboy_rust crate
cargo doc -p arduboy_rust --open
Most of the time you will use the prelude. There is listed witch funktionality you will have.
And last but not least there are multiple examples inside of the Examples folder which shows you how to use the functions. I will from time to time also upload my projects to the Example folder so you have as much ressurces as possible.
Usage of the run tool
Both run scripts (only works if you use the given folder structure)
requirements:
- PlatformIO Core must be installed
- The Arduboy must be plugged in
- You are in the root directory of this project
All builded .hex files are saved inside of Wrapper-Project/.pio/build/<GAMENAME>.hex after you uploaded them to the Arduboy.
To upload your own game to the Arduboy use:
Linux:
./run
Windows:
.\run.bat
Play the examples
Snake
To upload snake to the Arduboy use:
Linux:
./run snake
Windows:
.\run.bat snake
Pong
To upload pong to the Arduboy use:
Linux:
./run pong
Windows:
.\run.bat pong
I'm now a Rustacean <3
To upload rustacean to the Arduboy use:
Linux:
./run rustacean
Windows:
.\run.bat rustacean
The demo games / tutorials from the official Arduboy forum [Rewritten in Rust]
- Make Your Own Arduboy Game: Part 1 - Setting Up Your Computer
- [demo2] Make Your Own Arduboy Game: Part 2 - Printing Text
- [demo3] Make Your Own Arduboy Game: Part 3 - Storing Data & Loops
- [demo4] Make Your Own Arduboy Game: Part 4 - Questions & Button Input
- [demo5] Make Your Own Arduboy Game: Part 5 - Your First Game!
- [demo6] Make Your Own Arduboy Game: Part 6 - Graphics! Link for the arduboy-tile-converter
- not done [demo7] Make Your Own Arduboy Game: Part 7 - Make Pong From Scratch!
- not done [demo8] Make Your Own Arduboy Game: Part 8 - Starting DinoSmasher
- [eeprom] Help, I’m struggling with EEPROM!
- [tone] ArduboyTonesTest
To upload a demo to the Arduboy use:
Linux:
./run demo2
./run demo3
./run demo4
./run demo5
./run demo6
./run eeprom
./run tone
Windows:
.\run.bat demo2
.\run.bat demo3
.\run.bat demo4
.\run.bat demo5
.\run.bat demo6
.\run.bat eeprom
.\run.bat tone
Creating and building an Arduboy crate [Outdated]
You can find instructions on how all build steps work in detail here ArduboyRust creating and building an arduboy crate
Linking the static library to the Arduino C++ project [Outdated]
Instructions on how to link all the static libraries in the Arduino C++ project can be found here ArduboyRust linking the static library to the arduino c++ project
Credits
Thanks to @Seeker14491 who wrote ArduboyRust, the starting point for me to create my own project based on this project. (you are a hero <3)
Thanks to @simon-i1-h who wrote arduboy-hello-rs, the proof of concept that inspired me to try Rust on the Arduboy.
License
You can license it under either one of those licenses:
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
Whichever you may prefer.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.