♻️ Split project into engine, kit and demo

bun.lock

···
   "configVersion": 1,
   "workspaces": {
     "": {},
-    "packages/cosmic": {
-      "name": "cosmic",
+    "packages/core": {
+      "name": "@cosmic/core",
       "version": "0.1.0",
     },
-    "packages/cosmic-demo": {
-      "name": "cosmic-demo",
+    "packages/demo": {
+      "name": "@cosmic/demo",
       "version": "0.1.0",
       "dependencies": {
-        "cosmic": "workspace:*",
+        "@cosmic/core": "workspace:*",
+        "@cosmic/kit": "workspace:*",
         "vite": "^7.2.4",
       },
     },
+    "packages/kit": {
+      "name": "@cosmic/kit",
+      "version": "0.1.0",
+      "devDependencies": {
+        "@cosmic/core": "workspace:*",
+      },
+    },
   },
   "packages": {
+    "@cosmic/core": ["@cosmic/core@workspace:packages/core"],
+
+    "@cosmic/demo": ["@cosmic/demo@workspace:packages/demo"],
+
+    "@cosmic/kit": ["@cosmic/kit@workspace:packages/kit"],
+
     "@esbuild/aix-ppc64": ["@esbuild/aix-ppc64@0.25.12", "", { "os": "aix", "cpu": "ppc64" }, "sha512-Hhmwd6CInZ3dwpuGTF8fJG6yoWmsToE+vYgD4nytZVxcu1ulHpUQRAB1UJ8+N1Am3Mz4+xOByoQoSZf4D+CpkA=="],
 
     "@esbuild/android-arm": ["@esbuild/android-arm@0.25.12", "", { "os": "android", "cpu": "arm" }, "sha512-VJ+sKvNA/GE7Ccacc9Cha7bpS8nyzVv0jdVgwNDaR4gDMC/2TTRc33Ip8qrNYUcpkOHUT5OZ0bUcNNVZQ9RLlg=="],
···
     "@rollup/rollup-win32-x64-msvc": ["@rollup/rollup-win32-x64-msvc@4.53.3", "", { "os": "win32", "cpu": "x64" }, "sha512-UhTd8u31dXadv0MopwGgNOBpUVROFKWVQgAg5N1ESyCz8AuBcMqm4AuTjrwgQKGDfoFuz02EuMRHQIw/frmYKQ=="],
 
     "@types/estree": ["@types/estree@1.0.8", "", {}, "sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w=="],
-
-    "cosmic": ["cosmic@workspace:packages/cosmic"],
-
-    "cosmic-demo": ["cosmic-demo@workspace:packages/cosmic-demo"],
 
     "esbuild": ["esbuild@0.25.12", "", { "optionalDependencies": { "@esbuild/aix-ppc64": "0.25.12", "@esbuild/android-arm": "0.25.12", "@esbuild/android-arm64": "0.25.12", "@esbuild/android-x64": "0.25.12", "@esbuild/darwin-arm64": "0.25.12", "@esbuild/darwin-x64": "0.25.12", "@esbuild/freebsd-arm64": "0.25.12", "@esbuild/freebsd-x64": "0.25.12", "@esbuild/linux-arm": "0.25.12", "@esbuild/linux-arm64": "0.25.12", "@esbuild/linux-ia32": "0.25.12", "@esbuild/linux-loong64": "0.25.12", "@esbuild/linux-mips64el": "0.25.12", "@esbuild/linux-ppc64": "0.25.12", "@esbuild/linux-riscv64": "0.25.12", "@esbuild/linux-s390x": "0.25.12", "@esbuild/linux-x64": "0.25.12", "@esbuild/netbsd-arm64": "0.25.12", "@esbuild/netbsd-x64": "0.25.12", "@esbuild/openbsd-arm64": "0.25.12", "@esbuild/openbsd-x64": "0.25.12", "@esbuild/openharmony-arm64": "0.25.12", "@esbuild/sunos-x64": "0.25.12", "@esbuild/win32-arm64": "0.25.12", "@esbuild/win32-ia32": "0.25.12", "@esbuild/win32-x64": "0.25.12" }, "bin": { "esbuild": "bin/esbuild" } }, "sha512-bbPBYYrtZbkt6Os6FiTLCTFxvq4tt3JKall1vRwshA3fdVztsLAatFaZobhkBC8/BrPetoa0oksYoKXoG4ryJg=="],
 

package.json

···
       "email": "[e-mail]",
       "url": "https://thevoid.cafe"
     }
-  ]
+  ],
+  "scripts": {
+    "dev": "cd packages/demo && bun dev"
+  }
 }

packages/cosmic-demo/package.json packages/demo/package.json

