GatherTownJS (Unofficial)
A simple and lightweight but powerful NodeJS client for Gather Town API.
😎 Demo
(coming soon)
⚡ Features
Currently supports HTTP API GET
requests.
HTTP API
GET getMap()
GET getEmailGuestList()
POST createSpace()
POST setEmailGuestlist()
POST setMap()
NOTE: Currently working on Websocket API support as suggested by the team at Gather. Check out the discussion here: #10 and #11.
📖 Documentation
The complete documentation can be found here:
🕹️ Usage
Example usage of the GatherTownJS.
const GATHER = require('gathertown.js'); // add gather package
const access = require('./config.json'); // load your apikey
const gather = 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();
⚓ With Hooks
const { useGather } = require('gathertown.js');
const access = require('./config.json'); // load your apikey
// some variables
const spaceId = 'space-id/space-name';
const mapId = 'map-name';
function map() {
// load only needed functions
const { getMap } = useGather(access.key);
getMap({ spaceId, mapId })
.then((data) => console.log(data))
.catch((err) => console.log(err));
}
map();
🎯 Contributing
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!
Read the project's contributing guide for more info.
💬 Discussions
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!
🐛 Issues
If you're facing a problem in using GatherTownJS please let me know by creating an issue here. I'm here to help you!
🍀 Sponsors and Supporters
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.
🌏 Community
Join to my growing tech community and get the latest updates!
📋 Code of Conduct
Read the project's code of conduct.
📃 License
GatherTownJS is licensed under The MIT License.
📝 Author
GatherTownJS is created by Waren Gonzaga, with the help of awesome contributors.