@that-sky-project/that-sky-level 1.0.0 → 1.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@that-sky-project/that-sky-level",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "dependencies": {
     "@htmonkeyg/tformat": "^1.0.1",
     "arg": "^5.0.2",
@@ -9,15 +9,36 @@
     "lz4": "^0.6.5",
     "parsenbt-js": "^3.1.3"
   },
+  "files": [
+    "./dist",
+    "./package.json",
+    "./README.md",
+    "./LICENSE"
+  ],
   "scripts": {
     "build": "npx webpack"
   },
   "bin": {
-    "tslevel": "./dist/cli.js"
+    "tslevel": "dist/cli.js"
   },
   "devDependencies": {
     "terser-webpack-plugin": "^5.6.1",
     "webpack": "^5.108.3",
     "webpack-cli": "^7.1.0"
-  }
+  },
+  "description": "A simple level converter for Sky:CotL level binaries.",
+  "main": "main.js",
+  "directories": {
+    "doc": "docs"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/that-sky-project/that-sky-level.git"
+  },
+  "author": "That Sky Project",
+  "license": "AGPL-3.0-or-later",
+  "bugs": {
+    "url": "https://github.com/that-sky-project/that-sky-level/issues"
+  },
+  "homepage": "https://github.com/that-sky-project/that-sky-level#readme"
 }

package/docs/materials.md

@@ -1,37 +0,0 @@
-```
-kMaterial_None: 0,
-kMaterial_Transparent: 2,
-kMaterial_Void: 3,
-kMaterial_Particle: 4,
-kMaterial_WoodSlippery: 5,
-kMaterial_VoidMinor: 6,
-kMaterial_WoodPlank: 7,
-kMaterial_Cliff: 16,
-kMaterial_Soil: 17,
-kMaterial_CliffLight: 18,
-kMaterial_WallDamaged: 19,
-kMaterial_Wall: 20,
-kMaterial_Gold: 21,
-kMaterial_Glacier: 22,
-kMaterial_TileCeiling: 23,
-kMaterial_TileFloor: 24,
-kMaterial_TileWall: 25,
-kMaterial_WallBrick: 26,
-kMaterial_SoilWet: 27,
-kMaterial_CliffWet: 28,
-kMaterial_Bone: 29,
-kMaterial_Wood: 30,
-kMaterial_Ceramics: 31,
-kMaterial_Sand: 32,
-kMaterial_SandWet: 33,
-kMaterial_SandLight: 34,
-kMaterial_Snow: 35,
-kMaterial_SandDeep: 36,
-kMaterial_Mud: 37,
-kMaterial_Grass: 48,
-kMaterial_GrassWet: 49,
-kMaterial_GrassLight: 50,
-kMaterial_GrassMoss: 51,
-kMaterial_Cloth: 52,
-kMaterial_Cloud: 80,
-```

package/level_example/HTNH_Test/HTNH_Test.Objects.level.json

@@ -1,258 +0,0 @@
-{
-  "classes": {
-    "Clump": {
-      "data": "arr>ref"
-    },
-    "Marker": {
-      "enabled": "raw>b01",
-      "scale": "raw>b16",
-      "quat": "raw>b16",
-      "pos": "raw>b16"
-    },
-    "AvatarSetPos": {
-      "autoStart": "raw>b01",
-      "randomGroundInMarker": "raw>b01",
-      "setLevelStartPosition": "raw>b01",
-      "onGround": "raw>b01",
-      "relMarker": "raw>ref",
-      "marker": "raw>ref",
-      "breakHandHold": "raw>b01",
-      "bstGuid": "raw>b04",
-      "killMomentum": "raw>b01"
-    },
-    "OnLevelStart": {
-      "autoStart": "raw>b01",
-      "onlyOnWorldLoad": "raw>b01",
-      "events": "raw>ref",
-      "skipOnWorldLoad": "raw>b01"
-    },
-    "MeditationArea": {
-      "transform": "raw>b64",
-      "spawnSeatDelay": "raw>b04",
-      "camCustomFadeIn": "raw>b04",
-      "enabled": "raw>b01",
-      "confirmHintText": "raw>str",
-      "dialogType": "raw>b01",
-      "spawnSeatTail": "raw>b01",
-      "needSit": "raw>b01",
-      "spawnSeatCameraDist": "raw>b04",
-      "goals": "raw>ref",
-      "meditationSound": "raw>str",
-      "holyAreas": "raw>ref",
-      "disableMergeWithAnyProgress": "raw>b01",
-      "onlyFireWhenLocalPresent": "raw>b01",
-      "fullBonus": "raw>b04",
-      "camCustomFadeOut": "raw>b04",
-      "localOnly": "raw>b01",
-      "confirmHintIcon": "raw>str",
-      "minimumLocalPresentTime": "raw>b04",
-      "altar": "raw>ref",
-      "minRequired": "raw>b04",
-      "type": "raw>b01",
-      "onSitPressed": "raw>ref",
-      "time": "raw>b04",
-      "spawnSeatFX": "raw>b01",
-      "progressObjs": "raw>ref",
-      "spawnSeatFXBrightnessMult": "raw>b04",
-      "sitIconOverride": "raw>str",
-      "keyFrame": "raw>ref",
-      "spawnSeatSFX": "raw>b01",
-      "onMenuConfirm": "raw>ref",
-      "onMenuCancel": "raw>ref",
-      "onComplete": "raw>ref",
-      "progressOut": "raw>ref"
-    },
-    "OnBubbleButton": {
-      "autoStart": "raw>b01",
-      "activeDistance": "raw>b04",
-      "buttonTarget": "raw>ref",
-      "useAvatar": "raw>b01",
-      "showInSharedSpaceEditMode": "raw>b01",
-      "fireOnce": "raw>b01",
-      "ignoreAllowUI": "raw>b01",
-      "displayDuration": "raw>b04",
-      "networkedOnHandhold": "raw>b01",
-      "iconName": "raw>str",
-      "priority": "raw>b04",
-      "events": "raw>ref",
-      "cooldownAfterPressed": "raw>b04"
-    },
-    "Enable": {
-      "autoStart": "raw>b01",
-      "objects": "raw>ref",
-      "killEvents": "raw>b01",
-      "enable": "raw>b01",
-      "bstGuid": "raw>b04",
-      "selectObjectRandomly": "raw>b01"
-    }
-  },
-  "objects": {
-    "OnLevelStart>OnLevelStart_Trigger": {
-      "autoStart": true,
-      "onlyOnWorldLoad": 0,
-      "events": "Clump>OnLevelStart_Listeners",
-      "skipOnWorldLoad": 0
-    },
-    "AvatarSetPos>EntryPoint": {
-      "autoStart": false,
-      "randomGroundInMarker": 0,
-      "setLevelStartPosition": 1,
-      "onGround": 1,
-      "relMarker": null,
-      "marker": "Marker>BstNode_3",
-      "breakHandHold": 0,
-      "bstGuid": 1,
-      "killMomentum": 0
-    },
-    "Marker>BstNode_3": {
-      "enabled": true,
-      "scale": {
-        "x": 1,
-        "y": 1,
-        "z": 1,
-        "w": 0
-      },
-      "quat": {
-        "x": 0,
-        "y": 0,
-        "z": 0,
-        "w": 1
-      },
-      "pos": {
-        "x": 0,
-        "y": 0.5,
-        "z": 0,
-        "w": 0
-      }
-    },
-    "Marker>Marker_2": {
-      "enabled": true,
-      "scale": {
-        "x": 1,
-        "y": 1,
-        "z": 1,
-        "w": 0
-      },
-      "quat": {
-        "x": 0,
-        "y": 0,
-        "z": 0,
-        "w": 1
-      },
-      "pos": {
-        "x": 0,
-        "y": 0.5,
-        "z": 0,
-        "w": 0
-      }
-    },
-    "Clump>OnLevelStart_Listeners": {
-      "data": [
-        "AvatarSetPos>EntryPoint"
-      ]
-    },
-    "Clump>MeditationEnd_1": {
-      "data": [
-        "AvatarSetPos>EntryPoint",
-        "Enable>EnableMeditation",
-        "OnBubbleButton>BstNode_1898217744"
-      ]
-    },
-    "Clump>MeditationAreaClump": {
-      "data": [
-        "MeditationArea>BstNode_100"
-      ]
-    },
-    "Enable>EnableMeditation": {
-      "autoStart": false,
-      "objects": "Clump>MeditationAreaClump",
-      "killEvents": 0,
-      "enable": 1,
-      "bstGuid": 1232312,
-      "selectObjectRandomly": 0
-    },
-    "MeditationArea>BstNode_100": {
-      "transform": {
-        "matrix": [
-          [
-            1,
-            0,
-            0,
-            0
-          ],
-          [
-            0,
-            1,
-            0,
-            0
-          ],
-          [
-            0,
-            0,
-            1,
-            0
-          ],
-          [
-            2,
-            0.05,
-            2,
-            1
-          ]
-        ],
-        "pos": {
-          "x": 2,
-          "y": 0.05,
-          "z": 2
-        }
-      },
-      "spawnSeatDelay": 0,
-      "camCustomFadeIn": -1,
-      "enabled": true,
-      "confirmHintText": "hint.meditation.test.1",
-      "dialogType": 0,
-      "spawnSeatTail": 1,
-      "needSit": 1,
-      "spawnSeatCameraDist": 0,
-      "goals": null,
-      "meditationSound": "Pray_Loop",
-      "holyAreas": null,
-      "disableMergeWithAnyProgress": 1,
-      "onlyFireWhenLocalPresent": 0,
-      "fullBonus": 2,
-      "camCustomFadeOut": -1,
-      "localOnly": 1,
-      "confirmHintIcon": "",
-      "minimumLocalPresentTime": 0,
-      "altar": null,
-      "minRequired": 0,
-      "type": 0,
-      "onSitPressed": null,
-      "time": 2,
-      "spawnSeatFX": 1,
-      "progressObjs": null,
-      "spawnSeatFXBrightnessMult": 1,
-      "sitIconOverride": "UiMenuPresent",
-      "keyFrame": null,
-      "spawnSeatSFX": 0,
-      "onMenuConfirm": null,
-      "onMenuCancel": null,
-      "onComplete": "Clump>MeditationEnd_1",
-      "progressOut": null
-    },
-    "OnBubbleButton>BstNode_1898217744": {
-      "autoStart": false,
-      "activeDistance": 3,
-      "buttonTarget": null,
-      "useAvatar": 1,
-      "showInSharedSpaceEditMode": 0,
-      "fireOnce": 0,
-      "ignoreAllowUI": 0,
-      "displayDuration": 0,
-      "networkedOnHandhold": 0,
-      "iconName": "UiMiscStarCluster",
-      "priority": 1,
-      "events": "Clump>OnLevelStart_Listeners",
-      "cooldownAfterPressed": 0
-    }
-  }
-}

