@vylos/cli 0.3.0 → 0.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vylos/cli",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/DevOpsBenjamin/Vylos"
@@ -17,7 +17,7 @@
     "tailwindcss": "^4.0.0",
     "@tailwindcss/vite": "^4.0.0",
     "tsx": "^4.19.2",
-    "@vylos/core": "0.3.0"
+    "@vylos/core": "0.4.1"
   },
   "devDependencies": {
     "typescript": "^5.7.2"

package/src/commands/build.ts

@@ -5,12 +5,17 @@ import { viteSingleFile } from 'vite-plugin-singlefile';
 import { resolve } from 'path';
 import { vylosProjectPlugin } from '../vite/projectPlugin';
 import { vylosI18nPlugin } from '../vite/i18nPlugin';
+import { resolveGameAlias } from '../utils/resolveGameAlias';
 
 export async function build(projectRoot: string, base?: string) {
   console.log(`\n  Vylos building...\n  Project: ${projectRoot}\n`);
 
   const outDir = resolve(projectRoot, 'dist');
 
+  const alias: Record<string, string> = { '@project': projectRoot };
+  const gamePlugin = resolveGameAlias(projectRoot);
+  if (gamePlugin) alias['@game'] = gamePlugin;
+
   await viteBuild({
     root: projectRoot,
     base: base ?? '/',
@@ -22,9 +27,7 @@ export async function build(projectRoot: string, base?: string) {
       viteSingleFile(),
     ],
     resolve: {
-      alias: {
-        '@project': projectRoot,
-      },
+      alias,
     },
     build: {
       outDir,

package/src/commands/create.ts

@@ -1,7 +1,9 @@
 import { resolve, dirname } from 'path';
-import { existsSync, mkdirSync, cpSync, readFileSync, writeFileSync } from 'fs';
+import { existsSync, mkdirSync, cpSync, readFileSync, writeFileSync, renameSync } from 'fs';
 import { fileURLToPath } from 'url';
 
+const TEMPLATE_PLUGIN_NAME = 'my-vylos-game';
+
 export async function create(name: string, targetDir?: string) {
   const dest = resolve(targetDir ?? process.cwd(), name);
 
@@ -24,6 +26,13 @@ export async function create(name: string, targetDir?: string) {
   mkdirSync(dest, { recursive: true });
   cpSync(templateDir, dest, { recursive: true });
 
+  // Rename plugins/my-vylos-game → plugins/<name>
+  const oldPluginDir = resolve(dest, 'plugins', TEMPLATE_PLUGIN_NAME);
+  const newPluginDir = resolve(dest, 'plugins', name);
+  if (existsSync(oldPluginDir)) {
+    renameSync(oldPluginDir, newPluginDir);
+  }
+
   // Replace project name in package.json
   const pkgPath = resolve(dest, 'package.json');
   if (existsSync(pkgPath)) {
@@ -31,6 +40,13 @@ export async function create(name: string, targetDir?: string) {
     writeFileSync(pkgPath, pkg.replace('"my-vylos-game"', `"${name}"`));
   }
 
+  // Update @game alias in tsconfig.json to point to the renamed plugin
+  const tsconfigPath = resolve(dest, 'tsconfig.json');
+  if (existsSync(tsconfigPath)) {
+    const tsconfig = readFileSync(tsconfigPath, 'utf-8');
+    writeFileSync(tsconfigPath, tsconfig.replaceAll(TEMPLATE_PLUGIN_NAME, name));
+  }
+
   console.log(`  Project created at: ${dest}`);
   console.log(`\n  Next steps:`);
   console.log(`    cd ${name}`);

package/src/commands/dev.ts

@@ -5,10 +5,15 @@ import { resolve } from 'path';
 import { vylosProjectPlugin } from '../vite/projectPlugin';
 import { vylosI18nPlugin } from '../vite/i18nPlugin';
 import { vylosEditorApiPlugin } from '../vite/editorApiPlugin';
+import { resolveGameAlias } from '../utils/resolveGameAlias';
 
 export async function dev(projectRoot: string) {
   console.log(`\n  Vylos dev server starting...\n  Project: ${projectRoot}\n`);
 
+  const alias: Record<string, string> = { '@project': projectRoot };
+  const gamePlugin = resolveGameAlias(projectRoot);
+  if (gamePlugin) alias['@game'] = gamePlugin;
+
   const server = await createServer({
     root: projectRoot,
     plugins: [
@@ -19,9 +24,7 @@ export async function dev(projectRoot: string) {
       vylosEditorApiPlugin(),
     ],
     resolve: {
-      alias: {
-        '@project': projectRoot,
-      },
+      alias,
       dedupe: ['vue', 'pinia'],
     },
     optimizeDeps: {

package/src/utils/resolveGameAlias.ts

@@ -0,0 +1,17 @@
+import { resolve } from 'path';
+import { existsSync, readdirSync, statSync } from 'fs';
+
+/**
+ * Scans `plugins/` for the first subdirectory and returns its absolute path.
+ * Returns null if no plugins directory or no subdirectory exists.
+ */
+export function resolveGameAlias(projectRoot: string): string | null {
+  const pluginsDir = resolve(projectRoot, 'plugins');
+  if (!existsSync(pluginsDir)) return null;
+
+  const dirs = readdirSync(pluginsDir).filter(f =>
+    statSync(resolve(pluginsDir, f)).isDirectory(),
+  );
+
+  return dirs.length > 0 ? resolve(pluginsDir, dirs[0]) : null;
+}

package/templates/.gitattributes

@@ -0,0 +1,8 @@
+*.png filter=lfs diff=lfs merge=lfs -text
+*.jpg filter=lfs diff=lfs merge=lfs -text
+*.jpeg filter=lfs diff=lfs merge=lfs -text
+*.webp filter=lfs diff=lfs merge=lfs -text
+*.mp4 filter=lfs diff=lfs merge=lfs -text
+*.webm filter=lfs diff=lfs merge=lfs -text
+*.ogg filter=lfs diff=lfs merge=lfs -text
+*.mp3 filter=lfs diff=lfs merge=lfs -text

package/templates/global/actions/wait.ts

@@ -1,9 +1,10 @@
-import type { VylosAction, BaseGameState } from '@vylos/core';
+import type { VylosAction } from '@vylos/core';
+import type { GameState } from '@game';
 
-const wait: VylosAction = {
+const wait: VylosAction<GameState> = {
   id: 'wait',
   label: 'Wait 1 Hour',
-  execute(state: BaseGameState) {
+  execute(state: GameState) {
     state.gameTime += 1;
   },
 };

package/templates/global/events/intro.ts

@@ -1,10 +1,12 @@
-import type { VylosEvent, VylosAPI, BaseGameState } from '@vylos/core';
+import type { VylosEvent, VylosAPI } from '@vylos/core';
+import type { GameState } from '@game';
+import { narrator } from '@game';
 
-const intro: VylosEvent = {
+const intro: VylosEvent<GameState> = {
   id: 'intro',
   conditions: (state) => !state.flags['intro_done'],
-  async execute(engine: VylosAPI, state: BaseGameState) {
-    await engine.say('Welcome to your Vylos game!');
+  async execute(engine: VylosAPI, state: GameState) {
+    await engine.say('Welcome to your Vylos game!', { from: narrator });
     await engine.say('This is a starter template. Edit the events to build your story.');
 
     const pick = await engine.choice([

package/templates/main.ts

@@ -6,7 +6,6 @@ import {
   GameShell,
   createEngine,
   useEngineStateStore,
-  useGameStateStore,
   ENGINE_INJECT_KEY,
   CONFIG_INJECT_KEY,
   EnginePhase,
@@ -14,8 +13,10 @@ import {
   ActionManager,
   type EventRunnerCallbacks,
   type TextEntry,
+  type VylosCharacter,
 } from '@vylos/core';
 import config from './vylos.config';
+import { useGameStore } from '@game';
 
 // Locations
 import home from './locations/home/location';
@@ -31,7 +32,7 @@ const pinia = createPinia();
 app.use(pinia);
 
 const engineState = useEngineStateStore(pinia);
-const gameState = useGameStateStore(pinia);
+const gameState = useGameStore(pinia);
 
 // Location manager
 const locationManager = new LocationManager();
@@ -42,7 +43,7 @@ const actionManager = new ActionManager();
 actionManager.registerAll([wait]);
 
 const callbacks: EventRunnerCallbacks = {
-  onSay(text, speaker) {
+  onSay(text: string, speaker: VylosCharacter | null) {
     engineState.setDialogue({ text, speaker, isNarration: !speaker });
   },
   onChoice(options) {

package/templates/package.json

@@ -8,8 +8,8 @@
     "build": "vylos build"
   },
   "dependencies": {
-    "@vylos/core": "^0.2.1",
-    "@vylos/cli": "^0.2.1",
+    "@vylos/core": "^0.4.0",
+    "@vylos/cli": "^0.4.0",
     "vue": "^3.5.13",
     "pinia": "^2.3.0",
     "reflect-metadata": "^0.2.2",

package/templates/plugins/my-vylos-game/characters.ts

@@ -0,0 +1,9 @@
+import type { VylosCharacter } from '@vylos/core';
+
+/** Extend VylosCharacter with your project-specific fields */
+export interface Character extends VylosCharacter {
+  // portrait?: string;
+  // role?: string;
+}
+
+export const narrator: Character = { id: 'narrator', name: 'Narrator' };

package/templates/plugins/my-vylos-game/gameState.ts

@@ -0,0 +1,39 @@
+import { defineStore } from 'pinia';
+import { ref } from 'vue';
+import type { VylosGameState } from '@vylos/core';
+import { deepMerge } from '@vylos/core';
+import { type Player, createPlayer } from './player';
+
+/** Your game state — extends VylosGameState with your own fields */
+export interface GameState extends VylosGameState {
+  player: Player;
+}
+
+export function createState(): GameState {
+  return {
+    locationId: '',
+    gameTime: 8,
+    flags: {},
+    counters: {},
+    player: createPlayer(),
+    inventories: {},
+  };
+}
+
+export const useGameStore = defineStore('gameState', () => {
+  const state = ref<GameState>(createState());
+
+  function getState(): GameState {
+    return state.value;
+  }
+
+  function setState(newState: Partial<GameState>) {
+    state.value = deepMerge(createState(), newState) as GameState;
+  }
+
+  function $reset() {
+    state.value = createState();
+  }
+
+  return { state, getState, setState, $reset };
+});

package/templates/plugins/my-vylos-game/index.ts

@@ -0,0 +1,3 @@
+export * from './gameState';
+export * from './characters';
+export * from './player';

package/templates/plugins/my-vylos-game/player.ts

@@ -0,0 +1,16 @@
+import type { Character } from './characters';
+
+/** Extend Character with your player-specific fields */
+export interface Player extends Character {
+  // health: number;
+  // gold: number;
+}
+
+export function createPlayer(): Player {
+  return {
+    id: 'player',
+    name: 'Player',
+    // health: 100,
+    // gold: 0,
+  };
+}

package/templates/tsconfig.json

@@ -13,7 +13,11 @@
     "jsx": "preserve",
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true,
-    "baseUrl": "."
+    "baseUrl": ".",
+    "paths": {
+      "@game": ["./plugins/my-vylos-game"],
+      "@game/*": ["./plugins/my-vylos-game/*"]
+    }
   },
   "include": ["./**/*.ts", "./**/*.vue", "./env.d.ts"],
   "exclude": ["node_modules", "dist"]