update readme, add particles and documentation

Author: GammaGames

README.md

@@ -0,0 +1,5 @@
+# Noble Engine Example Project
+
+This is a small example project that shows how to use the Noble Engine, along with a handful of libraries.
+
+![demo](demo.gif)

demo.gif

@@ -30,14 +30,15 @@ Noble.Text.FONT_NEWSLEAK_FAMILY = Graphics.font.newFamily({
 })
 
 Noble.Settings.setup({
-    playerSlot = 1
+    playerSlot = 1  -- Save which player slot is active
 })
 Noble.GameData.setup({
-    items = {}
-}, 4)
+    items = {}  -- An empty array to store the player's collected items
+}, 4)  -- Allow 4 save slots (because there are 4 skins)
 Noble.GameData.saveAll()
 
-COLLISION_LAYERS = enum({
+--
+COLLISION_LAYERS = enum({  -- Used for collision
     "PLAYER",
     "ITEM",
 })

source/main.lua

@@ -4,31 +4,29 @@ local gfx <const> = Graphics
 BaseScene = {}
 class("BaseScene").extends(NobleScene)
 
-BaseScene.backgroundColor = Graphics.kColorWhite
-
 function BaseScene:init()
     BaseScene.super.init(self)
 
-    pd.resetElapsedTime()
-    self.menu = pd.getSystemMenu()
+    pd.resetElapsedTime()  -- Reset time so each scene starts at 0
+    self.menu = pd.getSystemMenu()  -- Store this so we have access to it in all scenes
 end
 
 function BaseScene:update()
     BaseScene.super.update(self)
 
-    Particles:update()
+    Particles:update()  -- Update our particle library
 end
 
 function BaseScene:exit()
     BaseScene.super.exit(self)
-    self.menu:removeAllMenuItems()
+    self.menu:removeAllMenuItems()  -- Remove all custom menu items and reset menu image
     pd.setMenuImage(nil)
 end
 
 function BaseScene:drawBackground()
 	BaseScene.super.drawBackground(self)
 
-    if self.background ~= nil then
+    if self.background ~= nil then  -- Helper so you can set a scene's background to an image
         self.background:draw(0, 0)
     end
 end

source/scenes/BaseScene.lua

@@ -4,6 +4,9 @@ local gfx <const> = Graphics
 Player = {}
 class("Player").extends(AnimatedSprite)
 
+local particles = ParticleCircle(0, 0)
+particles:setSpread(0, 90)
+
 function Player:init(x, y, playerSlot)
     Player.super.init(self, gfx.imagetable.new("/assets/images/character"))
     self:remove() -- AnimatedSprite adds itself to the scene, we want to do that through Noble
@@ -31,9 +34,13 @@ function Player:update()
     if pd.buttonIsPressed(pd.kButtonLeft) then
         self.x_velocity = -1 * self.movement_speed
         self:changeState("left")
+        particles:moveTo(self.x, self.y + 8)
+        particles:add(1)
     elseif pd.buttonIsPressed(pd.kButtonRight) then
         self.x_velocity = 1 * self.movement_speed
         self:changeState("right")
+        particles:moveTo(self.x, self.y + 8)
+        particles:add(1)
     else
         self.x_velocity = 0
         self:changeState("idle")