@v12-engine/create 0.1.0 → 0.4.0

package/starters/melee/src/melee/view/undeadLooks.ts

@@ -3,6 +3,7 @@ import { Color3 } from '@babylonjs/core/Maths/math.color.js'
 import { CreateCylinder } from '@babylonjs/core/Meshes/Builders/cylinderBuilder.js'
 import type { AbilityLooks, ModelDef, ShotContext, ShotDrawing, UnitLooks } from '@v12-engine/client'
 import { building } from './buildings'
+import { DUAL_WIELD, ONE_HANDED } from './attacks'
 
 /*
  * How the Restless looks (features-plan C4): the shared art's skeletons with their own gear, and its Fantasy RTS
@@ -68,7 +69,7 @@ export const undeadLooks: UnitLooks = {
 		blood: false,
 		height: 1.5,
 		model: skeleton('characters/skeleton_minion.glb', 0.6, 'skeleton-gear/staff.glb'),
-		parts: [
+		shapes: [
 			...bones(1.5),
 			{ shape: 'sphere', size: [0.42, 0.36, 0.42], offset: [0, 0.75, -0.34], color: GOLD, carrying: 'gold' },
 			{ shape: 'cylinder', size: [0.22, 0.9, 0.22], offset: [0, 0.8, -0.34], color: WOOD, tilt: Math.PI / 2, turn: Math.PI / 2, carrying: 'lumber' }
@@ -78,9 +79,10 @@ export const undeadLooks: UnitLooks = {
 		blood: false,
 		height: 1.6,
 		model: skeleton('characters/skeleton_minion.glb', 0.68, 'skeleton-gear/blade.glb', 'skeleton-gear/blade.glb'),
+		attacks: [DUAL_WIELD],
 		// packs of them: drawn as copies of one mesh, their animations baked (S41)
 		baked: true,
-		parts: bones(1.6)
+		shapes: bones(1.6)
 	},
 	cryptCrawler: {
 		blood: false,
@@ -88,23 +90,24 @@ export const undeadLooks: UnitLooks = {
 		model: {
 			...skeleton('characters/skeleton_rogue.glb', 0.75, 'skeleton-gear/crossbow.glb'),
 			animations: { attack: 'Ranged_2H_Shoot' },
-			hitAt: 0.3
+			clips: { Ranged_2H_Shoot: { marks: [{ name: 'hit', at: 0.3 }] } }
 		},
 		shot: { color: [0.55, 0.85, 0.45], size: 0.25 },
-		parts: bones(1.7)
+		shapes: bones(1.7)
 	},
 	abomination: {
 		blood: false,
 		height: 2.6,
 		model: skeleton('characters/skeleton_warrior.glb', 1.2, 'skeleton-gear/axe.glb', 'skeleton-gear/shield_large_a.glb'),
-		parts: bones(2.6)
+		attacks: [ONE_HANDED],
+		shapes: bones(2.6)
 	},
 	necromancer: {
 		blood: false,
 		height: 1.8,
 		model: { ...skeleton('characters/skeleton_mage.glb', 0.75, 'skeleton-gear/staff.glb'), animations: { attack: 'Ranged_Magic_Shoot' } },
 		shot: { color: [0.55, 0.85, 0.45], size: 0.3 },
-		parts: bones(1.8)
+		shapes: bones(1.8)
 	},
 	gargoyle: {
 		blood: false,
@@ -112,40 +115,58 @@ export const undeadLooks: UnitLooks = {
 		model: skeleton('characters/skeleton_minion.glb', 0.75, 'skeleton-gear/axe.glb'),
 		altitude: 3.2,
 		shot: { color: [0.6, 0.6, 0.65], size: 0.3 },
-		parts: bones(1.6)
+		shapes: bones(1.6)
 	},
-	deathKnight: {
+	// ---- the Restless' heroes (`heroes.ts`)
+	gravelord: {
 		blood: false,
 		height: 2.3,
 		model: skeleton('characters/skeleton_warrior.glb', 0.95, 'skeleton-gear/blade.glb', 'skeleton-gear/shield_small_a.glb'),
-		parts: bones(2.3)
+		// a hero's blade: a streak of blood behind it
+		attacks: [{ ...ONE_HANDED, trail: { color: [0.8, 0.15, 0.2], width: 0.16 } }],
+		shapes: bones(2.3)
 	},
-	lich: {
+	rimeWitch: {
 		blood: false,
 		height: 2.2,
 		model: { ...skeleton('characters/skeleton_mage.glb', 1, 'skeleton-gear/staff.glb'), animations: { attack: 'Ranged_Magic_Shoot' } },
 		shot: { color: [0.55, 0.85, 1], size: 0.35 },
-		parts: bones(2.2)
+		shapes: bones(2.2)
 	},
-	gravehold: { height: 4.6, model: building('rts/wooden_temple.glb', 3.6), parts: crypt(3.6, 4.6) },
-	hallOfBones: { height: 5.6, model: building('rts/fortress.glb', 3.7), parts: crypt(3.7, 5.6) },
-	duskCitadel: { height: 6.6, model: building('rts/wooden_fortress.glb', 3.9), parts: crypt(3.8, 6.6) },
+	duskblade: {
+		blood: false,
+		height: 2.1,
+		model: skeleton('characters/skeleton_rogue.glb', 0.9, 'skeleton-gear/blade.glb', 'skeleton-gear/blade.glb'),
+		// two blades: both together, and each alone, with a dusk-violet streak
+		attacks: [{ ...DUAL_WIELD, trail: { color: [0.6, 0.35, 0.9], width: 0.12 } }],
+		shapes: bones(2.1)
+	},
+	boneReaver: {
+		blood: false,
+		height: 2.6,
+		model: skeleton('characters/skeleton_warrior.glb', 1.1, 'skeleton-gear/axe.glb'),
+		attacks: [{ ...ONE_HANDED, trail: { color: [0.9, 0.85, 0.7], width: 0.18 } }],
+		shapes: bones(2.6)
+	},
+	gravehold: { height: 4.6, model: building('rts/wooden_temple.glb', 3.6), shapes: crypt(3.6, 4.6) },
+	hallOfBones: { height: 5.6, model: building('rts/fortress.glb', 3.7), shapes: crypt(3.7, 5.6) },
+	duskCitadel: { height: 6.6, model: building('rts/wooden_fortress.glb', 3.9), shapes: crypt(3.8, 6.6) },
 	// over the gold mine's own model, a little bigger
-	cursedMine: { height: 3.4, model: building('rts/mine.glb', 4), parts: crypt(4, 3.4) },
-	boneSpire: { height: 2.4, model: building('rts/wooden_monument.glb', 1.9), parts: crypt(1.7, 2.4) },
-	crypt: { height: 3.2, model: building('rts/storage_house.glb', 2.7), parts: crypt(2.7, 3.2) },
-	graveyard: { height: 3, model: building('rts/houses.glb', 2.7), parts: crypt(2.7, 3) },
-	darkAltar: { height: 3.6, model: building('rts/temple.glb', 2.8), parts: crypt(2.8, 3.6) },
-	slaughterhouse: { height: 3.4, model: building('rts/storage_shed.glb', 2.7), parts: crypt(2.7, 3.4) },
-	temple: { height: 3.6, model: building('rts/temple_2.glb', 2.6), parts: crypt(2.6, 3.6) },
+	cursedMine: { height: 3.4, model: building('rts/mine.glb', 4), shapes: crypt(4, 3.4) },
+	boneSpire: { height: 2.4, model: building('rts/wooden_monument.glb', 1.9), shapes: crypt(1.7, 2.4) },
+	crypt: { height: 3.2, model: building('rts/storage_house.glb', 2.7), shapes: crypt(2.7, 3.2) },
+	graveyard: { height: 3, model: building('rts/houses.glb', 2.7), shapes: crypt(2.7, 3) },
+	darkAltar: { height: 3.6, model: building('rts/temple.glb', 2.8), shapes: crypt(2.8, 3.6) },
+	slaughterhouse: { height: 3.4, model: building('rts/storage_shed.glb', 2.7), shapes: crypt(2.7, 3.4) },
+	temple: { height: 3.6, model: building('rts/temple_2.glb', 2.6), shapes: crypt(2.6, 3.6) },
 	spiritTower: {
 		height: 4.4,
 		model: building('rts/stone_tower_2.glb', 1.9, { points: { launch: { offset: [0, 3, 0] } } }),
 		// a beam of the dead's green from the tower's top to where the shot is: drawn by melee, not the client
 		shot: { draw: beam([0.55, 0.95, 0.45]) },
-		parts: crypt(1.5, 4.4)
+		shapes: crypt(1.5, 4.4)
 	},
-	tomb: { height: 3.2, model: building('rts/archery_towers.glb', 2.7), parts: crypt(2.7, 3.2) }
+	tomb: { height: 3.2, model: building('rts/archery_towers.glb', 2.7), shapes: crypt(2.7, 3.2) }
 }
 
 /** What the Restless' buildings are darkened with */