···
 {
-  "name": "cosmic-demo",
+  "name": "@cosmic/demo",
   "version": "0.1.0",
   "description": "Simple demo of the cosmic engine.",
   "module": "src/index.ts",
···
   },
   "dependencies": {
     "vite": "^7.2.4",
-    "cosmic": "workspace:*"
+    "@cosmic/core": "workspace:*",
+    "@cosmic/kit": "workspace:*"
   }
 }

packages/cosmic-demo/src/components/Transform.ts packages/kit/src/components/Transform.ts

···
-import { TILE_SIZE } from "../constants";
+const TILE_SIZE = 32;
 
 export class Transform {
 	constructor(

packages/cosmic-demo/src/index.ts packages/demo/src/index.ts

···
-import { Cosmic, CosmicMode, Entity } from 'cosmic';
+import { Cosmic, CosmicMode, Entity } from '@cosmic/core';
+import { Transform, Collider, WorldProperties, Renderable, Physics, PlayerControlled } from '@cosmic/kit/components';
+import { RenderingSystem, PhysicsSystem, CollisionSystem, PlayerControlSystem } from '@cosmic/kit/systems';
 
 import { TILE_SIZE } from './constants';
-import { PhysicsSystem } from './systems/PhysicsSystem';
-import { CollisionSystem } from './systems/CollisionSystem';
-import { RenderingSystem } from './systems/RenderingSystem';
-import { WorldProperties } from './components/WorldProperties';
-import { PlayerControlSystem } from './systems/PlayerControlSystem';
-
-import { Physics } from './components/Physics';
-import { Collider } from './components/Collider';
-import { Transform } from './components/Transform';
-import { Renderable } from './components/Renderable';
-import { PlayerControlled } from './components/PlayerControlled';
 
 const engine = Cosmic.getInstance(CosmicMode.DEVELOPMENT);
 

packages/cosmic-demo/src/systems/CollisionSystem.ts packages/kit/src/systems/CollisionSystem.ts

···
-import { Entity, System } from "cosmic";
-import { Collider } from "../components/Collider";
-import { Transform } from "../components/Transform";
+import { Entity, System } from "@cosmic/core";
+import { Transform, Collider } from "@cosmic/kit/components";
 
 export class CollisionSystem extends System {
   public readonly requiredComponents = new Set([

packages/cosmic-demo/src/systems/PhysicsSystem.ts packages/kit/src/systems/PhysicsSystem.ts

···
-import { Entity, System, type Cosmic } from "cosmic";
-import { WorldProperties } from "../components/WorldProperties";
-import { Transform } from "../components/Transform";
-import { Physics } from "../components/Physics";
+import { Entity, System, type Cosmic } from "@cosmic/core";
+import { Transform, WorldProperties, Physics } from "@cosmic/kit/components";
 
 export class PhysicsSystem extends System {
 	public requiredComponents = new Set([Transform.name, Physics.name, WorldProperties.name]);

packages/cosmic-demo/src/systems/PlayerControlSystem.ts packages/kit/src/systems/PlayerControlSystem.ts

···
-import { Cosmic, System, Entity } from "cosmic";
-import { Transform } from "../components/Transform";
-import { PlayerControlled } from "../components/PlayerControlled";
+import { Cosmic, System, Entity } from "@cosmic/core";
+import { Transform, PlayerControlled } from "@cosmic/kit/components";
 
 export class PlayerControlSystem extends System {
 	public requiredComponents = new Set([Transform.name, PlayerControlled.name]);

packages/cosmic-demo/src/systems/RenderingSystem.ts packages/kit/src/systems/RenderingSystem.ts

···
-import { Entity, System, type Cosmic } from "cosmic";
-import { Transform } from "../components/Transform";
-import { Renderable } from "../components/Renderable";
+import { Entity, System, type Cosmic } from "@cosmic/core";
+import { Transform, Renderable } from "@cosmic/kit/components";
 
 export class RenderingSystem extends System {
 	public requiredComponents = new Set([Transform.name, Renderable.name]);

packages/cosmic/package.json packages/core/package.json

···
 {
-  "name": "cosmic",
+  "name": "@cosmic/core",
   "version": "0.1.0",
   "description": "Experimental canvas 2D engine for tile-based sidescrolling/sandbox games, created strictly for educational purposes.",
   "module": "src/index.ts",

packages/cosmic/src/core/Cosmic.ts packages/core/src/core/Cosmic.ts

···
-import { System, Entity } from "./EntityComponentSystem";
-import { InputManager } from "./InputManager";
+import { System, Entity, InputManager } from "@cosmic/core";
 
+/**
+ * Enum representing the different modes in which the Cosmic engine can operate.
+ */
 export enum CosmicMode {
+  /** Enables debugging features and logs additional information. */
 	DEVELOPMENT,
+
+	/** Enables production mode, which optimizes performance and disables debugging features. */
 	PRODUCTION,
 }
 
···
 	// Definitions related to our ECS and input management
 	private systems: System[] = [];
 	private entities: Entity[] = [];
+	private stores = new Map<string, Map<any, any>>();
 	public readonly input: InputManager;
 
+	/**
+    * Initializes the Cosmic engine and all necessary support structures in the specified mode.
+    * @param mode - The mode in which the Cosmic engine should operate.
+    */
 	private constructor(mode: CosmicMode) {
 		this.mode = mode;
 
···
 		window.addEventListener('resize', () => this.handleResize());
 	}
 
+	/**
+	 * Starts the game loop and performs any necessary state changes.
+	 */
 	public start(): void {
 		if (!this.isRunning) {
 			this.isRunning = true;
···
 		}
 	}
 
+	/**
+	 * Stops the game loop and performs any necessary cleanup.
+	 */
 	public stop(): void {
 		this.isRunning = false;
 	}
 
+	/**
+	 * Executes any relevant engine logic, keeps track of delta time and initiates ECS updates.
+	 * @param currentTime The current time in milliseconds.
+	 */
 	private gameLoop(currentTime: number): void {
 		if (!this.isRunning) return;
 
···
 		requestAnimationFrame((time) => this.gameLoop(time));
 	}
 
+	/**
+	 * Executes the update method for all systems registered in Cosmic's Entity Component System.
+	 */
 	private update(deltaTime: number) {
 		// Runs through all systems registered in our ECS,
-		// and updates each one with a list of relevant entities,
-		// e.g. a PlayerControlled component may be required to control NPCs,
-		// which is handled by an NpcControlSystem, and so on...
+		// and updates each one with a list of relevant entities.
 		for (const system of this.systems) {
 			const relevantEntities = this.entities.filter(entity =>
 				Array.from(system.requiredComponents).every(name =>
···
 		if (this.mode === CosmicMode.DEVELOPMENT) this.calculateFps(deltaTime);
 	}
 
+	/**
+	 * Adds an entity to Cosmic's Entity Component System.
+	 */
 	public addEntity(entity: Entity) {
 		this.entities.push(entity);
 	}
 
+	/**
+	 * Adds a system to Cosmic's Entity Component System.
+	 */
 	public addSystem(system: System) {
 		this.systems.push(system);
 	}
 
+	/**
+	 * Calculates the FPS and updates the GUI context with the results.
+	 */
 	private calculateFps(deltaTime: number) {
 		const fps = 1 / deltaTime;
 
···
 		}
 	}
 
+	/**
+	 * Handles resize events on all relevant canvases
+	 * by applying the updated device pixel ratio to them.
+	 */
 	private handleResize(): void {
 		const { devicePixelRatio = 1 } = window;
 		const width = window.innerWidth;
···
 		this.guiCanvas.style.height = `${height}px`;
 	}
 
-	public getContext() {
+	/**
+	 * Returns the requested store.
+	 *
+	 * @param name - The name of the store to retrieve.
+	 */
+	public getStore<K = any, V = any>(name: string): Map<K, V> {
+    let store = this.stores.get(name);
+
+    if (!store) {
+      store = new Map<K, V>();
+      this.stores.set(name, store);
+    }
+
+    return store;
+	}
+
+	/**
+	 * Returns the canvas 2D context.
+	 */
+	public getContext(): CanvasRenderingContext2D {
 		return this.context;
 	}
 
+	/**
+	 * Returns an instance of Cosmic.
+	 *
+	 * @param mode - This defines the mode of Cosmic, if a new instance is created.
+	 */
 	public static getInstance(mode: CosmicMode = CosmicMode.PRODUCTION): Cosmic {
 		if (!Cosmic.instance) {
 			Cosmic.instance = new Cosmic(mode);

packages/kit/package.json

···
+{
+  "name": "@cosmic/kit",
+  "version": "0.1.0",
+  "description": "Collection of components, systems and helpers to aid developers of games using the Cosmic engine.",
+  "exports": {
+    "./components": {
+      "import": "./src/components.ts",
+      "require": "./src/components.cjs"
+    },
+    "./systems": {
+      "import": "./src/systems.ts",
+      "require": "./src/systems.cjs"
+    }
+  },
+  "devDependencies": {
+    "@cosmic/core": "workspace:*"
+  }
+}

packages/kit/src/components.ts

···
+export * from "./components/Transform";
+export * from "./components/Collider";
+export * from "./components/Physics";
+export * from "./components/Renderable";
+export * from "./components/PlayerControlled";
+export * from "./components/WorldProperties";

packages/kit/src/systems.ts

···
+export * from "./systems/RenderingSystem";
+export * from "./systems/PhysicsSystem";
+export * from "./systems/CollisionSystem";
+export * from "./systems/PlayerControlSystem";