Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/warengonzaga/gathertown.js

Simple and lightweight community contributed unofficial JS/TS SDK for Gather Town's HTTPS and WebSocket APIs. 🌏🕹💬
https://github.com/warengonzaga/gathertown.js

api game gather gathertown hacktoberfest javascript meta nodejs town virtual websocket wrapper

Last synced: 18 days ago
JSON representation

Simple and lightweight community contributed unofficial JS/TS SDK for Gather Town's HTTPS and WebSocket APIs. 🌏🕹💬

Host: GitHub
URL: https://github.com/warengonzaga/gathertown.js
Owner: warengonzaga
License: mit
Created: 2021-09-06T04:52:37.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2022-10-07T19:16:05.000Z (about 2 years ago)
Last Synced: 2024-04-14T09:05:01.671Z (7 months ago)
Topics: api, game, gather, gathertown, hacktoberfest, javascript, meta, nodejs, town, virtual, websocket, wrapper
Language: TypeScript
Homepage: https://gathertown.js.org
Size: 439 KB
Stars: 38
Watchers: 4
Forks: 6
Open Issues: 4
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

awesome-pinoy-made - GitHub

README

        # GatherTownJS [![Featured on Openbase](https://badges.openbase.com/js/featured/gathertown.js.svg?style=openbase&token=vTEljlezFJGmGx90+kIOLt4Sb/Ewj4Tc+3vzCpsIfaE=)](https://openbase.com/js/gathertown.js?utm_source=embedded&utm_medium=badge&utm_campaign=rate-badge)

[![created by](https://img.shields.io/badge/created%20by-Waren%20Gonzaga-blue.svg?longCache=true&style=flat-square)](https://github.com/warengonzaga) [![release](https://img.shields.io/github/release/warengonzaga/gathertown.js.svg?style=flat-square)](https://github.com/warengonzaga/gathertown.js/releases) [![star](https://img.shields.io/github/stars/warengonzaga/gathertown.js.svg?style=flat-square)](https://github.com/warengonzaga/gathertown.js/stargazers) ![npm downloads](https://img.shields.io/npm/dt/gathertown.js?color=red&style=flat-square) [![license](https://img.shields.io/github/license/warengonzaga/gathertown.js.svg?style=flat-square)](https://github.com/warengonzaga/gathertown.js/blob/main/license)

[![repo banner](.github/img/repo_banner.png)](https://gathertown.js.org)

Simple and lightweight **community contributed unofficial JavaScript/Typescript SDK** for [Gather Town](http://gather.town)'s HTTPS and WebSocket APIs. 🌏🕹💬

## ⚡ Features

Currently it supports **Gather HTTP API** `GET` and `POST` requests. We are currently working on **Gather Websocket API**.

### HTTP API (100% Coverage)

- `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](https://github.com/WarenGonzaga/gathertown.js/issues/10) and [#11](https://github.com/WarenGonzaga/gathertown.js/issues/11).

## 📖 Documentation

The complete documentation can be found here:

[![docs](https://img.shields.io/badge/Docs-docs.warengonzaga.com/gathertownjs-blue.svg?longCache=true&style=for-the-badge)](https://docs.warengonzaga.com/gathertownjs)

## 🕹️ Usage

Example usage of the GatherTownJS.

```js

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

```js

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](./CONTRIBUTING.md) 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](https://github.com/warengonzaga/gathertown.js/discussions)!

## 🐛 Issues

If you're facing a problem in using GatherTownJS please let me know by [creating an issue here](https://github.com/warengonzaga/gathertown.js/issues/new). I'm here to help you!

## 🍀 Sponsors and Supporters

> Love what I do? Send me some [love](https://github.com/sponsors/warengonzaga) or [coffee](https://buymeacoff.ee/warengonzaga)!? 💖☕

>

> Can't send love or coffees? 😥 Nominate me for a **[GitHub Star](https://stars.github.com/nominate)** instead!

> Your support will help me to continue working on open-source projects like this. 🙏😇

## 📋 Code of Conduct

Read the project's [code of conduct](./CODE_OF_CONDUCT.md).

## 📃 License

GatherTownJS is licensed under [The MIT License](https://opensource.org/licenses/MIT).

## 📝 Author

GatherTownJS is created by **[Waren Gonzaga](https://github.com/warengonzaga)**, with the help of awesome [contributors](https://github.com/warengonzaga/gathertown.js/graphs/contributors).

[![contributors](https://contrib.rocks/image?repo=warengonzaga/gathertown.js)](https://github.com/warengonzaga/gathertown.js/graphs/contributors)

---

💻💖☕ by [Waren Gonzaga](https://warengonzaga.com) | [YHWH](https://youtu.be/9vh6Dz9oh8I?t=85) 🙏