@lostcityrs/runescript 0.9.2 → 0.9.4

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021-2026 Joshua Filby and other contributors.
+Copyright (c) 2023-2026 Lost City
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/LICENSE.neptune

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright 2021-present Joshua Filby and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -2,6 +2,74 @@
 <h1>RuneScriptTS</h1>
 </div>
 
-A fork of [Neptune](https://github.com/neptune-ps/neptune) (a project undertaking modern OSRS), this project is instead entirely RuneScript-focused.
+This is a **RuneScript Compiler**, written in TypeScript. Our focus is to preserve RS2 history as accurately and authentically as we can.
 
-This is a work-in-progress effort to port [this](https://github.com/LostCityRS/RuneScriptKt) to run in TypeScript, and the upstream repo will be sunsetted in favor of this.
+### Installation and Usage
+
+`npm i @lostcityrs/runescript`  
+(or yarn, bun, pnpm...)
+
+```ts
+import { CompileServerScript, CompilerTypeInfo } from '@lostcityrs/runescript';
+
+// opcode->command lookup + pointer info
+const commandInfo: CompilerTypeInfo = ...;
+
+// script id->name lookup
+const runescriptInfo: CompilerTypeInfo = ...;
+
+// config id->name lookup
+const npcInfo: CompilerTypeInfo = ...;
+
+CompileServerScript({
+    symbols: {
+        'command': commandInfo,
+        'runescript': runescriptInfo,
+
+        'npc': npcInfo,
+        ...
+    }
+});
+```
+
+The compiler expects a couple things to be in place.
+
+1. A source folder that contains `.rs2` scripts.
+2. Symbol information provided for the types you plan on referencing.
+
+By default it will read scripts from `../content/scripts`.
+After it runs, compiled output will be placed in `./data/pack/server`.  
+If that doesn't work for your use case, please see the config object you pass to CompileServerScript.
+
+See [LostCityRS/Server](https://github.com/LostCityRS/Server) for a working example.
+
+### Building RuneScriptTS
+
+After cloning:
+```sh
+bun i
+bun run antlr
+```
+
+Testing:  
+You can test changes without publishing by copying `dist/runescript.js` into your consumer's node_modules folder
+```sh
+bun run build
+cp dist/runescript.* ../node_modules/@lostcityrs/runescript/dist/
+```
+
+### History
+
+Originally a fork of [Neptune](https://github.com/neptune-ps/neptune)'s script compiler.  
+Our initial compiler fork (2023-2026) focused instead on making a complete server script compiler, along with a script runtime and world simulation:  
+https://github.com/LostCityRS/RuneScriptKt  
+https://github.com/LostCityRS/Engine-TS
+
+As of February 2026 we have transitioned from the "legacy" Kotlin codebase to this TypeScript codebase (clean port).  
+Consumers should use this. It is production-ready and produces compatible output along with some bug fixes.
+
+### Credits
+
+Polar: For your years of work on Neptune and many days brainstorming together.  
+Flenarn: For your effort porting so much Kotlin code to TypeScript. There were only a few lines to fix afterwards - great job.  
+Contributions in RuneScriptKt: Henke96 [PR #1](https://github.com/LostCityRS/RuneScriptKt/pull/1) and Bea5 [PR #2](https://github.com/LostCityRS/RuneScriptKt/pull/1).

package/dist/runescript.d.ts

@@ -1,3 +1,35 @@
 /* tslint:disable */
 /* eslint-disable */
-export declare function CompileServerScript(): void;
+
+export declare function CompileServerScript(config?: {
+    sourcePaths?: string[];
+    symbols?: Record<string, CompilerTypeInfo>;
+    excludePaths?: string[];
+    checkPointers?: boolean;
+    writer?: {
+        jag?: {
+            output: string;
+        };
+        js5?: {
+            output: string;
+        };
+    };
+}): void;
+
+export declare type CompilerTypeInfo = {
+    max: number;
+    map: Record<string, string>;
+
+    // info for some configs
+    vartype: Record<string, string>;
+    protect: Record<string, boolean>;
+
+    // info for commands only
+    require: Record<string, string>;
+    require2: Record<string, string>;
+    conditional: Record<string, boolean>;
+    set: Record<string, string>;
+    set2: Record<string, string>;
+    corrupt: Record<string, string>;
+    corrupt2: Record<string, string>;
+};