diff --git a/README.md b/README.md new file mode 100644 index 0000000..67f9bf3 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# libretrogd + +Rust library / mini-framework for "retro-style" games development. + +This is a not-so-serious project of mine for hobbyist game dev efforts of my own with some silly DOS-inspired +limitations built in. The major one being that graphics are limited to 256 colours, like DOS VGA mode 13h, with a +similar low-resolution. + +See the `/examples` directory for some demo apps. These will be added to over time. + +--- + +**This is FAR from finished and is not really what I'd consider "production-ready" ... and it probably won't be at any +point in the near future.** + +This project is one I started working on to help teach myself Rust and to get more comfortable working with it. As such, +there is almost certainly a lot of bad code in here! diff --git a/examples/balls/README.md b/examples/balls/README.md new file mode 100644 index 0000000..d7176ef --- /dev/null +++ b/examples/balls/README.md @@ -0,0 +1,7 @@ +# libretrogd - 'Flying Balls' Demo + +Just a silly demo. Very minimal. + +Simply do `cargo run` from this directory to try it out. + +![](screenshot.png) diff --git a/examples/balls/screenshot.png b/examples/balls/screenshot.png new file mode 100644 index 0000000..5b2a120 Binary files /dev/null and b/examples/balls/screenshot.png differ diff --git a/examples/balls_v2/README.md b/examples/balls_v2/README.md new file mode 100644 index 0000000..2c7522b --- /dev/null +++ b/examples/balls_v2/README.md @@ -0,0 +1,9 @@ +# libretrogd - 'Flying Balls' Demo v2 + +Extension of the original 'Flying Balls' demo found in this repository under `/examples/balls`. This one is re-done +with some more effects, but with the major difference being utilization of the entity, events, and states support from +libretrogd. + +Simply do `cargo run` from this directory to try it out. + +![](screenshot.png) diff --git a/examples/balls_v2/screenshot.png b/examples/balls_v2/screenshot.png new file mode 100644 index 0000000..22c2c34 Binary files /dev/null and b/examples/balls_v2/screenshot.png differ diff --git a/examples/slimed/README.md b/examples/slimed/README.md new file mode 100644 index 0000000..fdf6d3d --- /dev/null +++ b/examples/slimed/README.md @@ -0,0 +1,11 @@ +# libretrogd - 'Slime Stabbing Simulator' Demo + +A fairly more involved demo which was originally written to test out and learn how good/bad libretrogd's entity, +events and state management support is to use in practice. I learnt a lot from it, and have many ideas to improve +things now. + +**Warning! There is quite a bunch of slow/sloppy code in here!** + +Simply do `cargo run` from this directory to try it out. + +![](screenshot.png) diff --git a/examples/slimed/screenshot.png b/examples/slimed/screenshot.png new file mode 100644 index 0000000..96c98a1 Binary files /dev/null and b/examples/slimed/screenshot.png differ