Skip to content

Commit 2830f17

Browse files
committed
update readme
1 parent 6fb9d20 commit 2830f17

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
# Noble Engine Example Project
22

3-
This is a small example project that shows how to use the Noble Engine, along with a handful of libraries.
3+
This is a documented example project that shows how to use the Noble Engine, along with a handful of libraries.
44

55
![demo](demo.gif)
6+
7+
Libraries included are:
8+
9+
* [AnimatedSprite](https://github.com/Whitebrim/AnimatedSprite): Used for the player
10+
* [pdParticles](https://github.com/PossiblyAxolotl/pdParticles): Used for walking pdParticles
11+
* [Playout](https://github.com/potch/playout) - Used for the information popups in the Stats scene
12+
* [Signal](https://github.com/DidierMalenfant/Signal) - Used to notify the scene when an item is collected
13+
14+
## Notes
15+
16+
* I've created a [base scene](source/scenes/BaseScene.lua) with a some default behavior that makes it easier to interact with the system menu
17+
* The [play scene](source/scenes/Play.lua) uses sprites for the world, and most of the input is handled by the [Player](source/scripts/Player.lua) class
18+
* The [stats scene](source/scenes/Stats.lua) draws the grid in the background so it always shows up behind sprites

0 commit comments

Comments
 (0)