📢 Nominate (@WarenGonzaga) as GitHub Star. If you appreciate his hardwork and dedication to open source.

A simple and lightweight but powerful NodeJS client for Gather Town API.

(coming soon)

Currently supports HTTP API GET requests.

• GET getMap()
• GET getEmailGuestList()

NOTE: Currently working on Websocket API support as suggested by the team at Gather. Check out the discussion here: #10 and #11.

The complete documentation can be found here:

Example usage of the GatherTownJS.

const GATHER = require('gathertown.js'); // add gather package
const access = require('./config.json'); // load your apikey
const gather = new GATHER(access.key); // access keys

// some variables
const spaceID = 'space-id\\space-name';
const mapID = 'map-name';

function map() {
    gather.getMap(spaceID, mapID)
        .then(data => console.log(data))
        .catch(err => console.log(err));
}

map();

Contributions are welcome, create a pull request to this repo and I will review your code. Please consider to submit your pull request to the dev branch. Thank you!

For any questions, suggestions, ideas, or simply you want to share your experience in using this project, feel free to share and discuss it to the community!

If you're facing a problem in using GatherTownJS please let me know by creating an issue here. I'm here to help you!

Love what I do? Send me some coffees! Can't send coffees? Nominate me for a GitHub Star instead! Your coffee donation and support will help me to continue working on open-source projects like this.

Join to my growing tech community and get the latest updates!

Read the project's code of conduct.

GatherTownJS is licensed under The MIT License.

GatherTownJS is created by Waren Gonzaga, with the help of awesome contributors.

💻 Made with 💖 and ☕ by Waren Gonzaga with YHWH 🙏 | Citizen of Heaven