@noita-ts/create-mod 0.1.2 → 0.1.4

package/dist/index.js

@@ -50,7 +50,8 @@ async function main() {
         placeholder: "A mod written in typescript via noita-ts",
     }));
     const unsafe = cancellable(await p.confirm({
-        message: "Unsafe? (aka 'no API restrictions', prevents publishing to Steam Workshop)",
+        message: "Unsafe? (aka 'no API restrictions', Noita won't load such a mod from " +
+            "the Workshop without a DLL patch)",
         initialValue: false,
     }));
     const author = cancellable(await p.text({
@@ -75,11 +76,10 @@ async function main() {
             },
         ],
     }));
-    const workshop = !unsafe &&
-        cancellable(await p.confirm({
-            message: "Setup (some of) Steam Workshop metadata?",
-            initialValue: true,
-        }));
+    const workshop = cancellable(await p.confirm({
+        message: "Setup (some of) Steam Workshop metadata?",
+        initialValue: true,
+    }));
     let workshopName;
     let workshopDescription;
     if (workshop) {
@@ -104,8 +104,12 @@ async function main() {
         ["noita.name"]: name,
         ["noita.compat"]: 12,
         ...(unsafe ? { ["noita.unsafe"]: true } : {}),
-        ...(workshopName ? { ["noita.workshop.name"]: workshopName } : {}),
-        ...(workshopDescription
+        // both default to what the mod itself is called and says, so they are only
+        // worth writing down when they actually differ
+        ...(workshopName && workshopName !== name
+            ? { ["noita.workshop.name"]: workshopName }
+            : {}),
+        ...(workshopDescription && workshopDescription !== description
             ? { ["noita.workshop.description"]: workshopDescription }
             : {}),
         scripts: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@noita-ts/create-mod",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Scaffold a new noita-ts mod",
   "type": "module",
   "bin": {

package/template/readme.md

@@ -21,7 +21,7 @@ The keys from the `package.json` file used by `nts` to produce a mod:
 - `"noita.description": "An example mod written in TypeScript using noita-ts"`\
   Description of the mod shown in-game, defaults to package description.
 - `"noita.unsafe": false`\
-  Sets the `"request_no_api_restrictions"="1"` key in mod.xml - unsafe mods cannot be published to the workshop and must be installed manually, but are not sandboxed - meaning you can do network/file access, ffi and literally anything at all, including being a crypto miner.
+  Sets the `"request_no_api_restrictions"="1"` key in mod.xml - unsafe mods are not sandboxed, meaning you can do network/file access, ffi and literally anything at all, including being a crypto miner. `nts publish` will upload one anyway once you confirm it: Noita refuses to load an unsafe mod that came from the workshop, so subscribers need a DLL patch for it to run and installing it manually is the usual way. `--via-game` refuses outright, since the game will not upload one.
 - `"noita.workshop.id": 0`\
   This will be set by the publish command automatically. If you want to publish the mod as a separate workshop item (e.g. after deleting the original), remove this, otherwise don't touch it
 - `"noita.workshop.name": "Example TypeScript Mod"`\
@@ -29,13 +29,13 @@ The keys from the `package.json` file used by `nts` to produce a mod:
 - `"noita.workshop.description": "Uploaded to the workshop!"`\
   The description of the mod on the steam workshop page, defaults to value of `noita.description`.
 - `"noita.workshop.tags": []`\
-  Tags for the mod on the steam workshop page, just sets the corresponding key in `mod.xml`.
+  Tags for the mod on the steam workshop page. Steam only accepts the tags Noita declares, and `nts publish` rejects anything else up front: `gameplay`, `graphics`, `quality of life`, `translations`, `perks`, `spells`, `player characters`, `loadouts`, `biomes`, `total conversions`, `game modes`, `creatures`, `bosses`, `alchemy`, `tweaks`, `items`, `audio`, `cheats`, `funny`, `streaming integration`, `mod dependencies`.
 - `"noita.workshop.skip-files": []`\
-  Files to skip when uploading to the workshop, just sets the corresponding key in `mod.xml`.
+  Files to leave out of the workshop upload, as paths relative to the mod root.
 - `"noita.workshop.skip-folders": []`\
-  Folders to skip when uploading to the workshop, just sets the corresponding key in `mod.xml`.
+  Folders to leave out of the workshop upload, as paths relative to the mod root - the folder and everything under it is skipped.
 - `"noita.compat": 12`\
-  API compatibility version, should Noita release a big update that changes this number, an icon "this mod has not been tested with latest mod api" will be shown in the modlist.
+  API compatibility version, should Noita release a big update that changes this number, an icon "this mod has not been tested with latest mod api" will be shown in the modlist. Leaving it out means no `compatibility.xml` and so that icon always shows - the game used to fill this in for you when it did the uploading, and `nts publish` does not.
 - `"noita.ui-newgame-name": null`\
   This and everything below is just setting other mod.xml properties:
   - `"noita.ui-newgame-description": null`

package/template/src/settings.ts

@@ -1,3 +1,5 @@
+/// <reference types="@noita-ts/base" />
+
 // By doing settings in such a way, we can have auto-completable
 //`mod.settings.checkbox` anywhere, and it would also have a correct `boolean`
 // type.