@litecanvas/plugin-migrate 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Luiz Bills
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,25 @@
+# Migrate Plugin for Litecanvas
+
+Migrate Plugin makes this easier, by restoring the Litecanvas APIs that were removed in newer versions, and additionally shows warnings in the browser console when removed and/or deprecated APIs are used.
+
+## Install
+
+**NPM**: `npm i @litecanvas/plugin-migrate`
+
+**CDN**: `https://unpkg.com/@litecanvas/plugin-migrate/dist/dist.js`
+
+## Usage
+
+```js
+litecanvas({
+  loop: { init, draw },
+})
+
+use(pluginMigrate)
+
+function draw() {
+  clear(0) // clear() was a alias for cls()
+
+  print(0, 0, "Hello World") // print() was a alias for text()
+}
+```

package/dist/dist.js

@@ -0,0 +1,2 @@
+(()=>{var v={mute:!1};function p(a,b=v){if(a.stat(1))throw'Plugin Migrate should be loaded before the "init" event';let l=a.stat(0);function n(t,e,s=""){b.mute||console.warn(`[Migrate] warning: ${t} is removed. `+(e?`Use ${e} instead. `:"")+s)}function d(t){return n("seed()","rseed()"),t&&a.rseed(t),a.stat(9)}let c="";function h(t){n("textstyle()","the 5th param of text()"),c=t}let g=a.text;function f(t,e,s,o=3,i=c){g(t,e,s,o,i)}function w(t,e,s,o){n("print()","text()"),f(t,e,s,o)}function _(t,e){n("textmetrics()","ctx().measureText()");let s=a.ctx(),o=a.stat(10),i=a.stat(11);s.font=`${c||""} ${~~(e||o)}px ${i}`;let m=s.measureText(t);return m.height=m.actualBoundingBoxAscent+m.actualBoundingBoxDescent,m}function A(t,e,s,o){n("cliprect()","clip()");let i=a.ctx();i.beginPath(),i.rect(t,e,s,o),i.clip()}function E(t,e,s){n("clipcirc()","clip()");let o=a.ctx();o.beginPath(),o.arc(t,e,s,0,a.TWO_PI),o.clip()}function C(t){n("getcolor()","stat(5)");let e=stat(5);return e[~~t%e.length]}function T(t){n("blendmode()","ctx().globalCompositeOperation");let e=a.ctx();e.globalCompositeOperation=t}function k(t){n("clear()","cls()"),a.cls(x,y,str,t)}function M(t,e,s,o,i,m,D=!0){return n("transform()","ctx().setTransform() or ctx().transform()"),a.ctx()[D?"setTransform":"transform"](t,e,s,o,i,m)}function Y(){return n("mousepos()","MX and MY"),[MX,MY]}function S(t){n("setfps()","framerate()"),a.framerate(t)}let r=a.def;function u(t,e){switch(t){case"W":case"WIDTH":r("W",e),r("WIDTH",e);break;case"H":case"HEIGHT":r("H",e),r("HEIGHT",e);break;case"T":case"ELAPSED":r("T",e),r("ELAPSED",e);break;case"CX":case"CENTERX":r("CX",e),r("CENTERX",e);break;case"CY":case"CENTERY":r("CY",e),r("CENTERY",e);break;case"MX":case"MOUSEX":r("MX",e),r("MOUSEX",e);break;case"MY":case"MOUSEY":r("MY",e),r("MOUSEY",e);break;default:r(t,e);break}}function X(t,e){n("setvar()","_core_def()"),u(t,e)}function P(t,e){if(l.autoscale)throw"resize() don't works with autoscale enabled";n("resize()",null,"Avoid changing the canvas dimensions at runtime."),a.CANVAS.width=t,u("W",t),u("CX",t/2),a.CANVAS.height=e,u("H",e),u("CY",e/2),a.emit("resized",1)}for(let t of["W","H","T","CX","CY","MX","MY"])a[t]!=null&&u(t,a[t]);if(n("FPS","some library to measure the FPS"),r("FPS",""),l.fps&&a.framerate(l.fps),l.background>=0){let t=stat(5);a.CANVAS.style.backgroundColor=t[~~l.background%t.length]}return{def:u,seed:d,print:w,clear:k,setfps:S,setvar:X,textstyle:h,textmetrics:_,text:f,cliprect:A,clipcirc:E,blendmode:T,transform:M,getcolor:C,mousepos:Y,resize:P}}window.pluginMigrate=p;})();
+/*! pluginMigrate for litecanvas v0.0.1 by Luiz Bills | MIT Licensed */

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@litecanvas/plugin-migrate",
+  "version": "0.0.1",
+  "description": "Migrate Plugin makes this easier, by restoring the Litecanvas APIs that were removed in newer versions, and additionally shows warnings in the browser console when removed and/or deprecated APIs are used.",
+  "author": "Luiz Bills <luizbills@pm.me>",
+  "license": "MIT",
+  "homepage": "https://github.com/litecanvas/plugin-migrate",
+  "bugs": {
+    "url": "https://github.com/litecanvas/plugin-migrate/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/litecanvas/plugin-migrate.git#main"
+  },
+  "main": "src/index.js",
+  "keywords": [
+    "litecanvas"
+  ],
+  "scripts": {
+    "dev": "esbuild src/_web.js --bundle --watch --outfile=dist/dist.js --servedir=.",
+    "build": "esbuild src/_web.js --bundle --minify --outfile=dist/dist.js",
+    "prepare": "npm run build"
+  },
+  "devDependencies": {
+    "esbuild": "^0.25.5"
+  },
+  "peerDependencies": {
+    "litecanvas": "latest"
+  },
+  "files": [
+    "dist",
+    "src"
+  ]
+}