package/level_example/HTNH_Test/HTNH_Test.obj

@@ -1,46 +0,0 @@
-# Blender 4.3.2
-# www.blender.org
-mtllib 测试1.mtl
-o Cube.001
-v 10.000000 -0.000002 -10.000000
-v 10.000000 -1.000002 -10.000000
-v 10.000000 0.000002 10.000000
-v 10.000000 -0.999998 10.000000
-v -10.000000 -0.000002 -10.000000
-v -10.000000 -1.000002 -10.000000
-v -10.000000 0.000002 10.000000
-v -10.000000 -0.999998 10.000000
-vn -0.0000 1.0000 -0.0000
-vn -0.0000 -0.0000 1.0000
-vn -1.0000 -0.0000 -0.0000
-vn -0.0000 -1.0000 -0.0000
-vn 1.0000 -0.0000 -0.0000
-vn -0.0000 -0.0000 -1.0000
-vt 0.875000 0.500000
-vt 0.625000 0.750000
-vt 0.625000 0.500000
-vt 0.375000 1.000000
-vt 0.375000 0.750000
-vt 0.375000 0.000000
-vt 0.625000 0.250000
-vt 0.375000 0.250000
-vt 0.375000 0.500000
-vt 0.125000 0.750000
-vt 0.125000 0.500000
-vt 0.875000 0.750000
-vt 0.625000 1.000000
-vt 0.625000 0.000000
-s 1
-usemtl kMaterial_Grass
-f 5/1/1 3/2/1 1/3/1
-f 3/2/2 8/4/2 4/5/2
-f 8/6/3 5/7/3 6/8/3
-f 2/9/4 8/10/4 6/11/4
-f 1/3/5 4/5/5 2/9/5
-f 5/7/6 2/9/6 6/8/6
-f 5/1/1 7/12/1 3/2/1
-f 3/2/2 7/13/2 8/4/2
-f 8/6/3 7/14/3 5/7/3
-f 2/9/4 4/5/4 8/10/4
-f 1/3/5 3/2/5 4/5/5
-f 5/7/6 1/3/6 2/9/6

