add READMEs and screenshots for examples

This commit is contained in:
Gered 2022-05-23 17:44:16 -04:00
parent 1ab1d8e0ad
commit 4f3928cf56
7 changed files with 44 additions and 0 deletions

17
README.md Normal file
View file

@ -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!

7
examples/balls/README.md Normal file
View file

@ -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)

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

View file

@ -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)

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

11
examples/slimed/README.md Normal file
View file

@ -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)

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB