Updated for SPT 3.8

Author: refringe

.editorconfig

@@ -5,4 +5,7 @@ end_of_line = lf
 insert_final_newline = true
 charset = utf-8
 indent_style = space
-indent_size = 4
+indent_size = 4
+
+[*.{yml,yaml}]
+indent_size = 2

.github/ISSUE_TEMPLATE/GENERAL.yml

@@ -3,44 +3,41 @@ description: File a general bug report
 title: "[Bug]: "
 labels: ["triage"]
 assignees:
-    - refringe
+  - refringe
 body:
-    - type: markdown
-      attributes:
-          value: Thank you for taking the time to fill out a bug report!
-    - type: input
-      id: discord-username
-      attributes:
-          label: Discord Username
-          description: If we need more information, can we contact you on the SPT discord? What's your username?
-      validations:
-          required: false
-    - type: textarea
-      id: what-happened
-      attributes:
-          label: What happened?
-          description: Also tell us, what did you expect to happen?
-          placeholder: Tell us what you see!
-          value: "A bug happened!"
-      validations:
-          required: true
-    - type: dropdown
-      id: version
-      attributes:
-          label: SPT Version
-          description: What version of SPT are you running?
-          options:
-              - master
-              - 3.7.1
-              - 3.7.0
-              - 3.6.0
-      validations:
-          required: true
-    - type: textarea
-      id: server-log
-      attributes:
-          label: Server Log
-          description: Please paste the *entire* relevant server log (found in `user/logs/` directory) into this field.
-          render: shell
-      validations:
-          required: true
+  - type: markdown
+    attributes:
+      value: Thank you for taking the time to fill out a bug report!
+  - type: input
+    id: discord-username
+    attributes:
+      label: Discord Username
+      description: If we need more information, can we contact you on the SPT discord? What's your username?
+    validations:
+      required: false
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Also tell us, what did you expect to happen?
+      placeholder: Tell us what you see!
+      value: "A bug happened!"
+    validations:
+      required: true
+  - type: dropdown
+    id: version
+    attributes:
+      label: SPT Version
+      description: What version of SPT are you running?
+      options:
+        - 3.8.0
+    validations:
+      required: true
+  - type: textarea
+    id: server-log
+    attributes:
+      label: Server Log
+      description: Please paste the *entire* relevant server log (found in `user/logs/` directory) into this field.
+      render: shell
+    validations:
+      required: true

.nvmrc

@@ -1 +1 @@
-v18.15.0
+v20.11.1

.prettierrc

@@ -4,5 +4,13 @@
     "trailingComma": "es5",
     "semi": true,
     "printWidth": 120,
-    "arrowParens": "avoid"
+    "arrowParens": "avoid",
+    "overrides": [
+        {
+            "files": ["*.yml", "*.yaml"],
+                "options": {
+                    "tabWidth": 2
+                }
+        }
+    ]
 }

build.mjs

@@ -26,15 +26,15 @@
  * - The script reads configurations from the `package.json` and `.buildignore` files; ensure they are correctly set up.
  *
  * @author Refringe
- * @version v1.0.0
+ * @version v1.0.1
  */
 
 import archiver from "archiver";
 import fs from "fs-extra";
 import ignore from "ignore";
-import os from "os";
-import path, { dirname } from "path";
-import { fileURLToPath } from "url";
+import os from "node:os";
+import path, { dirname } from "node:path";
+import { fileURLToPath } from "node:url";
 import winston from "winston";
 
 // Get the command line arguments to determine whether to use verbose logging.
