move the Wrapper-Project out of the root directory and change readme and docs

This commit is contained in:
ZennDev1337 2023-08-16 12:08:25 +02:00
parent fd48cc36c5
commit 747ec6e9c9
19 changed files with 34 additions and 35 deletions

5
.gitignore vendored
View file

@ -1,5 +1,6 @@
/target /target
/.vscode /.vscode
/Wrapper-Project/.pio arduboy-rust/Wrapper-Project/.pio
/Wrapper-Project/lib/*.a arduboy-rust/Wrapper-Project/lib/*.a
arduboy-rust/Wrapper-Project/build/*.hex

4
Cargo.lock generated
View file

@ -45,14 +45,14 @@ dependencies = [
] ]
[[package]] [[package]]
name = "eeprom-byte-demo" name = "eeprom"
version = "0.1.0" version = "0.1.0"
dependencies = [ dependencies = [
"arduboy-rust", "arduboy-rust",
] ]
[[package]] [[package]]
name = "eeprom-demo" name = "eeprom-byte"
version = "0.1.0" version = "0.1.0"
dependencies = [ dependencies = [
"arduboy-rust", "arduboy-rust",

View file

@ -1,5 +1,5 @@
[package] [package]
name = "eeprom-byte-demo" name = "eeprom-byte"
version = "0.1.0" version = "0.1.0"
authors = ["ZennDev <zenndev@protonmail.com>"] authors = ["ZennDev <zenndev@protonmail.com>"]
license = "MIT OR Apache-2.0" license = "MIT OR Apache-2.0"

View file

@ -1,5 +1,5 @@
[package] [package]
name = "eeprom-demo" name = "eeprom"
version = "0.1.0" version = "0.1.0"
authors = ["ZennDev <zenndev@protonmail.com>"] authors = ["ZennDev <zenndev@protonmail.com>"]
license = "MIT OR Apache-2.0" license = "MIT OR Apache-2.0"

View file

@ -66,7 +66,7 @@ requirements:
- The Arduboy must be plugged in - The Arduboy must be plugged in
- You are in the root directory of this project - 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. All builded `.hex` files are saved inside of `arduboy-rust/Wrapper-Project/build/<GAMENAME>.hex` after you uploaded them to the Arduboy.
To upload your own game to the Arduboy use: To upload your own game to the Arduboy use:
@ -158,6 +158,7 @@ Linux:
./run demo5 ./run demo5
./run demo6 ./run demo6
./run eeprom ./run eeprom
./run eeprom-byte
./run progmem ./run progmem
./run tone ./run tone
``` ```
@ -171,6 +172,7 @@ Windows:
.\run.bat demo5 .\run.bat demo5
.\run.bat demo6 .\run.bat demo6
.\run.bat eeprom .\run.bat eeprom
.\run.bat eeprom-byte
.\run.bat progmem .\run.bat progmem
.\run.bat tone .\run.bat tone
``` ```

View file

@ -1,6 +1,6 @@
#pragma once #pragma once
#include "../../import_config.h" #include "../../../import_config.h"
#if defined(Arduboy2_Library) #if defined(Arduboy2_Library)
#include <Arduboy2.h> #include <Arduboy2.h>

4
run
View file

@ -19,10 +19,10 @@ then
cargo build -p tone --release && cp ./target/arduboy/release/libtone.a ./Wrapper-Project/lib/libgame.a && cd Wrapper-Project/ && pio run -v -t upload && cp ./.pio/build/arduboy/firmware.hex ./.pio/build/tone.hex && pio run -t clean && rm lib/libgame.a && cd .. cargo build -p tone --release && cp ./target/arduboy/release/libtone.a ./Wrapper-Project/lib/libgame.a && cd Wrapper-Project/ && pio run -v -t upload && cp ./.pio/build/arduboy/firmware.hex ./.pio/build/tone.hex && pio run -t clean && rm lib/libgame.a && cd ..
elif [ "$option" = "eeprom" ] elif [ "$option" = "eeprom" ]
then then
cargo build -p eeprom-demo --release && cp ./target/arduboy/release/libeeprom_demo.a ./Wrapper-Project/lib/libgame.a && cd Wrapper-Project/ && pio run -v -t upload && cp ./.pio/build/arduboy/firmware.hex ./.pio/build/eeprom.hex && pio run -t clean && rm lib/libgame.a && cd .. cargo build -p eeprom --release && cp ./target/arduboy/release/libeeprom.a ./Wrapper-Project/lib/libgame.a && cd Wrapper-Project/ && pio run -v -t upload && cp ./.pio/build/arduboy/firmware.hex ./.pio/build/eeprom.hex && pio run -t clean && rm lib/libgame.a && cd ..
elif [ "$option" = "eeprom-byte" ] elif [ "$option" = "eeprom-byte" ]
then then
cargo build -p eeprom-byte-demo --release && cp ./target/arduboy/release/libeeprom_byte_demo.a ./Wrapper-Project/lib/libgame.a && cd Wrapper-Project/ && pio run -v -t upload && cp ./.pio/build/arduboy/firmware.hex ./.pio/build/eeprom-byte.hex && pio run -t clean && rm lib/libgame.a && cd .. cargo build -p eeprom-byte --release && cp ./target/arduboy/release/libeeprom_byte.a ./Wrapper-Project/lib/libgame.a && cd Wrapper-Project/ && pio run -v -t upload && cp ./.pio/build/arduboy/firmware.hex ./.pio/build/eeprom-byte.hex && pio run -t clean && rm lib/libgame.a && cd ..
elif [ "$option" = "progmem" ] elif [ "$option" = "progmem" ]
then then
cargo build -p progmem --release && cp ./target/arduboy/release/libprogmem.a ./Wrapper-Project/lib/libgame.a && cd Wrapper-Project/ && pio run -v -t upload && cp ./.pio/build/arduboy/firmware.hex ./.pio/build/progmem.hex && pio run -t clean && rm lib/libgame.a && cd .. cargo build -p progmem --release && cp ./target/arduboy/release/libprogmem.a ./Wrapper-Project/lib/libgame.a && cd Wrapper-Project/ && pio run -v -t upload && cp ./.pio/build/arduboy/firmware.hex ./.pio/build/progmem.hex && pio run -t clean && rm lib/libgame.a && cd ..

46
run.bat
View file

@ -3,47 +3,43 @@
set option=%1 set option=%1
if [%option%]==[] ( if [%option%]==[] (
powershell -Command "cargo build -p game --release; cp ./target/arduboy/release/libgame.a ./Wrapper-Project/lib/libgame.a; cd Wrapper-Project/; pio run -v -t upload; cp ./.pio/build/arduboy/firmware.hex ./.pio/build/game.hex; pio run -t clean; rm lib/libgame.a; cd .." powershell -Command "cargo build -p game --release; cp ./target/arduboy/release/libgame.a ./arduboy-rust/Wrapper-Project/lib/libgame.a; cd arduboy-rust/Wrapper-Project/; pio run -v -t upload; cp ./.pio/build/arduboy/firmware.hex ./build/game.hex; pio run -t clean; rm lib/libgame.a; cd ../../"
goto :eof goto :eof
) )
if %option%==snake ( if %option%==snake (
powershell -Command "cargo build -p snake --release; cp ./target/arduboy/release/libsnake.a ./Wrapper-Project/lib/libgame.a; cd Wrapper-Project/; pio run -v -t upload; cp ./.pio/build/arduboy/firmware.hex ./.pio/build/snake.hex; pio run -t clean; rm lib/libgame.a; cd .." goto :run
goto :eof
) else if %option%==pong ( ) else if %option%==pong (
powershell -Command "cargo build -p pong --release; cp ./target/arduboy/release/libpong.a ./Wrapper-Project/lib/libgame.a; cd Wrapper-Project/; pio run -v -t upload; cp ./.pio/build/arduboy/firmware.hex ./.pio/build/pong.hex; pio run -t clean; rm lib/libgame.a; cd .." goto :run
goto :eof
) else if %option%==rustacean ( ) else if %option%==rustacean (
powershell -Command "cargo build -p rustacean --release; cp ./target/arduboy/release/librustacean.a ./Wrapper-Project/lib/libgame.a; cd Wrapper-Project/; cp ./.pio/build/arduboy/firmware.hex ./.pio/build/rustacean.hex; pio run -v -t upload; pio run -t clean; rm lib/libgame.a; cd .." goto :run
goto :eof
) else if %option%==tone ( ) else if %option%==tone (
powershell -Command "cargo build -p tone --release; cp ./target/arduboy/release/libtone.a ./Wrapper-Project/lib/libgame.a; cd Wrapper-Project/; pio run -v -t upload; cp ./.pio/build/arduboy/firmware.hex ./.pio/build/tone.hex; pio run -t clean; rm lib/libgame.a; cd .." goto :run
goto :eof
) else if %option%==eeprom ( ) else if %option%==eeprom (
powershell -Command "cargo build -p eeprom-demo --release; cp ./target/arduboy/release/libeeprom_demo.a ./Wrapper-Project/lib/libgame.a; cd Wrapper-Project/; pio run -v -t upload; cp ./.pio/build/arduboy/firmware.hex ./.pio/build/eeprom.hex; pio run -t clean; rm lib/libgame.a; cd .." goto :run
goto :eof
) else if %option%==eeprom-byte ( ) else if %option%==eeprom-byte (
powershell -Command "cargo build -p eeprom-byte-demo --release; cp ./target/arduboy/release/libeeprom_byte_demo.a ./Wrapper-Project/lib/libgame.a; cd Wrapper-Project/; pio run -v -t upload; cp ./.pio/build/arduboy/firmware.hex ./.pio/build/eeprom-byte.hex; pio run -t clean; rm lib/libgame.a; cd .." powershell -Command "cargo build -p %option% --release; cp ./target/arduboy/release/libeeprom_byte.a ./arduboy-rust/Wrapper-Project/lib/libgame.a; cd arduboy-rust/Wrapper-Project/; pio run -v -t upload; cp ./.pio/build/arduboy/firmware.hex ./build/%option%.hex; pio run -t clean; rm lib/libgame.a; cd ../../"
goto :eof goto :eof
) else if %option%==progmem ( ) else if %option%==progmem (
powershell -Command "cargo build -p progmem --release; cp ./target/arduboy/release/libprogmem.a ./Wrapper-Project/lib/libgame.a; cd Wrapper-Project/; pio run -v -t upload; cp ./.pio/build/arduboy/firmware.hex ./.pio/build/progmem.hex; pio run -t clean; rm lib/libgame.a; cd .." goto :run
goto :eof
) else if %option%==demo2 ( ) else if %option%==demo2 (
powershell -Command "cargo build -p demo2 --release; cp ./target/arduboy/release/libdemo2.a ./Wrapper-Project/lib/libgame.a; cd Wrapper-Project/; pio run -v -t upload; cp ./.pio/build/arduboy/firmware.hex ./.pio/build/demo2.hex; pio run -t clean; rm lib/libgame.a; cd .." goto :run
goto :eof
) else if %option%==demo3 ( ) else if %option%==demo3 (
powershell -Command "cargo build -p demo3 --release; cp ./target/arduboy/release/libdemo3.a ./Wrapper-Project/lib/libgame.a; cd Wrapper-Project/; pio run -v -t upload; cp ./.pio/build/arduboy/firmware.hex ./.pio/build/demo3.hex; pio run -t clean; rm lib/libgame.a; cd .." goto :run
goto :eof
) else if %option%==demo4 ( ) else if %option%==demo4 (
powershell -Command "cargo build -p demo4 --release; cp ./target/arduboy/release/libdemo4.a ./Wrapper-Project/lib/libgame.a; cd Wrapper-Project/; pio run -v -t upload; cp ./.pio/build/arduboy/firmware.hex ./.pio/build/demo4.hex; pio run -t clean; rm lib/libgame.a; cd .." goto :run
goto :eof
) else if %option%==demo5 ( ) else if %option%==demo5 (
powershell -Command "cargo build -p demo5 --release; cp ./target/arduboy/release/libdemo5.a ./Wrapper-Project/lib/libgame.a; cd Wrapper-Project/; pio run -v -t upload; cp ./.pio/build/arduboy/firmware.hex ./.pio/build/demo5.hex; pio run -t clean; rm lib/libgame.a; cd .." goto :run
goto :eof
) else if %option%==demo6 ( ) else if %option%==demo6 (
powershell -Command "cargo build -p demo6 --release; cp ./target/arduboy/release/libdemo6.a ./Wrapper-Project/lib/libgame.a; cd Wrapper-Project/; pio run -v -t upload; cp ./.pio/build/arduboy/firmware.hex ./.pio/build/demo6.hex; pio run -t clean; rm lib/libgame.a; cd .." goto :run
goto :eof ) else (
goto :help
) )
:run
powershell -Command "cargo build -p %option% --release; cp ./target/arduboy/release/lib%option%.a ./arduboy-rust/Wrapper-Project/lib/libgame.a; cd arduboy-rust/Wrapper-Project/; pio run -v -t upload; cp ./.pio/build/arduboy/firmware.hex ./build/%option%.hex; pio run -t clean; rm lib/libgame.a; cd ../../"
goto :eof
:help
@echo Usage: .\run.bat // for uploading your game @echo Usage: .\run.bat // for uploading your game
@echo Usage: .\run.bat ^<Example Game^> // for uploading an example game @echo Usage: .\run.bat ^<Example Game^> // for uploading an example game