@n1h/web-characters-cube-pets 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,16 @@
-# Temporary Holding Version
+# @n1h/web-characters-cube-pets
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Kenney's 24 [Cube Pets](https://kenney.nl/assets/cube-pets), [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/), as [`@n1h/web-characters`](https://github.com/n0t-invented-here/catwalk) models.
+
+```ts
+import { cat } from "@n1h/web-characters-cube-pets/cat";              // one animal: its file and the shared texture
+import { CUBE_PETS } from "@n1h/web-characters-cube-pets";            // all 24, by name
+import { PETS, petLabel } from "@n1h/web-characters-cube-pets/spec";  // the names, without the files
+```
+
+- One module per animal, so a build ships only the animals a page imports.
+- The animals: beaver, bee, bunny, cat, caterpillar, chick, cow, crab, deer, dog, elephant, fish, fox, giraffe, hog, koala, lion, monkey, panda, parrot, penguin, pig, polar, tiger.
+- They idle, walk, run and dance. The chick, the parrot and the penguin also eat.
+- Licence: [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/); Kenney's file is `assets/License.txt`.
+
+Reference: [packs](https://github.com/n0t-invented-here/catwalk/blob/main/docs/packs.md).

package/assets/License.txt

@@ -0,0 +1,28 @@
+	
+
+	Cube Pets (2.0)
+
+	Created/distributed by Kenney (www.kenney.nl)
+	Creation date: 26-03-2026 11:16
+	
+			------------------------------
+
+	License: (Creative Commons Zero, CC0)
+	http://creativecommons.org/publicdomain/zero/1.0/
+
+	You can use this content for personal, educational, and commercial purposes.
+
+	Support by crediting 'Kenney' or 'www.kenney.nl' (this is not a requirement)
+
+			------------------------------
+
+	• Website : www.kenney.nl
+	• Donate  : www.kenney.nl/donate
+
+	• Patreon : patreon.com/kenney
+	
+	Follow on social media for updates:
+
+	• Twitter:	 twitter.com/KenneyNL
+	• BlueSky:	 kenney.bsky.social
+	• Instagram: instagram.com/kenney_nl

package/package.json

@@ -1,6 +1,35 @@
 {
   "name": "@n1h/web-characters-cube-pets",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "type": "module",
+  "description": "Kenney's 24 Cube Pets (CC0) as @n1h/web-characters models: one module per animal, so a build ships only the animals a page imports. The models, the shared texture and the licence are in the package.",
+  "license": "MIT OR 0BSD",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/n0t-invented-here/catwalk.git",
+    "directory": "packages/web-characters-cube-pets"
+  },
+  "homepage": "https://github.com/n0t-invented-here/catwalk#readme",
+  "bugs": {
+    "url": "https://github.com/n0t-invented-here/catwalk/issues"
+  },
+  "files": [
+    "src",
+    "!src/**/*.test.ts",
+    "assets",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": "./src/index.ts",
+    "./spec": "./src/spec.ts",
+    "./*": "./src/*.ts",
+    "./assets/*": "./assets/*"
+  },
+  "peerDependencies": {
+    "@n1h/web-characters": "^0.1.0"
+  },
+  "devDependencies": {
+    "@n1h/web-characters": "0.1.0"
+  }
+}

package/src/beaver.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-beaver.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const beaver = cubePetSpec("beaver", url, { [PET_TEXTURE_FILE]: colormap });

package/src/bee.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-bee.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const bee = cubePetSpec("bee", url, { [PET_TEXTURE_FILE]: colormap });

package/src/bunny.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-bunny.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const bunny = cubePetSpec("bunny", url, { [PET_TEXTURE_FILE]: colormap });

package/src/cat.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-cat.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const cat = cubePetSpec("cat", url, { [PET_TEXTURE_FILE]: colormap });

package/src/caterpillar.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-caterpillar.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const caterpillar = cubePetSpec("caterpillar", url, { [PET_TEXTURE_FILE]: colormap });

package/src/chick.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-chick.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const chick = cubePetSpec("chick", url, { [PET_TEXTURE_FILE]: colormap });