@@ -173,14 +194,32 @@ for (const id of [
 }
 
 export const undeadEffects: AbilityLooks = {
-	deathCoil: { color: [0.55, 0.85, 0.45] },
-	animateDead: { color: [0.55, 0.85, 0.45], style: 'burst', options: { count: 80, rise: 2.5, shape: 'rise' } },
-	darkCharge: { color: [0.4, 0.3, 0.55] },
-	unholy: { color: [0.55, 0.85, 0.45] },
-	frostNova: { color: [0.55, 0.85, 1], style: 'burst', options: { count: 60, ring: 2.5, shape: 'about' } },
-	frostArmor: { color: [0.62, 0.86, 1] },
-	chilled: { color: [0.62, 0.86, 1] },
-	deathAndDecay: { color: [0.45, 0.6, 0.3] },
+	// the Restless' heroes
+	graveLash: { color: [0.75, 0.15, 0.2] },
+	graveChill: { color: [0.55, 0.3, 0.45] },
+	siphon: { color: [0.8, 0.1, 0.2], style: 'tether' },
+	deathless: { color: [0.55, 0.85, 0.45] },
+	armyOfTheGrave: { color: [0.55, 0.85, 0.45], style: 'burst', options: { count: 80, rise: 2.5, shape: 'rise' } },
+	graveRallied: { color: [0.8, 0.2, 0.25] },
+	bloodTithe: { color: [0.7, 0.1, 0.15] },
+	rimeBolt: { color: [0.55, 0.85, 1] },
+	frozen: { color: [0.62, 0.86, 1] },
+	grasp: { color: [0.62, 0.86, 1], style: 'burst', options: { count: 60, ring: 2.5, shape: 'about' } },
+	iceRooted: { color: [0.62, 0.86, 1] },
+	frostbitten: { color: [0.62, 0.86, 1] },
+	whiteout: { color: [0.85, 0.93, 1], style: 'mark', options: { lasts: 5, radius: 4.5, sparks: 30 } },
+	whiteoutChill: { color: [0.85, 0.93, 1] },
+	duskMark: { color: [0.6, 0.35, 0.9] },
+	faded: { color: [0.45, 0.35, 0.6] },
+	shadowed: { color: [0.35, 0.25, 0.5] },
+	hushed: { color: [0.6, 0.35, 0.9] },
+	eclipse: { color: [0.4, 0.2, 0.6], style: 'burst', options: { count: 50, shape: 'about' } },
+	eclipsed: { color: [0.4, 0.2, 0.6] },
+	boneCleaver: { color: [0.9, 0.85, 0.7], style: 'burst', options: { count: 50, ring: 3, shape: 'about' } },
+	gorge: { color: [0.75, 0.15, 0.2] },
+	bonePit: { color: [0.9, 0.85, 0.7], style: 'mark', options: { lasts: 4, radius: 4.5, sparks: 24 } },
+	bonePitFrenzy: { color: [0.9, 0.85, 0.7] },
+	harvest: { color: [0.75, 0.15, 0.2] },
 	unholyFrenzy: { color: [0.9, 0.3, 0.25] },
 	crippled: { color: [0.5, 0.35, 0.6] },
 	webbed: { color: [0.9, 0.9, 0.85] },

package/starters/melee/src/melee/view/walls.ts

@@ -6,7 +6,7 @@ import { blightLayer } from '../blight'
 type CardButtons = NonNullable<NonNullable<GameView['hud']>['cardButtons']>
 
 /**
- * The button of a gate of the player's (`withWalls`, `wall.gate`): Open while it is shut, Shut while it is open, for
+ * The button of a gate of the player's (`wallsPack`, `wall.gate`): Open while it is shut, Shut while it is open, for
  * everyone (`wallGateCommand`). On the card of the gate picked first, once it stands
  */
 export const gateButtons: CardButtons = ({ primary }) => {

package/starters.mjs

@@ -21,6 +21,12 @@ export const starters = [
 		title: 'A campaign',
 		summary: 'three missions with a hero carried between them: a base to defend, a siege of waves at night, a warlord to face',
 		needs: ['assets']
+	},
+	{
+		name: 'examples',
+		title: 'Examples',
+		summary: "what the engine can do, a small scene each, browsed from a list as three.js's examples are: to read, copy and change",
+		needs: ['assets']
 	}
 ]
 

package/v12.mjs

@@ -6,22 +6,22 @@
  *                | merge <base> <ours> <theirs> | generate <game> <name> [--generator id] [--seed N] …
  *   v12 save diff <a> <b>
  *
- * The project is read as its page reads it, through its own Vite, so its game (`src/game.ts`: every game defined there,
- * `defineGame`) and a script for `map run` are TypeScript with nothing built first. Its maps are in `src/maps`
+ * The project is read as its page reads it, through its own Vite, so its game (`src/game.ts`: every game made there,
+ * `createGame`) and a script for `map run` are TypeScript with nothing built first. Its maps are in `src/maps`
  */
-import { readFileSync } from 'node:fs'
+import { existsSync, readFileSync } from 'node:fs'
 import { createRequire } from 'node:module'
 import { join, resolve } from 'node:path'
 import { pathToFileURL } from 'node:url'
 
 const [command, ...args] = process.argv.slice(2)
 
-/** The project's games: every game defined in its `src/game.ts` (what `defineGame` gives: an id, rules and a view) */
-function gamesOf(module) {
+/** The project's games: every game made in its `src/game.ts` (what `createGame` gives), its rules and its view fetched */
+async function gamesOf(module) {
 	const games = {}
 	for (const value of Object.values(module)) {
-		if (value && typeof value === 'object' && typeof value.id === 'string' && value.rules && value.view) {
-			games[value.id] = { module: value.rules, view: value.view }
+		if (value && typeof value === 'object' && typeof value.id === 'string' && typeof value.toRules === 'function' && value.hasView) {
+			games[value.id] = { module: value.toRules(), view: await value.toView() }
 		}
 	}
 	return games
@@ -38,14 +38,13 @@ async function map(project) {
 		logLevel: 'error'
 	})
 	try {
-		const games = gamesOf(await server.ssrLoadModule('/src/game.ts'))
-		if (!Object.keys(games).length) throw new Error('src/game.ts defines no game (`export const game = defineGame({ rules, view })`)')
-		// the map editor's: a project made without the editor has no map command
-		try {
-			require.resolve('@v12-engine/editor/map-command')
-		} catch {
-			throw new Error("v12 map is the map editor's: this project has none. npm install @v12-engine/editor")
-		}
+		const games = await gamesOf(await server.ssrLoadModule('/src/game.ts'))
+		if (!Object.keys(games).length) throw new Error('src/game.ts makes no game (`export const game = createGame({ id, name })`, with its view)')
+		// the map editor's: a project made without the editor has no map command. Whether the package is there, not whether
+		// its command resolves: in the library's own repository the packages are read as they are written, nothing built,
+		// and the command's file resolves through Vite below, not through Node
+		const editor = (require.resolve.paths('@v12-engine/editor') ?? []).some((dir) => existsSync(join(dir, '@v12-engine/editor/package.json')))
+		if (!editor) throw new Error("v12 map is the map editor's: this project has none. npm install @v12-engine/editor")
 		const { mapCommand } = await server.ssrLoadModule('@v12-engine/editor/map-command')
 		return await mapCommand(args, {
 			games,

package/starters/campaign/src/rules.ts

@@ -1,20 +0,0 @@
-/**
- * The rules: the campaign's, in `src/campaign`. Its units, its missions and its waves are in that folder; this is the
- * name every part of the project knows them by
- */
-import type { GameMap, World } from '@v12-engine/engine'
-import { campaign, startMission } from './campaign'
-
-export { ENEMY, PLAYER, UNIT } from './campaign'
-
-export const rules = campaign
-
-/**
- * What the game does once a world is made from a map, before anyone plays: the map's mission is given (each map is
- * a mission's; a map of none plays on with no objectives). The page's free play, the server, the tests and the
- * editor's Play here each call it with the map; the campaign's own scene gives the mission itself, knowing whether
- * the game is new or loaded from a save
- */
-export function start(world: World, { map }: { map?: GameMap }): void {
-	startMission(world, map)
-}

package/starters/empty/src/maps.ts

@@ -1,44 +0,0 @@
-/**
- * The maps of the game. There is one, made here in code: a flat field with a player on it and a road across it.
-// @if editor
- * The map editor (`npm run dev`, then `/?editor`) opens it, and Save writes it into `src/maps/field.vgmap.json`. From
- * then on the file is the map: import it here in its place, as the lines below say, and `flatField` can go
-// @end
- */
-import { createMap, type GameMap } from '@v12-engine/engine'
-import { tiles } from './tiles'
-// @if editor
-// import { mapsFrom } from '@v12-engine/engine'
-// import field from './maps/field.vgmap.json'
-// @end
-
-/** A flat field of 32 cells a side, a player with a start in its middle, and a road across it */
-function flatField(): GameMap {
-	const map = createMap({ name: 'Field', width: 32, depth: 32, players: 1, game: 'my-game', tileset: tiles.map((tile) => tile.id) })
-	map.players[0].start = { x: 16, z: 16 }
-	// a cell's paint is the place of its tile in the map's tileset, from 1 (0 is none: the ground's own colour)
-	const road = map.tileset.indexOf('road') + 1
-	for (let z = 20; z < 22; z++) for (let x = 0; x < map.width; x++) map.tiles[z * map.width + x] = road
-	return map
-}
-
-/** The maps by name */
-// @if editor
-// once the editor has saved the field: mapsFrom({ './maps/field.vgmap.json': field })
-// @end
-export const maps: Readonly<Record<string, GameMap>> = { field: flatField() }
-
-// @if editor
-/** The map a game is on when nothing says which, and the one the editor opens first */
-// @end
-// @if !editor
-/** The map a game is on when nothing says which */
-// @end
-export const DEFAULT_MAP = 'field'
-
-/** A map by name, as a copy: a game changes nothing of what the next one starts from */
-export function mapNamed(name = DEFAULT_MAP): GameMap {
-	const map = maps[name]
-	if (!map) throw new Error(`There is no map "${name}": the maps are ${Object.keys(maps).join(', ')}`)
-	return structuredClone(map)
-}

package/starters/empty/src/tiles.ts

@@ -1,12 +0,0 @@
-/**
- * What the ground can be painted with: the rules' names for it, which the map editor's Paint offers and the rules read
- * (`world.registry.tile('road')`). How each looks is the game's look's (`tiles` in `src/game.ts`). A new one is a line
- * here and one there; a map keeps its paint by these names, so their order can change
- */
-import { presetTiles } from '@v12-engine/engine'
-
-/**
- * The engine's tiles of an RTS (grass, dark grass, dirt, road, sand, rock, snow), drawn with the client's `TILE_LOOKS`.
- * A game's own goes beside them: `defineTile({ id: 'lava', name: 'Lava' })` here, its look in `src/game.ts`
- */
-export const tiles = [...presetTiles]

package/starters/melee/src/melee/heroSpells.ts

@@ -1,38 +0,0 @@
-import type { AbilityDef, BuffDef } from '@v12-engine/engine'
-
-/** The spells every hero brings along (`HeroDef.spells`): learned from the start, one point each, on long cooldowns */
-
-export const heroSpellBuffs: BuffDef[] = [
-	{ id: 'healHaste', name: 'Second Wind', description: 'Moves 30% faster', duration: 1, percent: { moveSpeed: 0.3 } },
-	{ id: 'barrier', name: 'Barrier', description: 'A shield takes the damage', duration: 2.5, shield: 120, shieldScaling: { level: 21.2 } }
-]
-
-export const heroSpells: AbilityDef[] = [
-	{
-		id: 'flash',
-		name: 'Flash',
-		description: 'At once a short way towards the pointer, through whatever is in between',
-		target: 'direction',
-		cooldown: 300,
-		effects: [{ type: 'blink', distance: 5.3 }]
-	},
-	{
-		id: 'secondWind',
-		name: 'Second Wind',
-		description: 'The hero and allied heroes nearby regain 80 to 318 health, more with every level, and run 30% faster for a second',
-		target: 'none',
-		cooldown: 240,
-		effects: [
-			{ type: 'heal', amount: 80, scaling: { level: 14 }, radius: 10.9, only: 'heroes' },
-			{ type: 'buff', buff: 'healHaste', radius: 10.9, only: 'heroes' }
-		]
-	},
-	{
-		id: 'barrier',
-		name: 'Barrier',
-		description: 'A shield for 2.5 seconds that takes 120 to 480 damage, more with every level',
-		target: 'none',
-		cooldown: 180,
-		effects: [{ type: 'buff', buff: 'barrier', on: 'caster' }]
-	}
-]

package/starters/melee/src/rules.ts

@@ -1,24 +0,0 @@
-/**
- * The rules: melee's, in `src/melee`. Its races, heroes, units, buildings and the generator of its random maps are
- * in that folder; this is the name every part of the project knows them by
- */
-import type { GameMap, PlayerId, World } from '@v12-engine/engine'
-import { melee } from './melee'
-
-export const rules = melee
-
-/**
- * What the game does once a world is made from a map, before anyone plays. Every player with a start is given a hall
- * and five workers by the rules themselves; in the page, the computer plays everyone but you, each against the other
- * teams' starts. A server seats its computers itself (`server.ts`), so there is no one to seat here
- */
-export function start(world: World, { map, player }: { map?: GameMap; player?: PlayerId }): void {
-	if (!map || player === undefined) return
-	const players = map.players.filter((other) => other.start)
-	for (const other of players) {
-		if (other.id === player) continue
-		const enemyBases = players.filter((rival) => rival.team !== other.team).map((rival) => rival.start!)
-		// remembered, so that a game loaded from a save of this one plays on against them
-		world.computers.seat(other.id, { enemyBases, settings: { army: { firstAttack: 360, waveSize: 6 } } })
-	}
-}