litecanvas 0.98.3 → 0.98.4

package/README.md

@@ -151,6 +151,98 @@ function draw() {
 }
 ```
 
+### Drawing sprites
+
+```js
+litecanvas({
+  width: 128
+})
+
+// you can create sprites with strings
+// each visible char is a pixel
+// numbers are colors
+// dots are transparent pixels
+const smile = `
+    .555555.
+    55555555
+    55055055
+    55055055
+    55555555
+    50555505
+    55000055
+    .555555.`
+
+function draw() {
+    cls(0)
+
+    spr(
+        0, 0, // position X Y
+        8, 8, // sprite Width and Height
+        smile // the pixels
+    )
+}
+```
+
+### Creating and drawing images
+
+```js
+litecanvas()
+
+// lets create the flag of the Japan
+const japan = paint(
+    48, 32, // image width and height
+    function () {
+        // the result of this drawings
+        // goes to an offscreen canvas
+        rectfill(0, 0, 48, 32, 3)
+        circfill(24, 16, 8, 4)
+    }, {
+        // you can scale your image
+        // by default, scale=1
+        scale: 4
+    }
+)
+
+function draw() {
+    cls(0)
+    // now the japan variable holds a image
+    image(W/2 - japan.width/2, H/2 - japan.height/2, japan)
+}
+```
+
+It's very useful when you need to draw something the same way every time. This way, you create an image of that drawing, working as a kind of cache.
+
+You can also use the image() function to draw PNG/JPG images, but you'll need to load them first:
+
+```js
+litecanvas()
+
+let PngImage
+
+function init() {
+    // load a image from its URL
+    const img = new Image()
+    img.onload = () => {
+        PngImage = img
+    }
+    img.src = 'https://litecanvas.js.org/icons/icon-128.png'
+}
+
+function draw() {
+    cls(0)
+
+    if (!PngImage) {
+        // if not loaded, show this message
+        text(10, 10, 'Loading image...')
+    } else {
+        // when loaded, draw the image file
+        image(0, 0, PngImage)
+    }
+}
+```
+
+To help you load multiple assets (images, fonts, music, etc.), you can I recommend you the [Asset Loader Plugin](https://github.com/litecanvas/plugin-asset-loader).
+
 ### Keyboard
 
 ```js

package/dist/dist.dev.js

@@ -32,7 +32,7 @@
   };
 
   // src/version.js
-  var version = "0.98.3";
+  var version = "0.98.4";
 
   // src/index.js
   function litecanvas(settings = {}) {
@@ -283,8 +283,8 @@
        */
       rseed(value) {
         DEV: assert(
-          null == value || isNumber(value) && value >= 0,
-          "[litecanvas] rseed() 1st param must be a positive number or zero"
+          isNumber(value) && value >= 0,
+          "[litecanvas] rseed() 1st param must be a positive integer or zero"
         );
         _rngSeed = ~~value;
       },

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "litecanvas",
-    "version": "0.98.3",
+    "version": "0.98.4",
     "description": "Lightweight HTML5 canvas 2D game engine suitable for small projects and creative coding. Inspired by PICO-8 and p5.js/Processing.",
     "license": "MIT",
     "author": "Luiz Bills <luizbills@pm.me>",

package/src/index.js

@@ -351,10 +351,9 @@ export default function litecanvas(settings = {}) {
          */
         rseed(value) {
             DEV: assert(
-                null == value || (isNumber(value) && value >= 0),
-                '[litecanvas] rseed() 1st param must be a positive number or zero'
+                isNumber(value) && value >= 0,
+                '[litecanvas] rseed() 1st param must be a positive integer or zero'
             )
-
             _rngSeed = ~~value
         },
 

package/src/version.js

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '0.98.3'
+export const version = '0.98.4'