rs3-api-ts 0.0.0-stage → 0.1.1

package/dist/libraries.js

@@ -0,0 +1,99 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.catalogPath = catalogPath;
+exports.loadCatalog = loadCatalog;
+exports.findLibrary = findLibrary;
+exports.parseDependencies = parseDependencies;
+exports.toManifestDependencies = toManifestDependencies;
+const fs = __importStar(require("node:fs"));
+const path = __importStar(require("node:path"));
+const errors_1 = require("./errors");
+const project_1 = require("./project");
+let cached;
+function catalogPath() {
+    return path.join((0, project_1.sdkRoot)(), "data", "modio-libraries.json");
+}
+function loadCatalog() {
+    if (cached === undefined) {
+        cached = JSON.parse(fs.readFileSync(catalogPath(), "utf8"));
+    }
+    return cached;
+}
+function findLibrary(nameId) {
+    return loadCatalog().libraries.find((lib) => lib.name_id === nameId);
+}
+/** A bare name has to be in the catalog; `name=id` takes any mod.io id. */
+function parseDependencies(input) {
+    const out = [];
+    for (const raw of input.split(",")) {
+        const entry = raw.trim();
+        if (entry === "") {
+            continue;
+        }
+        const eq = entry.indexOf("=");
+        if (eq > 0) {
+            const name = entry.slice(0, eq).trim();
+            const id = Number(entry.slice(eq + 1).trim());
+            if (!Number.isInteger(id) || id <= 0) {
+                throw new errors_1.CliError(`"${entry}" does not end in a mod.io id`, [
+                    "the part after = is the numeric id from the plugin's mod.io page",
+                    `for example: ${name}=6398181`,
+                ]);
+            }
+            out.push({ name, id });
+            continue;
+        }
+        const known = findLibrary(entry);
+        if (known === undefined) {
+            const names = loadCatalog().libraries.map((l) => l.name_id);
+            throw new errors_1.CliError(`"${entry}" is not in the known library list`, [
+                names.length > 0 ? `known libraries: ${names.join(", ")}` : "the known library list is empty",
+                `if it is not listed, give its mod.io id: ${entry}=123456`,
+                "or refresh the list with: npm run deps:dump",
+            ]);
+        }
+        out.push({ name: known.name_id, id: known.id });
+    }
+    return out;
+}
+/** The client wants identifier -> mod.io id, and `{}` for none. */
+function toManifestDependencies(entries) {
+    const out = {};
+    for (const entry of entries) {
+        out[entry.name] = entry.id;
+    }
+    return out;
+}

package/dist/permissions.js

@@ -0,0 +1,59 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.permissionsPath = permissionsPath;
+exports.loadPermissions = loadPermissions;
+exports.findPermission = findPermission;
+exports.permissionNames = permissionNames;
+const fs = __importStar(require("node:fs"));
+const path = __importStar(require("node:path"));
+let cached;
+function permissionsPath() {
+    const corePackage = require.resolve("rs3-api-core/package.json");
+    return path.join(path.dirname(corePackage), "data", "permissions.json");
+}
+function loadPermissions() {
+    if (cached === undefined) {
+        const file = JSON.parse(fs.readFileSync(permissionsPath(), "utf8"));
+        cached = file.permissions.map((p) => ({ ...p, gates: p.gates.map((g) => new RegExp(g)) }));
+    }
+    return cached;
+}
+function findPermission(name) {
+    return loadPermissions().find((p) => p.name === name);
+}
+function permissionNames() {
+    return loadPermissions().map((p) => p.name);
+}

