Skip to content

Dinographic/touchguild-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

99 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

description
This page is deprecated.

🌟 Get started

This page is an archive and features legacy versions of TouchGuild

Installation

NodeJS 16.16.0 or higher is required.

{% tabs %} {% tab title="npm" %}

npm install touchguild@latest

{% endtab %}

{% tab title="yarn" %}

yarn add touchguild@latest

{% endtab %}

{% tab title="ppm" %}

pnpm add touchguild@latest

{% endtab %} {% endtabs %}

Get started

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" %}

npm install touchguild@nightly

{% endtab %}

{% tab title="yarn" %}

yarn add touchguild@nightly

{% endtab %}

{% tab title="ppm" %}

pnpm add touchguild@nightly

{% endtab %} {% endtabs %}

Install the latest Nightly build manually:

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. {% endhint %}

Additional links:

Repository & NPM

Guide & documentation

Additional links

Our servers

About

TouchGuild documentation and guide.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published