package/level_example/HTNH_Test/Makefile

@@ -1,11 +0,0 @@
-MAKEFLAGS += -s
-
-LEVEL_BULID = node ../../main.js
-
-all: HTNH_Test.BstBaked.meshes HTNH_Test.Objects.level.bin
-
-HTNH_Test.BstBaked.meshes: HTNH_Test.obj
-	$(LEVEL_BULID) --convert -i $< -o $@
-
-HTNH_Test.Objects.level.bin: HTNH_Test.Objects.level.json
-	$(LEVEL_BULID) --serialize -i $< -o $@

package/src/formats/triangleMesh.js

@@ -1,82 +0,0 @@
-const { kMaterial } = require("../level/enums/kMaterial.js");
-const { Vec3 } = require("../utils/vector.js");
-
-class TriangleMeshVertex {
-  constructor(pos, normal) {
-    this.pos = pos || new Vec3();
-    this.normal = normal || new Vec3();
-    /** A list of vertices considered adjacent to the current vertex. */
-    this.nearby = new Set();
-  }
-}
-
-class TriangleMeshMaterial {
-  static Null = new TriangleMeshMaterial();
-  static Default = new TriangleMeshMaterial("kMaterial_Cliff");
-
-  static isNull(mat) {
-    return mat == TriangleMeshMaterial.Null;
-  }
-
-  constructor(name) {
-    this.name = name || "";
-  }
-
-  getId() {
-    if (this.name.substring(0, 10) !== "kMaterial_")
-      return 0;
-    return kMaterial[this.name.substring(10)];
-  }
-}
-
-class TriangleMeshMaterialBarn {
-  constructor() {
-    this.materials = new Map();
-  }
-
-  initialize() {
-    this.materials.clear();
-    this.materials.set("", TriangleMeshMaterial.Null);
-  }
-
-  tryAddMaterial(name) {
-    if (this.materials.has(name))
-      return this.materials.get(name);
-
-    var result = new TriangleMeshMaterial(name);
-    this.materials.set(name, result);
-
-    return result;
-  }
-}
-
-class TriangleMeshFace {
-  constructor() {
-    this.materialRef = TriangleMeshMaterial.Null;
-    this.indices = [];
-  }
-}
-
-class TriangleMesh {
-  constructor() {
-    this.cmdBuffer = [];
-    this.vtxBuffer = [];
-    this.materials = new TriangleMeshMaterialBarn();
-
-    this.clear();
-  }
-
-  clear() {
-    this.cmdBuffer = [];
-    this.vtxBuffer = [];
-    this.materials.initialize();
-  }
-}
-
-module.exports = {
-  TriangleMeshVertex,
-  TriangleMeshMaterial,
-  TriangleMeshMaterialBarn,
-  TriangleMeshFace,
-  TriangleMesh
-};

package/src/formats/wavefront.js