package/dist/postprocess.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeReadable = makeReadable;
+const LUA_KEYWORDS = new Set([
+    "and", "break", "do", "else", "elseif", "end", "false", "for", "function", "goto", "if", "in",
+    "local", "nil", "not", "or", "repeat", "return", "then", "true", "until", "while",
+]);
+/** Tidies TypeScriptToLua output for release builds. Dev bundles are left alone. */
+function makeReadable(code) {
+    let out = code;
+    if (!/\bM\b/.test(out.replace(/____exports/g, ""))) {
+        out = out.replace(/____exports/g, "M");
+    }
+    out = out.replace(/\bfor ____, /g, "for _, ");
+    // @noSelf tags are copied through from the TypeScript but only mean something to the compiler.
+    out = out.replace(/^-- ?\n(?=-- @noSelf)/gm, "").replace(/^-- @noSelf\w*\n/gm, "");
+    // local ____rs3_2Dapi_2Dextended = require(...)  ->  local ext = require(...)
+    for (const match of out.matchAll(/^local (____[A-Za-z][A-Za-z0-9_]*) = require\("([^"]+)"\)$/gm)) {
+        const mangled = match[1];
+        const modulePath = match[2];
+        const candidate = /rs3-api-extended/.test(modulePath) ? "ext" : mangled.slice(4).replace(/_2D/g, "_");
+        if (!/^[A-Za-z_][A-Za-z0-9_]*$/.test(candidate) || LUA_KEYWORDS.has(candidate)) {
+            continue;
+        }
+        const taken = new RegExp(`\\b${candidate}\\b`).test(out.split(mangled).join(""));
+        if (!taken) {
+            out = out.split(mangled).join(candidate);
+        }
+    }
+    // The client turns require("a.b") into the path a.b.lua, so module paths need slashes.
+    out = out.replace(/require\("([^"]+)"\)/g, (_match, modulePath) => {
+        return `require("${modulePath.replace(/\./g, "/")}")`;
+    });
+    out = out.replace(/[ \t]+$/gm, "");
+    return out.endsWith("\n") ? out : `${out}\n`;
+}

package/dist/project.js

@@ -0,0 +1,98 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadProject = loadProject;
+exports.sdkRoot = sdkRoot;
+exports.sdkVersion = sdkVersion;
+const fs = __importStar(require("node:fs"));
+const path = __importStar(require("node:path"));
+const tstl = __importStar(require("typescript-to-lua"));
+const errors_1 = require("./errors");
+function loadProject(cwd) {
+    const tsconfigPath = path.join(cwd, "tsconfig.json");
+    if (!fs.existsSync(tsconfigPath)) {
+        throw new errors_1.CliError("no tsconfig.json here, so there is no plugin to build", [
+            `looked in ${cwd}`,
+            "run this from the plugin folder, or scaffold one with: rs3-plugin init my-plugin",
+        ]);
+    }
+    const parsed = tstl.parseConfigFileWithSystem(tsconfigPath);
+    const srcDir = parsed.options.rootDir ?? path.join(cwd, "src");
+    const outDir = parsed.options.outDir ?? path.join(cwd, "dist");
+    const manifestPath = path.join(cwd, "plugin.json");
+    let manifest;
+    let manifestError;
+    if (!fs.existsSync(manifestPath)) {
+        manifestError = "plugin.json is missing";
+    }
+    else {
+        try {
+            manifest = JSON.parse(fs.readFileSync(manifestPath, "utf8"));
+        }
+        catch (error) {
+            manifestError = `plugin.json is not valid JSON: ${error instanceof Error ? error.message : String(error)}`;
+        }
+    }
+    let packageJson;
+    const packageJsonPath = path.join(cwd, "package.json");
+    if (fs.existsSync(packageJsonPath)) {
+        try {
+            packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf8"));
+        }
+        catch {
+            packageJson = undefined;
+        }
+    }
+    return {
+        cwd,
+        tsconfigPath,
+        manifestPath,
+        manifest,
+        manifestError,
+        srcDir,
+        outDir,
+        entryFile: path.join(srcDir, "main.ts"),
+        parsed,
+        packageJson,
+        syncVersion: packageJson?.rs3?.syncVersion === true,
+    };
+}
+function sdkRoot() {
+    return path.resolve(__dirname, "..");
+}
+function sdkVersion() {
+    const pkg = JSON.parse(fs.readFileSync(path.join(sdkRoot(), "package.json"), "utf8"));
+    return pkg.version;
+}

package/dist/prompt.js

