@clunkyard/sdk 2.0.1 → 2.0.2

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.
Files changed (2) hide show
  1. package/README.md +10 -17
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,9 +1,8 @@
1
1
  # Clunkyard robot SDK for Node.js
2
2
 
3
3
  Write a Clunkyard robot in JavaScript or TypeScript. This package contains the
4
- robot API, TypeScript declarations and the shared WebAssembly core. It needs
5
- Node 20 or later, with no native compiler, platform library or install script.
6
- It runs in Node; a browser bundle is not supplied.
4
+ robot API, TypeScript declarations and the shared WebAssembly core. Install
5
+ Node 20 or later to run it.
7
6
 
8
7
  ## Use the same import as the arena
9
8
 
@@ -11,7 +10,7 @@ Clunkyard's hosted JavaScript and TypeScript starters import `clunkyard`.
11
10
  Install this package under that name to keep the same source locally and online:
12
11
 
13
12
  ```sh
14
- npm install clunkyard@npm:@clunkyard/sdk@2.0.0
13
+ npm install clunkyard@npm:@clunkyard/sdk
15
14
  ```
16
15
 
17
16
  ```javascript
@@ -40,17 +39,14 @@ The same alias works with `import * as cy from 'clunkyard'` in TypeScript.
40
39
  Keep `package.json` and your lock file in the local project. The arena supplies
41
40
  the matching binding when it builds your bot; do not upload `node_modules`.
42
41
 
43
- For a standalone Node application, install `@clunkyard/sdk@2.0.0` directly and
44
- use `require('@clunkyard/sdk')`. A scoped import is not currently available in
45
- the hosted build environment; use the alias above for arena bot source.
42
+ For a standalone Node application, install `@clunkyard/sdk` directly and use
43
+ `require('@clunkyard/sdk')`. Use the alias above for hosted arena bot source.
46
44
 
47
45
  ## Run and test a robot
48
46
 
49
- `cy.run(robot)` reads protocol 2 observations from standard input and writes
50
- the robot's replies. A robot is not a match engine: running `node bot.js` without
51
- input waits for observations. Use the [language starter](https://github.com/clunkyard/starter-javascript)
52
- and its `make match` / `make replay` commands for real local opponents and replays.
53
- No account is needed for those local trials.
47
+ `cy.run(robot)` reads observations from standard input and writes the robot's
48
+ replies. Use the [language starter](https://github.com/clunkyard/starter-javascript)
49
+ and its `make match` and `make replay` commands to play local matches.
54
50
 
55
51
  `cy.play(robot, lines)` accepts recorded protocol lines and returns reply lines
56
52
  in memory, which is useful for focused tests. It uses the same core parser,
@@ -70,8 +66,5 @@ protocol stream. The language starter provides the arena's normal launcher.
70
66
  [Local development](https://clunkyard.com/sdk/player-kit) ·
71
67
  [Private Git](https://clunkyard.com/sdk/private-git)
72
68
 
73
- SDK 2.0.0 uses protocol 2. The WebAssembly core is included in this package;
74
- there is no network request or download when the module loads. The local
75
- match engine, replay viewer and other languages' toolchains are separate.
76
- The [core source](https://github.com/clunkyard/sdk/tree/main/sdk/core) is available
77
- for review; bundled dependency and toolchain notices accompany the package.
69
+ The [core source](https://github.com/clunkyard/sdk/tree/main/sdk/core) and
70
+ bundled dependency and toolchain notices are available for review.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@clunkyard/sdk",
3
- "version": "2.0.1",
3
+ "version": "2.0.2",
4
4
  "description": "The Clunkyard robot API for Node.js and TypeScript, with the portable WebAssembly core",
5
5
  "license": "MIT",
6
6
  "type": "commonjs",