@evitcastudio/kit 2.1.2 → 2.2.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Jared Bates, Evitca Studio, "doubleactii"
-
-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.
+MIT License
+
+Copyright (c) 2024 Jared Bates, Evitca Studio, "doubleactii"
+
+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

@@ -1,60 +1,61 @@
-# Kit
-
-**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
-npm i @evitcastudio/kit -g
-```
-
-*global flag is so the path is set properly for the CLI tool*
-
-# Resources
-
-This script will locate all Vylocity engine-related files within the specified directory and anonymize them before placing them in the designated resources folder.
-
-```bash
-# From the CLI you will build all your resources to the out dir
-kit build -i ./<in-dir> -o ./<out-dir>
-```
-
-During the execution of this command, a `resource.json` file will be automatically generated within your source directory.
-It is recommended to exclude this file from your version control system, as it is considered a build artifact.
-
-
-> [!IMPORTANT]
-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.
-
-
-```js
-import resourceJSON from 'resource.json';
-await Kit.setResources(resourceJSON);
-```
-
-# Using Kit with plugins
-
-```ts
-import { Plugin } from 'custom-plugin';
-
-const plugin = Kit.registerPlugin(Plugin);
-```
-
-# Listening for plugin events
-
-```js
-const listener = (pEvent: EmitterEvent) => {
-    const { data, timestamp } = pEvent;
-    // Here you can use the data that the event sent down.
-}
-
-// Here you listen for an event from the plugin: `Plugin`, under the event name of `eventName`
-Kit.on('Plugin', 'eventName', listener);
-
-// You can also stop listening for an event
-Kit.off('Plugin', 'eventName', listener);
-```
-
+# Kit
+
+**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 empowers developers to build complex projects quickly through a robust plugin-driven architecture.
+
+## Installation
+
+```bash
+npm install -g @evitcastudio/kit
+```
+> **Note:** The `-g` flag ensures the `kit` CLI tool is globally available in your PATH.
+
+## CLI Core Commands
+
+The `kit build` command locates all Vylocity engine-related resources in your source directory, anonymizes them, and moves them to a deploy-ready output directory.
+
+```bash
+kit build -i ./<in-dir> -o ./<out-dir>
+```
+
+Executing this command automatically generates a `resource.json` map in your input directory. 
+**Best Practice:** Exclude `resource.json` from version control (`.gitignore`), as it is an ephemeral build artifact.
+
+## Runtime Resource Loading
+
+> [!IMPORTANT]
+> `Kit.setResources()` should be called **before** `VYLO.load()`.
+
+> [!WARNING]
+> Depending on your build environment (e.g., webpack, vite, or bun), you may need specific loaders or assertions to import JSON natively.
+
+```typescript
+import resourceJSON from './resource.json';
+
+// Initialize the engine with mapped resources
+await Kit.setResources(resourceJSON);
+```
+
+## Plugin Architecture
+
+```ts
+import { Plugin } from 'custom-plugin';
+
+const plugin = Kit.registerPlugin(Plugin);
+```
+
+# Listening for plugin events
+
+```js
+const listener = (pEvent: EmitterEvent) => {
+    const { data, timestamp } = pEvent;
+    // Here you can use the data that the event sent down.
+}
+
+// Here you listen for an event from the plugin: `Plugin`, under the event name of `eventName`
+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)