risupack 0.1.0 → 0.1.1

package/README.md

@@ -94,19 +94,80 @@ Use the following manifest structure.
     {
       "bundle": true,
       "lowLevelAccess": true,
-      "lua": "triggers/main.lua",
-      "type": "start"
+      "lua": "triggers/main.lua"
     }
   ],
   "version": "1.0.0"
 }
 ```
 
-Use `{ "content": "..." }` instead of a file path only when a `CSS`, `toggles`, or lorebook source must remain inline.
+## Manifest fields
+
+- `name`: Required non-empty module name.
+- `namespace`: RisuAI module namespace.
+- `version`: Packaged module version.
+- `description`: Packaged module description.
+- `creator`: Package creator name.
+- `license`: Package license identifier or text.
+- `tags`: Array of package tags. Defaults to an empty array.
+- `output`: Output path used when the CLI output argument is omitted. Defaults to `../dist/<sanitized-name>.charx` relative to the manifest directory.
+- `CSS`: Custom CSS source.
+- `toggles`: Module toggle source.
+- `icon`: Main module icon path. The builder supplies an empty default icon when omitted.
+- `hideIcon`: Hides the module icon in chat when `true`. Defaults to `false`.
+- `lowLevelAccess`: Enables module-level low-level access when `true`. Defaults to `false`.
+- `folders`: Lorebook folder names to create even when no lorebook entry references them.
+- `assets`: Additional packaged assets.
+- `lorebook`: Lorebook entries.
+- `regex`: Regex entries in execution order.
+- `triggers`: Lua trigger entries.
+
+## Source values
+
+`CSS`, `toggles`, and lorebook sources accept a path string, a file object, or inline content.
+
+```json
+{
+  "CSS": "styles/main.html",
+  "toggles": { "file": "toggles.txt" },
+  "lorebook": [
+    {
+      "comment": "inline",
+      "content": "Inline lorebook content"
+    }
+  ]
+}
+```
+
+When a source object contains both `content` and `file`, `content` takes precedence. A bundled Lua lorebook requires `file`.
+
+## Lorebook entries
+
+- `file`: Lorebook source path. Required unless `content` is provided.
+- `content`: Inline lorebook source.
+- `comment`: Lorebook name. Defaults to the source file basename.
+- `alwaysActive`: Enables constant activation. Defaults to `false`.
+- `activationPercent`: RisuAI activation percentage.
+- `folder`: Display folder name. The builder creates referenced folders automatically.
+- `insertOrder`: Lorebook insertion order. Defaults to `100`.
+- `key`: Comma-separated primary activation keys. Defaults to an empty string.
+- `secondaryKey`: Comma-separated secondary activation keys. Defaults to an empty string.
+- `selective`: Enables secondary-key matching. Defaults to `false`.
+- `mode`: RisuAI lorebook mode. Defaults to `normal`.
+- `useRegex`: Treats activation keys as regular expressions when `true`. Defaults to `false`.
+- `extentions`: RisuAI-specific lorebook extension values. Use this exact spelling.
+- `bundle`: Bundles the Lua source and its `require()` dependencies when `true`. Defaults to `false`.
+- `bundleOutput`: Optional path for retaining the bundled Lua artifact.
 
 ## Lua triggers
 
-Set trigger `lua` to the unbundled entry file. Omit `bundle` or set `bundle` to `true` to let the CharX builder invoke the Lua bundler and embed the bundled code.
+Define Lua triggers with `lua`. Do not specify `effect`, `conditions`, or `type` for Lua triggers.
+
+- `lua`: Unbundled Lua entry file. Required.
+- `bundle`: Bundles the entry file and its `require()` dependencies. Defaults to `true`.
+- `bundleOutput`: Optional path for retaining the bundled Lua artifact.
+- `comment`: Trigger name. Defaults to an empty string.
+- `lowLevelAccess`: Enables low-level access for the trigger.
 
 Omit `bundleOutput` for normal CharX builds. The builder uses a temporary output and removes it after packaging. Set `bundleOutput` only when a standalone bundled Lua artifact is required.
 
@@ -134,6 +195,27 @@ Use the frontmatter keys `ableFlag`, `comment`, `flag`, and `type`. Omit `flag`
 
 List regex file paths in execution order in the manifest `regex` array.
 
+Regex entries accept a file path, a file object, or an inline object.
+
+```json
+{
+  "regex": [
+    "regex/display.md",
+    { "file": "regex/request.md" },
+    {
+      "ableFlag": true,
+      "comment": "Inline",
+      "flag": "gs",
+      "in": "input pattern",
+      "out": "replacement",
+      "type": "editdisplay"
+    }
+  ]
+}
+```
+
+Inline regex entries require string values for both `in` and `out`. `ableFlag` defaults to `true`, `comment` defaults to an empty string, and `type` defaults to `editdisplay`.
+
 ## Lorebooks
 
 Include Markdown prompts in the manifest `lorebook` array.
@@ -144,7 +226,13 @@ Set lorebook `bundle` to `true` when RisuAI must receive bundled Lua as lorebook
 
 ## Assets
 
-List additional packaged files in the manifest `assets` array. Set `file` and the RisuAI lookup `name`. Set `extension` only when the file extension cannot be inferred from `file`.
+List additional packaged files in the manifest `assets` array.
+
+- `file`: Asset source path. Required.
+- `name`: RisuAI asset lookup name. Defaults to the source filename without its extension.
+- `extension`: Packaged extension without a leading dot. Defaults to the source file extension and accepts lowercase letters and digits.
+
+Archive entry names replace unsupported characters and add numeric suffixes to resolve collisions.
 
 ## Programmatic API
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "risupack",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Command-line tools for packing and unpacking RisuAI modules",
   "license": "AGPL-3.0-only",
   "bin": {