package/src/_web.js

@@ -0,0 +1,4 @@
+import plugin from "."
+
+/*! pluginMigrate for litecanvas v0.0.1 by Luiz Bills | MIT Licensed */
+window.pluginMigrate = plugin

package/src/index.js

@@ -0,0 +1,219 @@
+import "litecanvas"
+
+const defaults = {
+  mute: false,
+}
+
+/**
+ *
+ * @param {LitecanvasInstance} engine
+ * @param {object} config
+ * @returns any
+ */
+export default function plugin(engine, config = defaults) {
+  const initialized = engine.stat(1)
+
+  if (initialized) {
+    throw 'Plugin Migrate should be loaded before the "init" event'
+  }
+
+  const settings = engine.stat(0)
+
+  function warn(old, current, extra = "") {
+    if (!config.mute)
+      console.warn(
+        `[Migrate] warning: ${old} is removed. ` +
+          (current ? `Use ${current} instead. ` : "") +
+          extra
+      )
+  }
+
+  function seed(value) {
+    warn("seed()", "rseed()")
+    if (value) {
+      engine.rseed(value)
+    }
+    return engine.stat(9)
+  }
+
+  let _fontStyle = ""
+  function textstyle(value) {
+    warn("textstyle()", "the 5th param of text()")
+    _fontStyle = value
+  }
+
+  const _core_text = engine.text
+  function _text(x, y, str, color = 3, style = _fontStyle) {
+    _core_text(x, y, str, color, style)
+  }
+
+  function print(x, y, str, color) {
+    warn("print()", "text()")
+    _text(x, y, str, color)
+  }
+
+  function textmetrics(text, size) {
+    warn("textmetrics()", "ctx().measureText()")
+    const _ctx = engine.ctx()
+    const _fontSize = engine.stat(10)
+    const _fontFamily = engine.stat(11)
+    _ctx.font = `${_fontStyle || ""} ${~~(size || _fontSize)}px ${_fontFamily}`
+    const metrics = _ctx.measureText(text)
+    metrics.height =
+      metrics.actualBoundingBoxAscent + metrics.actualBoundingBoxDescent
+    return metrics
+  }
+
+  function cliprect(x, y, width, height) {
+    warn("cliprect()", "clip()")
+    const _ctx = engine.ctx()
+    _ctx.beginPath()
+    _ctx.rect(x, y, width, height)
+    _ctx.clip()
+  }
+
+  function clipcirc(x, y, radius) {
+    warn("clipcirc()", "clip()")
+    const _ctx = engine.ctx()
+    _ctx.beginPath()
+    _ctx.arc(x, y, radius, 0, engine.TWO_PI)
+    _ctx.clip()
+  }
+
+  function getcolor(index) {
+    warn("getcolor()", "stat(5)")
+    const colors = stat(5)
+    return colors[~~index % colors.length]
+  }
+
+  function blendmode(value) {
+    warn("blendmode()", "ctx().globalCompositeOperation")
+    const _ctx = engine.ctx()
+    _ctx.globalCompositeOperation = value
+  }
+
+  function clear(color) {
+    warn("clear()", "cls()")
+    engine.cls(x, y, str, color)
+  }
+
+  function transform(a, b, c, d, e, f, resetFirst = true) {
+    warn("transform()", "ctx().setTransform() or ctx().transform()")
+    const _ctx = engine.ctx()
+    return _ctx[resetFirst ? "setTransform" : "transform"](a, b, c, d, e, f)
+  }
+
+  function mousepos() {
+    warn("mousepos()", "MX and MY")
+    return [MX, MY]
+  }
+
+  function setfps(value) {
+    warn("setfps()", "framerate()")
+    engine.framerate(value)
+  }
+
+  const _core_def = engine.def
+  function _def(key, value) {
+    switch (key) {
+      case "W":
+      case "WIDTH":
+        _core_def("W", value)
+        _core_def("WIDTH", value)
+        break
+      case "H":
+      case "HEIGHT":
+        _core_def("H", value)
+        _core_def("HEIGHT", value)
+        break
+      case "T":
+      case "ELAPSED":
+        _core_def("T", value)
+        _core_def("ELAPSED", value)
+        break
+      case "CX":
+      case "CENTERX":
+        _core_def("CX", value)
+        _core_def("CENTERX", value)
+        break
+      case "CY":
+      case "CENTERY":
+        _core_def("CY", value)
+        _core_def("CENTERY", value)
+        break
+      case "MX":
+      case "MOUSEX":
+        _core_def("MX", value)
+        _core_def("MOUSEX", value)
+        break
+      case "MY":
+      case "MOUSEY":
+        _core_def("MY", value)
+        _core_def("MOUSEY", value)
+        break
+      default:
+        _core_def(key, value)
+        break
+    }
+  }
+
+  function setvar(key, value) {
+    warn("setvar()", "_core_def()")
+    _def(key, value)
+  }
+
+  function resize(width, height) {
+    if (settings.autoscale) {
+      throw "resize() don't works with autoscale enabled"
+    }
+
+    warn("resize()", null, "Avoid changing the canvas dimensions at runtime.")
+    engine.CANVAS.width = width
+    _def("W", width)
+    _def("CX", width / 2)
+
+    engine.CANVAS.height = height
+    _def("H", height)
+    _def("CY", height / 2)
+
+    engine.emit("resized", 1)
+  }
+
+  for (const key of ["W", "H", "T", "CX", "CY", "MX", "MY"]) {
+    if (null != engine[key]) {
+      _def(key, engine[key])
+    }
+  }
+
+  warn("FPS", "some library to measure the FPS")
+  _core_def("FPS", "")
+
+  if (settings.fps) {
+    engine.framerate(settings.fps)
+  }
+
+  if (settings.background >= 0) {
+    const colors = stat(5)
+    engine.CANVAS.style.backgroundColor =
+      colors[~~settings.background % colors.length]
+  }
+
+  return {
+    def: _def,
+    seed,
+    print,
+    clear,
+    setfps,
+    setvar,
+    textstyle,
+    textmetrics,
+    text: _text,
+    cliprect,
+    clipcirc,
+    blendmode,
+    transform,
+    getcolor,
+    mousepos,
+    resize,
+  }
+}