https://github.com/dinographicpixels/touchguild-docs
TouchGuild documentation and guide.
https://github.com/dinographicpixels/touchguild-docs
docs javascript nodejs npm touchguild
Last synced: about 1 year ago
JSON representation
TouchGuild documentation and guide.
- Host: GitHub
- URL: https://github.com/dinographicpixels/touchguild-docs
- Owner: DinographicPixels
- License: mit
- Created: 2022-08-26T18:02:22.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-11-20T12:07:56.000Z (over 3 years ago)
- Last Synced: 2025-02-12T20:51:56.161Z (over 1 year ago)
- Topics: docs, javascript, nodejs, npm, touchguild
- Size: 7.6 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
---
description: TouchGuild is a NodeJS library for interfacing with Guilded.
---
# 🌟 Get started
## Installation
NodeJS **16.16.0** or higher is required.
{% tabs %}
{% tab title="npm" %}
```bash
npm install touchguild@latest
```
{% endtab %}
{% tab title="yarn" %}
```bash
yarn add touchguild@latest
```
{% endtab %}
{% tab title="ppm" %}
```bash
pnpm add touchguild@latest
```
{% endtab %}
{% endtabs %}
## Get started
```javascript
const TouchGuild = require('touchguild'); // import for CommonJS
// import * as TouchGuild from 'touchguild' // import for ESM & TS
const client = new TouchGuild.Client({token: 'insert token here'});
client.on('ready', ()=> {
console.log(`Logged as ${client.user.username}`);
});
client.on('error', (err)=> {
console.error("Whoops, somethin' went wrong..", err);
});
client.connect();
```
{% hint style="info" %}
Note: CommonJS, ESM & Typescript are supported.
{% endhint %}
## Development builds (Nightly)
Nightly builds are pre-release builds, they're having new features in real time. Once there's enough features, we're releasing them as a brand new 'stable build'.
## Install Nightly builds
You can get new features before the stable release.
### Install the latest Nightly build automatically:
{% tabs %}
{% tab title="npm" %}
```bash
npm install touchguild@nightly
```
{% endtab %}
{% tab title="yarn" %}
```bash
yarn add touchguild@nightly
```
{% endtab %}
{% tab title="ppm" %}
```bash
pnpm add touchguild@nightly
```
{% endtab %}
{% endtabs %}
### Install the latest Nightly build manually:
```bash
npm install dinographicpixels/touchguild#nightly
```
1. Run the command
2. Go to `node_modules/touchguild`
3. Run: `npm run build` inside the touchguild folder
4. Now, it's ready.
You need to reproduce those steps everytime you update to a newer nightly build.
{% hint style="warning" %}
Be aware that Nightly builds aren't stable and can have still have major bugs. If you face issues, feel free to report it by creating an issue on TouchGuild's GitHub, please specify that you're using a Nightly build.
{% endhint %}
{% hint style="info" %}
You can check [Nightly Features here.](broken-reference)
{% endhint %}
## Additional links:
#### Repository & NPM
* [NPM Package](https://www.npmjs.com/package/touchguild)
* [GitHub](https://github.com/DinographicPixels/TouchGuild)
#### Guide & documentation
* [Guide](https://guide.touchguild.dinographicpixels.com)
* [Documentation](documentation/select-version/)
#### Additional links
* [Our vision of the project](https://docs.touchguild.dinographicpixels.com/misc/our-vision)
* [FAQ](https://docs.touchguild.dinographicpixels.com/misc/faq)
* [Get started, youtube video](https://www.youtube.com/watch?v=AUaiQRMjJZo)
#### Our servers
* [Our Discord server](https://discord.gg/UgPRaGRkrQ)
* [Our Guilded server](https://www.guilded.gg/i/ExPXPrwE)