game-data-gen 1.2.1 → 2.0.0

package/README.md

@@ -34,7 +34,7 @@ npx game-data-gen <input-file-path> <optional-output-file-path>
 ## Format
 
 ```
-name type? length?
+name type? length? struct?
 fieldName fieldType fieldArrayType? fieldArrayLength?
 ```
 
@@ -46,9 +46,10 @@ The name of the data structure.
 
 Supported data structure types:
 
+- group
+- struct
 - soa (Structure of Arrays)
-
-If no type is given, it will act as a group which gets a zero function for the whole group.
+- aos (Array of Structures)
 
 `length` (optional)
 
@@ -64,6 +65,9 @@ The name of one of the fields within the data structure.
 
 Supported field types:
 
+- string
+- number
+- boolean
 - array
 
 `fieldArrayType` (optional, required if fieldType=array)
@@ -73,21 +77,17 @@ Supported array field types:
 - string
 - boolean
 - number
-- int8
-- int16
-- int32
-- uint8
-- uint16
-- uint32
-- float32
-- float64
 
 `fieldArrayLength` (optional)
 
-The length of the array field.
+The length of the array field, leave empty to use a dynamically sized array instead of a fixed size array.
 
 In case of a Structure of Arrays data structure (type=soa), setting the length on the type instead is recommended so that all arrays have the same length.
 
+`struct` (optional, required if type=aos)
+
+The defined struct to use for this Array of Structures.
+
 ## Example
 
 Create a plain text file somewhere in your source code (without a file extension).