@@ -96,9 +96,13 @@ async function main() {
         const packageJson = await loadPackageJson(currentDir);
 
         // Create a descriptive name for the mod package.
-        const projectName = createProjectName(packageJson);
+        const projectName = createProjectName(packageJson, false);
         logger.log("success", `Project name created: ${projectName}`);
 
+        // Create a descriptive name for the ZIP file.
+        const zipFileName = createProjectName(packageJson, true);
+        logger.log("success", `Project package name created: ${zipFileName}`);
+
         // Remove the old distribution directory and create a fresh one.
         const distDir = await removeOldDistDirectory(currentDir);
         logger.log("info", "Distribution directory successfully cleaned.");
@@ -115,13 +119,13 @@ async function main() {
 
         // Create a zip archive of the project files.
         logger.log("info", "Beginning folder compression...");
-        const zipFilePath = path.join(path.dirname(projectDir), `${projectName}.zip`);
-        await createZipFile(projectDir, zipFilePath, "user/mods/" + projectName);
+        const zipFilePath = path.join(path.dirname(projectDir), `${zipFileName}.zip`);
+        await createZipFile(projectDir, zipFilePath, `user/mods/${projectName}`);
         logger.log("success", "Archive successfully created.");
         logger.log("info", zipFilePath);
 
         // Move the zip file inside of the project directory, within the temporary working directory.
-        const zipFileInProjectDir = path.join(projectDir, `${projectName}.zip`);
+        const zipFileInProjectDir = path.join(projectDir, `${zipFileName}.zip`);
         await fs.move(zipFilePath, zipFileInProjectDir);
         logger.log("success", "Archive successfully moved.");
         logger.log("info", zipFileInProjectDir);
@@ -134,23 +138,23 @@ async function main() {
         logger.log("success", "------------------------------------");
         logger.log("success", "Build script completed successfully!");
         logger.log("success", "Your mod package has been created in the 'dist' directory:");
-        logger.log("success", `/${path.relative(process.cwd(), path.join(distDir, `${projectName}.zip`))}`);
+        logger.log("success", `${path.relative(process.cwd(), path.join(distDir, `${zipFileName}.zip`))}`);
         logger.log("success", "------------------------------------");
         if (!verbose) {
             logger.log("success", "To see a detailed build log, use `npm run buildinfo`.");
             logger.log("success", "------------------------------------");
         }
     } catch (err) {
         // If any of the file operations fail, log the error.
-        logger.log("error", "An error occurred: " + err);
+        logger.log("error", `An error occurred: ${err}`);
     } finally {
         // Clean up the temporary directory, even if the build fails.
         if (projectDir) {
             try {
                 await fs.promises.rm(projectDir, { force: true, recursive: true });
                 logger.log("info", "Cleaned temporary directory.");
             } catch (err) {
-                logger.log("error", "Failed to clean temporary directory: " + err);
+                logger.log("error", `Failed to clean temporary directory: ${err}`);
             }
         }
     }
@@ -220,18 +224,21 @@ async function loadPackageJson(currentDir) {
  * @param {Object} packageJson - A JSON object containing the contents of the `package.json` file.
  * @returns {string} A string representing the constructed project name.
  */
-function createProjectName(packageJson) {
+function createProjectName(packageJson, includeVersion = true) {
     // Remove any non-alphanumeric characters from the author and name.
     const author = packageJson.author.replace(/\W/g, "");
     const name = packageJson.name.replace(/\W/g, "");
     const version = packageJson.version;
 
     // Ensure the name is lowercase, as per the package.json specification.
-    return `${author}-${name}-${version}`.toLowerCase();
+    if (includeVersion) {
+        return `${author}-${name}-${version}`.toLowerCase();
+    }
+    return `${author}-${name}`.toLowerCase();
 }
 
 /**
- * Defines the location of the distribution directory where the final mod package will be stored and deletes any 
+ * Defines the location of the distribution directory where the final mod package will be stored and deletes any
  * existing distribution directory to ensure a clean slate for the build process.
  *
  * @param {string} currentDirectory - The absolute path of the current working directory.
@@ -322,7 +329,7 @@ async function copyFiles(srcDir, destDir, ignoreHandler) {
         await Promise.all(copyOperations);
     } catch (err) {
         // Log an error message if any error occurs during the copy process.
-        logger.log("error", "Error copying files: " + err);
+        logger.log("error", `Error copying files: ${err}`);
     }
 }
 
@@ -346,14 +353,14 @@ async function createZipFile(directoryToZip, zipFilePath, containerDirName) {
         });
 
         // Set up an event listener for the 'close' event to resolve the promise when the archiver has finalized.
-        output.on("close", function () {
+        output.on("close", () => {
             logger.log("info", "Archiver has finalized. The output and the file descriptor have closed.");
             resolve();
         });
 
         // Set up an event listener for the 'warning' event to handle warnings appropriately, logging them or rejecting
         // the promise based on the error code.
-        archive.on("warning", function (err) {
+        archive.on("warning", err => {
             if (err.code === "ENOENT") {
                 logger.log("warn", `Archiver issued a warning: ${err.code} - ${err.message}`);
             } else {
@@ -362,7 +369,7 @@ async function createZipFile(directoryToZip, zipFilePath, containerDirName) {
         });
 
         // Set up an event listener for the 'error' event to reject the promise if any error occurs during archiving.
-        archive.on("error", function (err) {
+        archive.on("error", err => {
             reject(err);
         });