feat(Settings): add support for uncompressed fts files for Arx Libert…

…atis 1.3+

.env.sample

@@ -45,3 +45,9 @@ seed=12345
 # can be either "production" or "development"
 # the default value is "production"
 mode=production
+
+# Whether to compress the FTS file with pkware after compiling, or keep it uncompressed
+# can be either "true" or "false"
+# the default value is "false"
+# uncompressed FTS is an Arx Libertatis 1.3+ feature, so it should be disabled when releasing a map
+uncompressedFTS=false

package.json

@@ -102,7 +102,7 @@
     "sharp-bmp": "^0.1.5"
   },
   "peerDependencies": {
-    "arx-convert": "^8.2.0",
+    "arx-convert": "^9.0.0",
     "three": "0.158.0"
   },
   "devDependencies": {
@@ -122,4 +122,4 @@
   "keywords": [
     "arx-fatalis"
   ]
-}
+}

src/Settings.ts

@@ -91,6 +91,11 @@ type SettingsConstructorProps = {
    * default value is "production"
    */
   mode?: Modes
+  /**
+   * When this is set to true FTS files will not get compressed with pkware
+   * after compiling. This is an Arx Libertatis 1.3+ feature!
+   */
+  uncompressedFTS?: boolean
 }
 
 export class Settings {
@@ -167,6 +172,12 @@ export class Settings {
    */
   readonly internalAssetsDir: string
 
+  /**
+   * When this is set to true FTS files will not get compressed with pkware
+   * after compiling. This is an Arx Libertatis 1.3+ feature!
+   */
+  readonly uncompressedFTS: boolean
+
   constructor(props: SettingsConstructorProps = {}) {
     this.originalLevelFiles =
       props.originalLevelFiles ?? process.env.originalLevelFiles ?? path.resolve('../pkware-test-files')
@@ -186,6 +197,8 @@ export class Settings {
     this.seed = props.seed ?? process.env.seed ?? randomIntBetween(100_000_000, 999_999_999).toString()
     this.mode = props.mode ?? (process.env.mode === 'development' ? process.env.mode : 'production')
 
+    this.uncompressedFTS = props.uncompressedFTS ?? process.env.uncompressedFTS === 'true'
+
     seedrandom(this.seed, { global: true })
 
     const __filename = fileURLToPath(import.meta.url)

src/compile.ts

@@ -17,29 +17,36 @@ const compileFTS = async (settings: Settings, fts: ArxFTS) => {
   const ftsPath = path.join(settings.outputDir, `game/graph/levels/level${settings.levelIdx}`)
 
   const repackedFts = FTS.save(fts)
-  const { total: ftsHeaderSize } = getHeaderSize(repackedFts, 'fts')
 
-  return new Promise((resolve, reject) => {
-    const writeStream = fs.createWriteStream(path.join(ftsPath, 'fast.fts'))
-    writeStream
-      .on('close', () => {
-        resolve(true)
-      })
-      .on('error', (e) => {
-        reject(e)
-      })
-    Readable.from(repackedFts)
-      .pipe(
-        through(
-          transformSplitBy(
-            splitAt(ftsHeaderSize),
-            transformIdentity(),
-            implode(Compression.Binary, DictionarySize.Large),
+  if (settings.uncompressedFTS) {
+    return fs.promises.writeFile(path.join(ftsPath, 'fast.fts'), repackedFts)
+  } else {
+    const { total: ftsHeaderSize } = getHeaderSize(repackedFts, 'fts')
+
+    return new Promise((resolve, reject) => {
+      const writeStream = fs.createWriteStream(path.join(ftsPath, 'fast.fts'))
+
+      writeStream
+        .on('close', () => {
+          resolve(true)
+        })
+        .on('error', (e) => {
+          reject(e)
+        })
+
+      Readable.from(repackedFts)
+        .pipe(
+          through(
+            transformSplitBy(
+              splitAt(ftsHeaderSize),
+              transformIdentity(),
+              implode(Compression.Binary, DictionarySize.Large),
+            ),
           ),
-        ),
-      )
-      .pipe(writeStream)
-  })
+        )
+        .pipe(writeStream)
+    })
+  }
 }
 
 const compileLLF = async (settings: Settings, llf: ArxLLF) => {

src/globals.d.ts

@@ -10,6 +10,7 @@ declare global {
       lightingCalculatorMode?: string
       seed?: string
       mode?: string
+      uncompressedFTS?: string
     }
   }
 }