@evitcastudio/kit 2.0.0 → 2.1.0

package/README.md

@@ -1,11 +1,6 @@
 # Kit
 
-**Kit** is a lightweight, extensible 2D framework for game development in TypeScript. Designed to be simple and modular, Kit lets you build powerful projects through a plugin-driven architecture.
-
-**Lightweight and modular**: Core functionality is minimal; plugins add power.  
-**Plugin support**: Easily extend Kit with official or third-party plugins.  
-**Event system**: Decouple functionality with a robust event-driven API.  
-**TypeScript-first**: Full TypeScript support for strong typing and modern workflows.  
+**Kit** is a lightweight, extensible 2D framework for game development in the [Vylocity Game Engine](https://www.vylocity.com/). Designed to be simple and modular, Kit lets you build powerful projects through a plugin-driven architecture.
 
 # Install
 ```bash
@@ -28,10 +23,10 @@ It is recommended to exclude this file from your version control system, as it i
 
 
 > [!IMPORTANT]
-> This API should be ran BEFORE VYLO.load() is called.
+This API should be ran BEFORE `VYLO.load()` is called.
 
 > [!WARNING]
-> Depending on your environment the following [import syntax](https://github.com/EvitcaStudio/Kit/wiki/FAQ#importing-json-resources) for json may not work.
+Depending on your environment the following [import syntax](https://github.com/EvitcaStudio/Kit/wiki/FAQ#importing-json-resources) for json may not work.
 
 
 ```js
@@ -44,11 +39,8 @@ await Kit.setResources(resourceJSON);
 ```ts
 import { Plugin } from 'custom-plugin';
 
-// Initialize an array of plugins.
-Kit.init([Plugin]);
-
 // or you can just register one plugin
-Kit.registerPlugin(Plugin);
+const plugin = Kit.registerPlugin(Plugin);
 ```
 
 # Listening for plugin events
@@ -64,4 +56,6 @@ Kit.on('Plugin', 'eventName', listener);
 
 // You can also stop listening for an event
 Kit.off('Plugin', 'eventName', listener);
-```
+```
+
+For more information check out the [wiki](https://github.com/EvitcaStudio/Kit/wiki)

package/lib/bundle/cli/cli.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 
 /*!
- * @evitcastudio/kit@2.0.0 git+https://github.com/EvitcaStudio/Kit.git
- * Compiled Wed, 08 Jan 2025 21:06:50 UTC
+ * @evitcastudio/kit@2.1.0 git+https://github.com/EvitcaStudio/Kit.git
+ * Compiled Fri, 10 Jan 2025 16:40:21 UTC
  * Copyright (c) 2025 Jared Bates, Evitca Studio, "doubleactii"
  *
  * @evitcastudio/kit is licensed under the MIT License.
@@ -2573,7 +2573,7 @@ class KitCLI {
 // package.json
 var package_default = {
   name: "@evitcastudio/kit",
-  version: "2.0.0",
+  version: "2.1.0",
   author: "doubleactii 56242467+doubleactii@users.noreply.github.com (https://evitcastudio.com)",
   main: "./lib/index.js",
   types: "./lib/index.d.ts",
@@ -2604,7 +2604,7 @@ var package_default = {
     pack: "bun pm pack --dry-run",
     "build-types": "bun tsc",
     build: "bun bun-build.ts",
-    "build-docs": "bun typedoc ./src/index.ts",
+    "build-docs": "bun typedoc",
     "build-all": "bun run build-types && bun run build && bun run build-docs"
   },
   bin: {

package/lib/kit.d.ts

@@ -16,6 +16,7 @@ export declare class Kit {
     private constructor();
     /**
      * Initialize the Kit class with plugins.
+     * @deprecated Use `registerPlugin` instead.
      * @param pPlugins - An array of plugins to initialize.
      */
     static init<T extends KitPlugin>(pPlugins: KitPluginConstructor<T>[]): void;
@@ -23,7 +24,8 @@ export declare class Kit {
      * Register a plugin with the Kit class.
      * @param pPlugin - The plugin to register.
      */
-    static registerPlugin<T extends KitPlugin>(pPlugin: KitPluginConstructor<T>): void;
+    static registerPlugin<T extends KitPlugin>(pPlugin: KitPluginConstructor<T>): T;
+    static registerPlugin<T extends KitPlugin>(pPlugin: KitPluginConstructor<T>[]): T[];
     /**
      * Gets a plugin by name.
      * @param pName - String name of the plugin to retrieve.

package/lib/kit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"kit.d.ts","sourceRoot":"","sources":["../src/kit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,KAAK,EAAgB,YAAY,EAAE,QAAQ,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAgBvG,qBAAa,GAAG;IACZ;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,OAAO,CAAiC;IACvD;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAmC;IAC1D;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,MAAM,CAAuC;IAE5D,OAAO;IAIP;;;OAGG;IACH,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,SAAS,EAAE,QAAQ,EAAE,oBAAoB,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI;IAM3E;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,SAAS,EAAE,OAAO,EAAE,oBAAoB,CAAC,CAAC,CAAC,GAAG,IAAI;IAyBlF;;;OAGG;IACH,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,SAAS,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAQnE;;OAEG;IACH,MAAM,CAAC,UAAU,IAAI,MAAM,EAAE;IAI7B;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,IAAI;IAWlB;;;;;MAKE;IACH,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,GAAG,IAAI;IAQ7E;;;;;OAKG;IACH,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,GAAG,IAAI;IAO9E;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;IAiB1B;;OAEG;WACU,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAa1F"}
+{"version":3,"file":"kit.d.ts","sourceRoot":"","sources":["../src/kit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,KAAK,EAAgB,YAAY,EAAE,QAAQ,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAgBvG,qBAAa,GAAG;IACZ;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,OAAO,CAAiC;IACvD;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAmC;IAC1D;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,MAAM,CAAuC;IAE5D,OAAO;IAIP;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,SAAS,EAAE,QAAQ,EAAE,oBAAoB,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI;IAM3E;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,SAAS,EAAE,OAAO,EAAE,oBAAoB,CAAC,CAAC,CAAC,GAAG,CAAC;IAC/E,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,SAAS,EAAE,OAAO,EAAE,oBAAoB,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE;IAsCnF;;;OAGG;IACH,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,SAAS,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAQnE;;OAEG;IACH,MAAM,CAAC,UAAU,IAAI,MAAM,EAAE;IAI7B;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,IAAI;IAWlB;;;;;MAKE;IACH,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,GAAG,IAAI;IAQ7E;;;;;OAKG;IACH,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,GAAG,IAAI;IAO9E;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;IAiB1B;;OAEG;WACU,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAa1F"}

package/lib/kit.js

@@ -29,6 +29,7 @@ export class Kit {
     }
     /**
      * Initialize the Kit class with plugins.
+     * @deprecated Use `registerPlugin` instead.
      * @param pPlugins - An array of plugins to initialize.
      */
     static init(pPlugins) {
@@ -36,27 +37,36 @@ export class Kit {
             this.registerPlugin(pPlugin);
         });
     }
-    /**
-     * Register a plugin with the Kit class.
-     * @param pPlugin - The plugin to register.
-     */
     static registerPlugin(pPlugin) {
-        const plugin = new pPlugin();
-        const pluginName = plugin.name;
-        if (!pluginName || typeof pluginName !== 'string' || !/^[a-zA-Z0-9-_]+$/.test(pluginName)) {
-            throw new Error(`[Kit] Invalid plugin name: '${pluginName}'. The name must be a non-empty string containing only alphanumeric characters, dashes, or underscores.`);
+        if (Array.isArray(pPlugin)) {
+            const plugins = [];
+            pPlugin.forEach(pPlugin => {
+                const plugin = this.registerPlugin(pPlugin);
+                if (plugin && !Array.isArray(plugin)) {
+                    plugins.push(plugin);
+                }
+            });
+            return plugins;
         }
-        if (Kit.plugins[pluginName]) {
-            throw new Error(`[Kit] plugin with name '${pluginName}' is already registered.`);
+        else {
+            const plugin = new pPlugin();
+            const pluginName = plugin.name;
+            if (!pluginName || typeof pluginName !== 'string' || !/^[a-zA-Z0-9-_]+$/.test(pluginName)) {
+                throw new Error(`[Kit] Invalid plugin name: '${pluginName}'. The name must be a non-empty string containing only alphanumeric characters, dashes, or underscores.`);
+            }
+            if (Kit.plugins[pluginName]) {
+                throw new Error(`[Kit] plugin with name '${pluginName}' is already registered.`);
+            }
+            const listener = function (pEvent) {
+                Kit.emit(pEvent);
+            };
+            const emitter = new EventEmitter(listener, plugin);
+            Kit.emitters.set(pluginName, emitter);
+            Kit.plugins[pluginName] = plugin;
+            plugin._register(emitter);
+            plugin.onRegistered();
+            return plugin;
         }
-        const listener = function (pEvent) {
-            Kit.emit(pEvent);
-        };
-        const emitter = new EventEmitter(listener, plugin);
-        Kit.emitters.set(pluginName, emitter);
-        Kit.plugins[pluginName] = plugin;
-        plugin._register(emitter);
-        plugin.onRegistered();
     }
     /**
      * Gets a plugin by name.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@evitcastudio/kit",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "author": "doubleactii 56242467+doubleactii@users.noreply.github.com (https://evitcastudio.com)",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -31,7 +31,7 @@
     "pack": "bun pm pack --dry-run",
     "build-types": "bun tsc",
     "build": "bun bun-build.ts",
-    "build-docs": "bun typedoc ./src/index.ts",
+    "build-docs": "bun typedoc",
     "build-all": "bun run build-types && bun run build && bun run build-docs"
   },
   "bin": {