@scm-js/core 0.0.0-stage → 0.8.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +31 -2
- package/dist/index.d.ts +1779 -0
- package/dist/index.mjs +11805 -0
- package/package.json +49 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Jeany
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,32 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @scm-js/core
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
StarCraft: Brood War maps in Node.js and the browser, as the [scmJS](https://scmjs.dev)
|
|
4
|
+
editor reads and writes them. Open a `.scm`, `.scx` or `.chk`; read and change its
|
|
5
|
+
triggers, strings, units, locations and settings; run Check Map; write the map back. It is
|
|
6
|
+
the editor's own code, built from the same source, so a map goes through this library
|
|
7
|
+
exactly as it goes through the editor of the same version. No game data is needed.
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
npm install @scm-js/core
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
```js
|
|
14
|
+
import { readFile, writeFile } from "node:fs/promises";
|
|
15
|
+
import { openMapBytes, writeMapBytes, scenarioName, readTriggers, triggersToText, validateScenario } from "@scm-js/core";
|
|
16
|
+
|
|
17
|
+
const map = await openMapBytes(await readFile("(2)Destination.scx"), "(2)Destination.scx");
|
|
18
|
+
console.log(scenarioName(map.scenario));
|
|
19
|
+
console.log(triggersToText(map.scenario, readTriggers(map.scenario)));
|
|
20
|
+
for (const issue of validateScenario(map.scenario, { extras: map.extras })) console.log(issue.level, issue.text);
|
|
21
|
+
|
|
22
|
+
await writeFile("out.scx", await writeMapBytes(map.scenario, { format: "scx", extras: map.extras, stored: map.stored }));
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
The guide, with what is in the package and how an edit works, is at
|
|
26
|
+
[docs.scmjs.dev/core](https://docs.scmjs.dev/core/). The `scmjs` command line
|
|
27
|
+
([@scm-js/cli](https://www.npmjs.com/package/@scm-js/cli)) is built on the same functions;
|
|
28
|
+
replays are [@scm-js/replay](https://www.npmjs.com/package/@scm-js/replay).
|
|
29
|
+
|
|
30
|
+
Node.js 22.12 or newer. ES modules, with TypeScript declarations. The one dependency is
|
|
31
|
+
[mopaq](https://github.com/jeany55/mopaq). MIT-licensed; the source is
|
|
32
|
+
[github.com/scm-js/scm-js](https://github.com/scm-js/scm-js), under `core/`.
|