@@ -1,148 +0,0 @@
-const { R8G8B8A8_SNORM } = require("../utils/normVec.js");
-const { Vec3 } = require("../utils/vector");
-const {
-  TriangleMesh,
-  TriangleMeshVertex,
-  TriangleMeshMaterial,
-  TriangleMeshMaterialBarn,
-  TriangleMeshFace
-} = require("./triangleMesh.js");
-
-/**
- * Parse a Wavefront OBJ string into vertices, indices, and per-triangle
- * material names. Only vertex positions and face indices are extracted.
- * Returns an object with vertices (array of [x, y, z]), indices
- * (flattened triangle index list), and materials (material name per
- * triangle). If no usemtl is given, "" is used.
- * 
- * @param {string} objStr 
- * @param {TriangleMeshMaterialBarn} materialBarn 
- */
-function parseObj(objStr, materialBarn) {
-  // Split the file content into lines.
-  var lines = objStr.split("\n")
-    // Storage for raw vertex positions and normals.
-    , positions = []
-    , normals = []
-    , positionRefs = []
-    // Current material name, defaults to "".
-    , currentMtl = ""
-    // Map from combined position/normal keys to vertex indices.
-    , vertexMap = {}
-    // Output arrays.
-    , vertices = []
-    , faces = [];
-
-  // Process every line.
-  for (var i = 0; i < lines.length; i++) {
-    var line = lines[i].trim();
-    // Skip empty lines and comments.
-    if (line === "" || line.charAt(0) === "#")
-      continue;
-
-    var parts = line.split(/\s+/);
-    var keyword = parts[0];
-
-    if (keyword === "v") {
-      // Store a vertex position.
-      positionRefs[positions.length] = new Set();
-      positions.push(new Vec3(
-        parseFloat(parts[1]),
-        parseFloat(parts[2]),
-        parseFloat(parts[3])
-      ));
-    } else if (keyword === "vn") {
-      // Store a vertex normal.
-      normals.push(new R8G8B8A8_SNORM(
-        parseFloat(parts[1]),
-        parseFloat(parts[2]),
-        parseFloat(parts[3])
-      ));
-    } else if (keyword === "usemtl") {
-      // Switch active material.
-      currentMtl = parts[1] || "";
-    } else if (keyword === "f") {
-      // Parse a face definition.
-      var faceIndices = [];
-      var material = currentMtl;
-
-      // Loop through each vertex reference in the face.
-      for (var j = 1; j < parts.length; j++) {
-        var token = parts[j];
-        var subParts = token.split("/");
-        var posIdx = parseInt(subParts[0], 10);
-        var normIdx = null;
-
-        // Extract normal index when available (third component).
-        if (subParts.length >= 3 && subParts[2] !== "")
-          normIdx = parseInt(subParts[2], 10);
-
-        // Resolve negative indices relative to the end of the lists.
-        if (posIdx < 0)
-          posIdx = positions.length + 1 + posIdx;
-        if (normIdx !== null && normIdx < 0)
-          normIdx = normals.length + 1 + normIdx;
-
-        // Build a unique key based on position and normal pair.
-        var normKey = normIdx !== null
-          ? normIdx
-          : "none";
-        var key = posIdx + "," + normKey;
-
-        // Add a new vertex if the pair hasn't been seen.
-        if (!vertexMap.hasOwnProperty(key)) {
-          if (posIdx - 1 > positions.length)
-            throw new Error("encountered invalid vertex pos");
-          if (normIdx - 1 > normals.length)
-            throw new Error("encountered invalid vertex normal");
-
-          var pos = positions[posIdx - 1]
-            , posRef = positionRefs[posIdx - 1]
-            , norm = (normIdx !== null && normals[normIdx - 1])
-              ? normals[normIdx - 1]
-              : [0, 1, 0];
-
-          var vtx = new TriangleMeshVertex(pos, norm);
-          vtx.nearby = posRef;
-
-          vertexMap[key] = vertices.length;
-          posRef.add(vtx);
-          vertices.push(vtx);
-        }
-        // Record the index for the face.
-        faceIndices.push(vertexMap[key]);
-      }
-      // Store the face with its material.
-      var face = new TriangleMeshFace();
-      face.indices = faceIndices;
-      face.materialRef = materialBarn.tryAddMaterial(material);
-      faces.push(face);
-    }
-    // Other OBJ keywords (vt, g, o, s, mtllib, etc.) are ignored.
-  }
-
-  // Return the assembled vertices and indexed faces.
-  return { vertices: vertices, faces: faces };
-}
-
-class WavefrontObj extends TriangleMesh {
-  constructor() {
-    super();
-  }
-
-  /**
-   * @param {Buffer} fileBuffer 
-   */
-  fromFileBuffer(fileBuffer) {
-    this.clear();
-
-    var raw = parseObj(fileBuffer.toString("uit-8"), this.materials);
-
-    this.vtxBuffer = raw.vertices;
-    this.cmdBuffer = raw.faces;
-  }
-}
-
-module.exports = {
-  WavefrontObj
-};