package/src/cow.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-cow.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const cow = cubePetSpec("cow", url, { [PET_TEXTURE_FILE]: colormap });

package/src/crab.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-crab.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const crab = cubePetSpec("crab", url, { [PET_TEXTURE_FILE]: colormap });

package/src/deer.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-deer.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const deer = cubePetSpec("deer", url, { [PET_TEXTURE_FILE]: colormap });

package/src/dog.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-dog.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const dog = cubePetSpec("dog", url, { [PET_TEXTURE_FILE]: colormap });

package/src/elephant.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-elephant.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const elephant = cubePetSpec("elephant", url, { [PET_TEXTURE_FILE]: colormap });

package/src/fish.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-fish.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const fish = cubePetSpec("fish", url, { [PET_TEXTURE_FILE]: colormap });

package/src/fox.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-fox.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const fox = cubePetSpec("fox", url, { [PET_TEXTURE_FILE]: colormap });

package/src/giraffe.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-giraffe.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const giraffe = cubePetSpec("giraffe", url, { [PET_TEXTURE_FILE]: colormap });

package/src/hog.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-hog.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const hog = cubePetSpec("hog", url, { [PET_TEXTURE_FILE]: colormap });

package/src/index.ts

@@ -0,0 +1,38 @@
+/// <reference types="@n1h/web-characters/assets" />
+// Kenney's Cube Pets, with their files. Each animal is its own module
+// (`@n1h/web-characters-cube-pets/cat`), importing its own glTF, so a build
+// that imports the cat ships the cat's file and nothing else of the pack.
+// This module imports all 24, for a page that wants the whole pack and
+// ships it.
+
+import type { ModelSpec } from "@n1h/web-characters/model";
+import type { Pet } from "./spec";
+export { PETS, BIRDS, isBird, isPet, petLabel, randomPet, type Pet, type PetAnimation } from "./spec";
+import { beaver } from "./beaver";
+import { bee } from "./bee";
+import { bunny } from "./bunny";
+import { cat } from "./cat";
+import { caterpillar } from "./caterpillar";
+import { chick } from "./chick";
+import { cow } from "./cow";
+import { crab } from "./crab";
+import { deer } from "./deer";
+import { dog } from "./dog";
+import { elephant } from "./elephant";
+import { fish } from "./fish";
+import { fox } from "./fox";
+import { giraffe } from "./giraffe";
+import { hog } from "./hog";
+import { koala } from "./koala";
+import { lion } from "./lion";
+import { monkey } from "./monkey";
+import { panda } from "./panda";
+import { parrot } from "./parrot";
+import { penguin } from "./penguin";
+import { pig } from "./pig";
+import { polar } from "./polar";
+import { tiger } from "./tiger";
+
+export { beaver, bee, bunny, cat, caterpillar, chick, cow, crab, deer, dog, elephant, fish, fox, giraffe, hog, koala, lion, monkey, panda, parrot, penguin, pig, polar, tiger };
+
+export const CUBE_PETS: Readonly<Record<Pet, ModelSpec>> = { beaver, bee, bunny, cat, caterpillar, chick, cow, crab, deer, dog, elephant, fish, fox, giraffe, hog, koala, lion, monkey, panda, parrot, penguin, pig, polar, tiger };

package/src/koala.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-koala.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const koala = cubePetSpec("koala", url, { [PET_TEXTURE_FILE]: colormap });

package/src/lion.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-lion.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const lion = cubePetSpec("lion", url, { [PET_TEXTURE_FILE]: colormap });

package/src/monkey.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-monkey.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const monkey = cubePetSpec("monkey", url, { [PET_TEXTURE_FILE]: colormap });

package/src/panda.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-panda.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const panda = cubePetSpec("panda", url, { [PET_TEXTURE_FILE]: colormap });

package/src/parrot.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-parrot.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const parrot = cubePetSpec("parrot", url, { [PET_TEXTURE_FILE]: colormap });

package/src/penguin.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-penguin.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const penguin = cubePetSpec("penguin", url, { [PET_TEXTURE_FILE]: colormap });

package/src/pig.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-pig.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const pig = cubePetSpec("pig", url, { [PET_TEXTURE_FILE]: colormap });

