lagunaelectric / gather-ts

This is a template repository for getting started with the Gather.town Websocket API.

Gather Typescript Template

This is a stripped down copy of the code behind The Forest, a dynamic, living Gather map.

Also a great example of a simple mod built with the Gather API!

This template is aimed to get me up and running as quickly as possible. I hope it helps you too!

Setup

prereq: have NodeJS and npm or pnpm installed

1. Run npm i or pnpm i, whichever you prefer.
2. Copy example.api-key.ts, remove example. from the name, and replace the example key with your own:

export const API_KEY = "your-api-key-here"

3. Replace the SPACE_ID and MAP_ID in index.ts with your own

Run

npm run start