A runtime-agnostic and zero dependency TypeScript/JavaScript library for communicating with Archipelago servers.
npm install archipelago.js!GitHub License
!Types
!NPM Version
!NPM Downloads
!Static Badge
A runtime-agnostic and zero dependency TypeScript/JavaScript library for communicating with Archipelago servers.
Targeted to work on all major desktop and mobile browsers (Firefox,
Chromium, and Safari) and server-side runtimes such as
Node.js, Bun, and Deno.
Install via npm install archipelago.js (or via your preferred package manager's flavor).
Check out the quick start documentation here!
The full API documentation is located here. Please be sure to reference it
while you are developing your JavaScript-based clients.
This library supports 100% of the Archipelago network protocol referenced
here as of 2024-11-03
(0.5.1 RC1). See more information about Archipelago at their website.
Archipelago.js is built using TypeScript and the Bun bundler. You can set up your development environment by cloning
this repository to a desired location on your computer and installing its devDependencies.
``bash`
git clone https://github.com/ThePhar/archipelago.js
cd archipelago.js
npm install # or pnpm install
Then to build, have Bun installed and run npm run build (or pnpm build).
Archipelago.js is written in TypeScript and includes a strong ESLint config file to ensure code consistency. Be sure
to follow the code standards of this repository and check your work with npm run lint`.
Currently, there are no automated tests for this library, so all testing in browser, Node, Deno, and Bun are done
manually. This is certainly one area that can be expanded upon.
Alternatively, expanding upon the documentation (either through the JSDoc or tutorial-like guides) would be appreciated.