package/src/polar.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-polar.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const polar = cubePetSpec("polar", url, { [PET_TEXTURE_FILE]: colormap });

package/src/spec.ts

@@ -0,0 +1,77 @@
+// Kenney's Cube Pets (CC0): 24 animals, one glTF each, all sharing one
+// texture and the same eight clips. This module is the pack as data with no
+// files in it: the names, the labels, the file names, which are birds, and
+// the moods; each animal's module adds its file.
+
+import type { ModelSpec, MoodSpec } from "@n1h/web-characters/model";
+
+export const PETS = [
+  "beaver",
+  "bee",
+  "bunny",
+  "cat",
+  "caterpillar",
+  "chick",
+  "cow",
+  "crab",
+  "deer",
+  "dog",
+  "elephant",
+  "fish",
+  "fox",
+  "giraffe",
+  "hog",
+  "koala",
+  "lion",
+  "monkey",
+  "panda",
+  "parrot",
+  "penguin",
+  "pig",
+  "polar",
+  "tiger",
+] as const;
+
+export type Pet = (typeof PETS)[number];
+
+/** Every model has these, by name, in its animation groups. */
+export type PetAnimation = "static" | "idle" | "walk" | "run" | "eat" | "dance" | "gesture-positive" | "gesture-negative";
+
+/**
+ * The birds. The shared `eat` animation is a dip of the head to the ground,
+ * which reads as pecking: right on these, wrong on everything else, so only
+ * the birds ever play it.
+ */
+export const BIRDS: ReadonlySet<Pet> = new Set<Pet>(["chick", "parrot", "penguin"]);
+export const isBird = (pet: Pet): boolean => BIRDS.has(pet);
+
+export const petLabel = (pet: Pet): string => (pet === "polar" ? "Polar bear" : pet[0]!.toUpperCase() + pet.slice(1));
+export const isPet = (name: unknown): name is Pet => typeof name === "string" && (PETS as readonly string[]).includes(name);
+export const randomPet = (): Pet => PETS[Math.floor(Math.random() * PETS.length)]!;
+
+/** A pet's model file, relative to the pack folder (assets). */
+export const petModelFile = (pet: Pet): string => `animal-${pet}.glb`;
+/** The one texture every model references, relative to the pack folder; the models reference it by this path. */
+export const PET_TEXTURE_FILE = "Textures/colormap.png";
+/** Kenney's own 64x64 render of a pet, relative to the pack folder. */
+export const petPreviewFile = (pet: Pet): string => `Previews/animal-${pet}.png`;
+
+/** What the pets do on the ground, as the moods' names. `eat` is pecking: the birds get it, nobody else does. */
+export type Mood = "idle" | "walk" | "run" | "eat" | "dance";
+
+export const cubePetMoods = (pet: Pet): MoodSpec[] => [
+  { name: "idle", clip: "idle", weight: 2, seconds: [2, 6] },
+  { name: "walk", clip: "walk", weight: 3, speed: 55, seconds: [3, 8] }, // 55 px/s at scale 1, matched to the walk cycle
+  { name: "run", clip: "run", weight: 1, speed: 150, seconds: [1.5, 3.5] },
+  { name: "dance", clip: "dance", weight: 1, seconds: [3, 6] },
+  ...(isBird(pet) ? [{ name: "eat", clip: "eat", weight: 2, seconds: [2, 6] as [number, number] }] : []),
+];
+
+/** The spec for a pet whose file (and the shared texture) is at these URLs. */
+export const cubePetSpec = (pet: Pet, url: string, textures: Record<string, string>): ModelSpec => ({
+  name: petLabel(pet),
+  url,
+  textures,
+  clips: { idle: "idle", carried: "gesture-negative", falling: "gesture-negative", landed: "gesture-positive" },
+  moods: cubePetMoods(pet),
+});

package/src/tiger.ts

@@ -0,0 +1,5 @@
+import colormap from "../assets/Textures/colormap.png";
+import url from "../assets/animal-tiger.glb";
+import { PET_TEXTURE_FILE, cubePetSpec } from "./spec";
+
+export const tiger = cubePetSpec("tiger", url, { [PET_TEXTURE_FILE]: colormap });