@@ -0,0 +1,160 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.text = text;
+exports.confirm = confirm;
+exports.multiSelect = multiSelect;
+const readline = __importStar(require("node:readline"));
+const node_process_1 = require("node:process");
+/** Re-asks until the validator is happy. */
+async function text(question, fallback, validate) {
+    for (;;) {
+        const raw = (await ask(fallback !== undefined ? `${question} (${fallback}): ` : `${question}: `)).trim();
+        const value = raw === "" && fallback !== undefined ? fallback : raw;
+        const error = validate(value);
+        if (error === undefined) {
+            return value;
+        }
+        node_process_1.stdout.write(`  ${error}\n`);
+    }
+}
+async function confirm(question, fallback) {
+    for (;;) {
+        const raw = (await ask(`${question} [${fallback ? "Y/n" : "y/N"}]: `)).trim().toLowerCase();
+        if (raw === "") {
+            return fallback;
+        }
+        if (raw === "y" || raw === "yes") {
+            return true;
+        }
+        if (raw === "n" || raw === "no") {
+            return false;
+        }
+        node_process_1.stdout.write("  answer y or n\n");
+    }
+}
+/** Up and down move, space toggles, `a` toggles all, enter confirms. One boolean per item. */
+function multiSelect(question, items, preselected = []) {
+    if (items.length === 0) {
+        return Promise.resolve([]);
+    }
+    return new Promise((resolve) => {
+        const selected = items.map((_, i) => preselected[i] === true);
+        let cursor = 0;
+        let drawn = false;
+        const frame = () => {
+            const lines = [`${question}  (up/down move, space toggles, a toggles all, enter confirms)`];
+            items.forEach((item, i) => {
+                const pointer = i === cursor ? ">" : " ";
+                const box = selected[i] ? "[x]" : "[ ]";
+                const hint = item.hint !== undefined ? `  ${dim(item.hint)}` : "";
+                lines.push(`${pointer} ${box} ${item.label}${hint}`);
+            });
+            return lines;
+        };
+        const draw = () => {
+            if (drawn) {
+                node_process_1.stdout.write(`\x1b[${items.length + 1}A\x1b[J`);
+            }
+            node_process_1.stdout.write(`${frame().join("\n")}\n`);
+            drawn = true;
+        };
+        const finish = () => {
+            node_process_1.stdin.removeListener("keypress", onKeypress);
+            if (node_process_1.stdin.isTTY) {
+                node_process_1.stdin.setRawMode(false);
+            }
+            node_process_1.stdin.pause();
+            node_process_1.stdout.write("\x1b[?25h");
+            const chosen = items.filter((_, i) => selected[i]).map((item) => item.label);
+            node_process_1.stdout.write(`${question}: ${chosen.length > 0 ? chosen.join(", ") : "none"}\n`);
+            resolve(selected);
+        };
+        const onKeypress = (_str, key) => {
+            if (key.ctrl === true && key.name === "c") {
+                node_process_1.stdout.write("\x1b[?25h\n");
+                process.exit(130);
+            }
+            switch (key.name) {
+                case "up":
+                case "k":
+                    cursor = (cursor - 1 + items.length) % items.length;
+                    break;
+                case "down":
+                case "j":
+                    cursor = (cursor + 1) % items.length;
+                    break;
+                case "space":
+                    selected[cursor] = !selected[cursor];
+                    break;
+                case "a":
+                    {
+                        const all = selected.every(Boolean);
+                        selected.fill(!all);
+                    }
+                    break;
+                case "return":
+                case "enter":
+                    // wipe the list so only the summary line is left behind
+                    node_process_1.stdout.write(`\x1b[${items.length + 1}A\x1b[J`);
+                    finish();
+                    return;
+                default:
+                    return;
+            }
+            draw();
+        };
+        readline.emitKeypressEvents(node_process_1.stdin);
+        if (node_process_1.stdin.isTTY) {
+            node_process_1.stdin.setRawMode(true);
+        }
+        node_process_1.stdin.resume();
+        node_process_1.stdout.write("\x1b[?25l");
+        node_process_1.stdin.on("keypress", onKeypress);
+        draw();
+    });
+}
+function ask(prompt) {
+    const rl = readline.createInterface({ input: node_process_1.stdin, output: node_process_1.stdout });
+    return new Promise((resolve) => {
+        rl.question(prompt, (answer) => {
+            rl.close();
+            resolve(answer);
+        });
+    });
+}
+function dim(text) {
+    return node_process_1.stdout.isTTY ? `\x1b[2m${text}\x1b[22m` : text;
+}

package/dist/report.js