@@ -95,13 +95,24 @@ Create a plain text file somewhere in your source code (without a file extension
 For example `src/data/game`:
 
 ```
-Game
+game group
 activeEntities array number
 
-Entity soa 2048
-posX array float32
-posY array float32
-isActive array uint8
+vector struct
+x number
+y number
+
+entity struct
+position vector
+velocity vector
+health number
+isActive boolean
+
+entities aos 2048 entity
+
+particle soa 1024
+posX array number
+posY array number
 ```
 
 Run the package with (consider making this a script in your package.json):
@@ -110,67 +121,134 @@ Run the package with (consider making this a script in your package.json):
 npx game-data-gen src/data/game
 ```
 
-This will create or update the `src/data/game.ts` file:
+This will create or update the `src/data/game.ts` file which you can then import into your code:
 
 ```typescript
 /*
  * --------------------------------------------------
- * Game (group)
+ * game (group)
  * --------------------------------------------------
  */
 
-export const activeEntities = new Array<number>();
+export const activeEntities = new Array<number>()
 
-/** Zero the activeEntities field within the Game group. */
+/** Zero the activeEntities field within the game group. */
 export function zeroActiveEntities() {
-  activeEntities.length = 0;
+  activeEntities.length = 0
 }
 
-/** Zero all fields within the Game group. */
+/** Zero all fields within the game group. */
 export function zeroGameData() {
-  activeEntities.length = 0;
+  activeEntities.length = 0
 }
 
 /*
  * --------------------------------------------------
- * Entity (Structure of Arrays)
+ * vector (struct)
  * --------------------------------------------------
  */
 
-export const MAX_ENTITY_COUNT = 2048;
+export type Vector = {
+  x: number
+  y: number
+}
+
+/** Create a new Vector object. */
+export function createVector(): Vector {
+  const obj = Object.create(null)
+  obj.x = 0
+  obj.y = 0
+  return obj
+}
 
-export const posX = new Float32Array(2048);
-export const posY = new Float32Array(2048);
-export const isActive = new Uint8Array(2048);
+/** Zero the given Vector object. */
+export function zeroVector(obj: Vector) {
+  obj.x = 0
+  obj.y = 0
+}
 
-/** Zero an index within the Entity Structure of Arrays. */
-export function zeroEntity(idx: number) {
-  posX[idx] = 0;
-  posY[idx] = 0;
-  isActive[idx] = 0;
+/*
+ * --------------------------------------------------
+ * entity (struct)
+ * --------------------------------------------------
+ */
+
+export type Entity = {
+  position: Vector
+  velocity: Vector
+  health: number
+  isActive: boolean
 }
 
-/** Zero the posX field within the Entity Structure of Arrays. */
-export function zeroPosX() {
-  posX.fill(0);
+/** Create a new Entity object. */
+export function createEntity(): Entity {
+  const obj = Object.create(null)
+  obj.position = createVector()
+  obj.velocity = createVector()
+  obj.health = 0
+  obj.isActive = false
+  return obj
 }
 
-/** Zero the posY field within the Entity Structure of Arrays. */
-export function zeroPosY() {
-  posY.fill(0);
+/** Zero the given Entity object. */
+export function zeroEntity(obj: Entity) {
+  zeroVector(obj.position)
+  zeroVector(obj.velocity)
+  obj.health = 0
+  obj.isActive = false
+}
+
+/*
+ * --------------------------------------------------
+ * entities (array of structures)
+ * --------------------------------------------------
+ */
+
+export const MAX_ENTITIES_COUNT = 2048
+
+/** An array of Entity objects (structures). */
+export const entities = new Array<Entity>(2048)
+for (let i=0; i<2048; i++) {
+  entities[i] = createEntity()
+}
+
+/** Zero all objects within the entities array of structures. */
+export function zeroEntities() {
+  for (let i=0; i<2048; i++) {
+    zeroEntity(entities[i])
+  }
+}
+
+/*
+ * --------------------------------------------------
+ * particle (structure of arrays)
+ * --------------------------------------------------
+ */
+
+export const MAX_PARTICLE_COUNT = 1024
+
+export const posX = new Array<number>(1024).fill(0)
+export const posY = new Array<number>(1024).fill(0)
+
+/** Zero an index within the particle structure of arrays. */
+export function zeroParticle(idx: number) {
+  posX[idx] = 0
+  posY[idx] = 0
 }
 
-/** Zero the isActive field within the Entity Structure of Arrays. */
-export function zeroIsActive() {
-  isActive.fill(0);
+/** Zero the posX field within the particle structure of arrays. */
+export function zeroPosX() {
+  posX.fill(0)
 }
 
-/** Zero all fields within the Entity Structure of Arrays. */
-export function zeroEntityData() {
-  posX.fill(0);
-  posY.fill(0);
-  isActive.fill(0);
+/** Zero the posY field within the particle structure of arrays. */
+export function zeroPosY() {
+  posY.fill(0)
 }
-```
 
-Then import the data and its functions from `src/data/game.ts` in your code.
+/** Zero all fields within the particle structure of arrays. */
+export function zeroParticleData() {
+  posX.fill(0)
+  posY.fill(0)
+}
+```

package/dist/main.js

@@ -1,175 +1,6 @@
 #!/usr/bin/env node
+import S from"fs";function l(i){switch(i){case"soa":return"structure of arrays";case"aos":return"array of structures";case"struct":return"struct";case"group":return"group";default:return"???"}}function c(i){return`${i.substring(0,1).toUpperCase()}${i.substring(1)}`}function h(i,n,r){let[e,s,a,t]=i.split(" "),o=n||t||"";switch(s){case"string":r.push(`export let ${e} = ""`);break;case"number":r.push(`export let ${e} = 0`);break;case"boolean":r.push(`export let ${e} = false`);break;case"array":switch(a){case"string":r.push(`export const ${e} = new Array<string>(${o})${o?'.fill("")':""}`);break;case"number":r.push(`export const ${e} = new Array<number>(${o})${o?".fill(0)":""}`);break;case"boolean":r.push(`export const ${e} = new Array<boolean>(${o})${o?".fill(false)":""}`);break}break}}function d(i,n,r,e){let[s,a]=r.split(" ");switch(a){case"string":case"number":case"boolean":e.push(""),e.push(`/** Set the value of the ${s} field within the ${i} ${l(n)}. */`),e.push(`export function set${c(s)}(value: ${a}) {`),e.push(`  ${s} = value`),e.push("}");break}}function p(i,n,r,e,s){let[a,t,o,A]=r.split(" "),b=e||A||"";s.push(""),s.push(`/** Zero the ${a} field within the ${i} ${l(n)}. */`),s.push(`export function zero${c(a)}() {`),N(a,t,o,b,s),s.push("}")}function $(i,n,r,e,s){s.push(""),s.push(`/** Zero all fields within the ${i} ${l(n)}. */`),s.push(`export function zero${c(i)}Data() {`);for(let a of r){let[t,o,A,b]=a.split(" ");N(t,o,A,e||b||"",s)}s.push("}")}function N(i,n,r,e,s){switch(n){case"string":s.push(`  ${i} = ""`);break;case"number":s.push(`  ${i} = 0`);break;case"boolean":s.push(`  ${i} = false`);break;case"array":switch(r){case"string":s.push(`  ${i}.${e?'fill("")':"length = 0"}`);break;case"number":s.push(`  ${i}.${e?"fill(0)":"length = 0"}`);break;case"boolean":s.push(`  ${i}.${e?"fill(false)":"length = 0"}`);break}break}}function g(i,n,r){r.push(`export const MAX_${i.toUpperCase()}_COUNT = ${n}`),r.push("")}function m(i,n,r){let[e,s,a]=i.split(" ");g(e,a,r);for(let t of n)h(t,a,r);for(let t of n)d(e,s,t,r);F(e,s,n,r);for(let t of n)p(e,s,t,a,r);$(e,s,n,a,r)}function F(i,n,r,e){e.push(""),e.push(`/** Zero an index within the ${i} ${l(n)}. */`),e.push(`export function zero${c(i)}(idx: number) {`);for(let s of r){let[a,t,o]=s.split(" ");switch(o){case"string":e.push(`  ${a}[idx] = ""`);break;case"number":e.push(`  ${a}[idx] = 0`);break;case"boolean":e.push(`  ${a}[idx] = false`);break}}e.push("}")}function O(i,n,r){let[e,s,a]=i.split(" ");for(let t of n)h(t,a,r);for(let t of n)d(e,s,t,r);for(let t of n)p(e,s,t,a,r);$(e,s,n,a,r)}function R(i,n,r){let[e]=i.split(" ");w(e,n,r),E(e,n,r),B(e,n,r)}function w(i,n,r){r.push(`export type ${c(i)} = {`);for(let e of n){let[s,a,t]=e.split(" ");switch(a){case"string":r.push(`  ${s}: string`);break;case"number":r.push(`  ${s}: number`);break;case"boolean":r.push(`  ${s}: boolean`);break;case"array":r.push(`  ${s}: Array<${t}>`);break;default:r.push(`  ${s}: ${c(a)}`)}}r.push("}")}function E(i,n,r){r.push(""),r.push(`/** Create a new ${c(i)} object. */`),r.push(`export function create${c(i)}(): ${c(i)} {`),r.push("  const obj = Object.create(null)");for(let e of n){let[s,a,t,o=""]=e.split(" ");switch(a){case"string":r.push(`  obj.${s} = ""`);break;case"number":r.push(`  obj.${s} = 0`);break;case"boolean":r.push(`  obj.${s} = false`);break;case"array":switch(t){case"string":r.push(`  obj.${s} = new Array<string>(${o})${o?'.fill("")':""}`);break;case"number":r.push(`  obj.${s} = new Array<number>(${o})${o?".fill(0)":""}`);break;case"boolean":r.push(`  obj.${s} = new Array<boolean>(${o})${o?".fill(false)":""}`);break}break;default:r.push(`  obj.${s} = create${c(a)}()`)}}r.push("  return obj"),r.push("}")}function B(i,n,r){r.push(""),r.push(`/** Zero the given ${c(i)} object. */`),r.push(`export function zero${c(i)}(obj: ${c(i)}) {`);for(let e of n){let[s,a,t,o]=e.split(" ");switch(a){case"string":r.push(`  obj.${s} = ""`);break;case"number":r.push(`  obj.${s} = 0`);break;case"boolean":r.push(`  obj.${s} = false`);break;case"array":switch(t){case"string":r.push(`  obj.${s}.${o?'fill("")':"length = 0"}`);break;case"number":r.push(`  obj.${s}.${o?"fill(0)":"length = 0"}`);break;case"boolean":r.push(`  obj.${s}.${o?"fill(false)":"length = 0"}`);break}break;default:r.push(`  zero${c(a)}(obj.${s})`)}}r.push("}")}function k(i,n){let[r,,e,s]=i.split(" ");g(r,e,n),L(r,s,e,n),j(r,s,e,n)}function L(i,n,r,e){e.push(`/** An array of ${c(n)} objects (structures). */`),e.push(`export const ${i} = new Array<${c(n)}>(${r})`),e.push(`for (let i=0; i<${r}; i++) {`),e.push(`  ${i}[i] = create${c(n)}()`),e.push("}")}function j(i,n,r,e){e.push(""),e.push(`/** Zero all objects within the ${i} array of structures. */`),e.push(`export function zero${c(i)}() {`),e.push(`  for (let i=0; i<${r}; i++) {`),e.push(`    zero${c(n)}(${i}[i])`),e.push("  }"),e.push("}")}var x=process.argv[2],U=process.argv[3]||`${x}.ts`,G=S.readFileSync(x,"utf-8"),f=[];f.push("/*");f.push(` * Generated with game-data-gen on ${new Date().toLocaleString()}. DO NOT MODIFY THIS FILE!`);f.push(" */");var M=G.trim().split(`
 
-// src/main.ts
-import fs from "fs";
-var inputFile = process.argv[2];
-var outputFile = process.argv[3] || `${inputFile}.ts`;
-var input = fs.readFileSync(inputFile, "utf-8");
-var output = [];
-output.push("/*");
-output.push(` * Generated with game-data-gen on ${(/* @__PURE__ */ new Date()).toLocaleString()}. DO NOT MODIFY THIS FILE!`);
-output.push(" */");
-var blocks = input.trim().split("\n\n");
-for (const block of blocks) {
-  const fields = block.split("\n");
-  const header = fields.shift();
-  if (!header) continue;
-  const [name, type, baseLength] = header.split(" ");
-  output.push("");
-  output.push("/*");
-  output.push(` * ${"-".repeat(50)}`);
-  output.push(` * ${name} (${getTypeName(type)})`);
-  output.push(` * ${"-".repeat(50)}`);
-  output.push(" */");
-  output.push("");
-  if (type === "soa" /* SOA */) {
-    output.push(`export const MAX_${name.toUpperCase()}_COUNT = ${baseLength}`);
-    output.push("");
-  }
-  for (const field of fields) {
-    const [fieldName, fieldType, fieldArrayType, fieldLength] = field.split(" ");
-    const length = baseLength || fieldLength || "";
-    switch (fieldType) {
-      case "string" /* STRING */:
-        output.push(`export let ${fieldName} = ""`);
-        break;
-      case "boolean" /* BOOLEAN */:
-        output.push(`export let ${fieldName} = false`);
-        break;
-      case "number" /* NUMBER */:
-        output.push(`export let ${fieldName} = 0`);
-        break;
-      case "array" /* ARRAY */:
-        {
-          switch (fieldArrayType) {
-            case "int8" /* INT8 */:
-              output.push(`export const ${fieldName} = new Int8Array(${length})`);
-              break;
-            case "int16" /* INT16 */:
-              output.push(`export const ${fieldName} = new Int16Array(${length})`);
-              break;
-            case "int32" /* INT32 */:
-              output.push(`export const ${fieldName} = new Int32Array(${length})`);
-              break;
-            case "uint8" /* UINT8 */:
-              output.push(`export const ${fieldName} = new Uint8Array(${length})`);
-              break;
-            case "uint16" /* UINT16 */:
-              output.push(`export const ${fieldName} = new Uint16Array(${length})`);
-              break;
-            case "uint32" /* UINT32 */:
-              output.push(`export const ${fieldName} = new Uint32Array(${length})`);
-              break;
-            case "float32" /* FLOAT32 */:
-              output.push(`export const ${fieldName} = new Float32Array(${length})`);
-              break;
-            case "float64" /* FLOAT64 */:
-              output.push(`export const ${fieldName} = new Float64Array(${length})`);
-              break;
-            case "string" /* STRING */:
-              output.push(`export const ${fieldName} = new Array<string>(${length})${length ? '.fill("")' : ""}`);
-              break;
-            case "boolean" /* BOOLEAN */:
-              output.push(`export const ${fieldName} = new Array<boolean>(${length})${length ? ".fill(false)" : ""}`);
-              break;
-            case "number" /* NUMBER */:
-              output.push(`export const ${fieldName} = new Array<number>(${length})${length ? ".fill(0)" : ""}`);
-              break;
-            default:
-              output.push(`export const ${fieldName} = new Array<${fieldArrayType}>(${length})`);
-          }
-        }
-        break;
-    }
-  }
-  for (const field of fields) {
-    const [fieldName, fieldType] = field.split(" ");
-    switch (fieldType) {
-      case "string" /* STRING */:
-      case "boolean" /* BOOLEAN */:
-      case "number" /* NUMBER */:
-        output.push("");
-        output.push(`/** Set the value of the ${fieldName} field within the ${name} ${getTypeName(type)}. */`);
-        output.push(`export function set${capitalize(fieldName)}(value: ${fieldType}) {`);
-        output.push(`  ${fieldName} = value`);
-        output.push("}");
-        break;
-    }
-  }
-  if (type === "soa" /* SOA */) {
-    output.push("");
-    output.push(`/** Zero an index within the ${name} ${getTypeName(type)}. */`);
-    output.push(`export function zero${capitalize(name)}(idx: number) {`);
-    for (const field of fields) {
-      const [fieldName, _, fieldArrayType] = field.split(" ");
-      switch (fieldArrayType) {
-        case "string" /* STRING */:
-          output.push(`  ${fieldName}[idx] = ""`);
-          break;
-        case "boolean" /* BOOLEAN */:
-          output.push(`  ${fieldName}[idx] = false`);
-          break;
-        default:
-          output.push(`  ${fieldName}[idx] = 0`);
-      }
-    }
-    output.push("}");
-  }
-  for (const field of fields) {
-    const [fieldName, fieldType, fieldArrayType, fieldLength] = field.split(" ");
-    const length = baseLength || fieldLength || "";
-    output.push("");
-    output.push(`/** Zero the ${fieldName} field within the ${name} ${getTypeName(type)}. */`);
-    output.push(`export function zero${capitalize(fieldName)}() {`);
-    zeroField(fieldName, fieldType, fieldArrayType, length);
-    output.push("}");
-  }
-  output.push("");
-  output.push(`/** Zero all fields within the ${name} ${getTypeName(type)}. */`);
-  output.push(`export function zero${capitalize(name)}Data() {`);
-  for (const field of fields) {
-    const [fieldName, fieldType, fieldArrayType, fieldLength] = field.split(" ");
-    const length = baseLength || fieldLength || "";
-    zeroField(fieldName, fieldType, fieldArrayType, length);
-  }
-  output.push("}");
-}
-function zeroField(name, type, arrayType, length) {
-  switch (type) {
-    case "string" /* STRING */:
-      output.push(`  ${name} = ""`);
-      break;
-    case "boolean" /* BOOLEAN */:
-      output.push(`  ${name} = false`);
-      break;
-    case "number" /* NUMBER */:
-      output.push(`  ${name} = 0`);
-      break;
-    case "array" /* ARRAY */:
-      {
-        switch (arrayType) {
-          case "string" /* STRING */:
-            output.push(`  ${name}.${length ? 'fill("")' : "length = 0"}`);
-            break;
-          case "boolean" /* BOOLEAN */:
-            output.push(`  ${name}.${length ? "fill(false)" : "length = 0"}`);
-            break;
-          default:
-            output.push(`  ${name}.${length ? "fill(0)" : "length = 0"}`);
-        }
-      }
-      break;
-  }
-}
-function getTypeName(type) {
-  switch (type) {
-    case "soa" /* SOA */:
-      return "Structure of Arrays";
-    default:
-      return "group";
-  }
-}
-function capitalize(str) {
-  return `${str.substring(0, 1).toUpperCase()}${str.substring(1)}`;
-}
-fs.writeFileSync(outputFile, output.join("\n"));
+`);for(let i of M){let n=i.split(`
+`),r=n.shift();if(!r)continue;let[e,s]=r.split(" ");switch(f.push(""),f.push("/*"),f.push(` * ${"-".repeat(50)}`),f.push(` * ${e} (${l(s)})`),f.push(` * ${"-".repeat(50)}`),f.push(" */"),f.push(""),s){case"struct":R(r,n,f);break;case"group":O(r,n,f);break;case"soa":m(r,n,f);break;case"aos":k(r,f);break}}S.writeFileSync(U,f.join(`
+`));

package/package.json

@@ -1,24 +1,27 @@
 {
   "name": "game-data-gen",
-  "version": "1.2.1",
+  "version": "2.0.0",
   "type": "module",
   "files": [
     "dist"
   ],
-  "bin": "dist/main.js",
+  "bin": {
+    "game-data-gen": "dist/main.js"
+  },
   "scripts": {
-    "start": "tsx watch src/main.ts tests/data",
-    "build": "tsc && esbuild src/main.ts --bundle --platform=node --format=esm --target=es6 --outdir=dist --banner:js='#!/usr/bin/env node'",
+    "start": "onchange --initial 'src/**/*.ts' 'tests/*' -- tsx src/main.ts tests/data",
+    "build": "tsc && esbuild src/main.ts --bundle --minify --platform=node --format=esm --target=es6 --outdir=dist --banner:js='#!/usr/bin/env node'",
     "test": "npm run build && npx game-data-gen tests/data"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/patrickswijgman/game-data-gen"
+    "url": "git+https://github.com/patrickswijgman/game-data-gen.git"
   },
   "devDependencies": {
-    "@types/node": "^22.15.18",
-    "esbuild": "^0.25.4",
-    "tsx": "^4.19.4",
-    "typescript": "~5.8.3"
+    "@types/node": "^24.12.2",
+    "esbuild": "^0.28.0",
+    "onchange": "^7.1.0",
+    "tsx": "^4.21.0",
+    "typescript": "^6.0.2"
   }
 }