@@ -0,0 +1,87 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printError = printError;
+exports.printProblems = printProblems;
+exports.printSummary = printSummary;
+const path = __importStar(require("node:path"));
+const errors_1 = require("./errors");
+/** Prints a thrown error the same way a build problem is printed, hint included. */
+function printError(error) {
+    console.error(`error: ${error instanceof Error ? error.message : String(error)}`);
+    if (error instanceof errors_1.CliError && error.hint !== undefined) {
+        for (const line of error.hint.split("\n")) {
+            console.error(line === "" ? "" : `  ${line}`);
+        }
+    }
+}
+function location(problem) {
+    if (problem.file === undefined) {
+        return "";
+    }
+    const file = path.relative(process.cwd(), problem.file);
+    return problem.line !== undefined ? `${file}:${problem.line}: ` : `${file}: `;
+}
+function printProblems(problems) {
+    const ordered = [...problems].sort((a, b) => (a.level === b.level ? 0 : a.level === "error" ? -1 : 1));
+    for (const problem of ordered) {
+        const out = problem.level === "error" ? console.error : console.warn;
+        out(`${problem.level}: ${location(problem)}${problem.message}`);
+        if (problem.hint !== undefined) {
+            const lines = Array.isArray(problem.hint) ? problem.hint : problem.hint.split("\n");
+            for (const line of lines) {
+                out(line === "" ? "" : `  ${line}`);
+            }
+        }
+    }
+}
+function printSummary(result) {
+    const errors = result.problems.filter((p) => p.level === "error").length;
+    const warnings = result.problems.filter((p) => p.level === "warning").length;
+    const name = result.project.manifest?.name ?? "plugin";
+    const mode = result.dev ? "dev bundle" : "release";
+    for (const note of result.notes) {
+        console.log(`note: ${note}`);
+    }
+    if (result.ok) {
+        console.log(`built ${name} (${mode}) -> ${path.relative(process.cwd(), result.outDir) || "."} (${result.files.length} lua file${result.files.length === 1 ? "" : "s"}${warnings > 0 ? `, ${warnings} warning${warnings === 1 ? "" : "s"}` : ""})`);
+        if (result.deployedTo !== undefined) {
+            console.log(`copied to ${result.deployedTo}`);
+        }
+    }
+    else {
+        console.error(`build failed: ${errors} error${errors === 1 ? "" : "s"}${warnings > 0 ? `, ${warnings} warning${warnings === 1 ? "" : "s"}` : ""}`);
+    }
+}

package/package.json

@@ -1,6 +1,55 @@
 {
   "name": "rs3-api-ts",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1",
+  "description": "rs3-plugin: scaffold, build and check RuneScape 3 plugins written in TypeScript. Emits readable Lua and validates plugin.json against the client's rules.",
+  "license": "MIT",
+  "author": "Mark7625",
+  "homepage": "https://github.com/Rs3-Plugins/rs3-api-ts#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Rs3-Plugins/rs3-api-ts.git",
+    "directory": "packages/cli"
+  },
+  "bugs": {
+    "url": "https://github.com/Rs3-Plugins/rs3-api-ts/issues"
+  },
+  "keywords": [
+    "runescape",
+    "rs3",
+    "plugin",
+    "lua",
+    "typescript-to-lua",
+    "tstl",
+    "cli"
+  ],
+  "bin": {
+    "rs3-plugin": "dist/index.js"
+  },
+  "files": [
+    "dist",
+    "templates",
+    "data",
+    "tsconfig.base.json",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "prepack": "npm run build"
+  },
+  "dependencies": {
+    "rs3-api-core": "^0.1.1",
+    "rs3-api-extended": "^0.1.1",
+    "typescript": "6.0.2",
+    "typescript-to-lua": "^1.37.1"
+  },
+  "devDependencies": {
+    "@types/node": "^26.6.5"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}

package/templates/_gitignore

@@ -0,0 +1,2 @@
+node_modules/
+dist/

package/templates/_tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "rs3-api-ts/tsconfig.base.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": ["src"]
+}

package/templates/src/main.ts

@@ -0,0 +1,9 @@
+import { definePlugin } from "rs3-api-extended";
+import * as xp from "./modules/xp";
+
+definePlugin({
+    modules: [xp],
+    init() {
+        print(`[${Plugin.Name}] loaded`);
+    },
+});

package/templates/src/modules/xp.ts

@@ -0,0 +1,16 @@
+import { on } from "rs3-api-extended";
+
+let unsubscribe = () => {};
+
+export function init() {
+    unsubscribe = on(Event.SkillTransmit, (e) => {
+        const gained = e.newXP - e.oldXP;
+        if (gained > 0) {
+            print(`[${Plugin.Name}] +${gained} xp (level ${e.newGameplayLevel})`);
+        }
+    });
+}
+
+export function shutdown() {
+    unsubscribe();
+}

package/tsconfig.base.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "lib": ["ESNext"],
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "strict": true,
+    "types": ["rs3-api-core"],
+    "skipLibCheck": true
+  },
+  "tstl": {
+    "luaTarget": "5.4",
+    "luaLibImport": "none",
+    "noImplicitSelf": true,
+    "noHeader": true,
+    "sourceMapTraceback": false
+  }
+}