touchguild v1.4.1

TouchGuild is a library that supports TS, JS (cjs and esm) and it was built to let you interface with the Guilded API. It has easy & predictable types, some of them are inspired by Discord Eris.

Early access library

The library recently launched and we need to make sure that you do not encounter bugs, that's why, we're realsing it in Early access. When TouchGuild will be stable enough, we'll switch to 'B.E.T.A' since the Guilded API is still in early access.

NIGHTLY BUILD

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.

What's new on Nightly builds?

• Lock & unlock forum topic methods for both Client and ForumTopic components.
• Guild XP Management including set/award xp.
• disconnect() method for Client
• Fixed: 'messageDelete's oldContent is null (couldn't get oldContent from cache)'
• Deleted unused importations
• Types are now in one file
• Fixed: Issue while importing TouchGuild on repl.it
• Improved websocket & moved packet parsing.
• Added DevTools to the TouchGuild's index.

Check docs/nightly for more details about new features: https://docs.touchguild.dinographicpixels.com/nightly/features

Guide, documentation & even more

Everything's to help you to get started, to create an incredible guilded bot through our Library.

Links:

• NPM Package
• GitHub
• Guide
• Documentation
• Our vision of the project
• FAQ
• Get started, youtube video
• Our Discord server
• Our Guilded server

🌟 Get started

Get started, it's easy.

NodeJS 16.16.0 or higher is required.

Installation (Nightly)

Install the package with NPM through GitHub:

npm install dinographicpixels/touchguild#nightly

Install the package through NPM:

npm install touchguild@nightly

Basic scripting (ping, pong!)

Let's get started, it'll be easy examples for ya!

For example, we'll create a simple ping pong script, a well known command!

Javascript & Typescript:

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'}) // create client

Client.connect();

Client.on('messageCreate', (message)=> {
    // Detects when a message is created and executes the code here.
    if (message.member.bot == true) return; // ignores bot messages.
    if (message.content == '!ping'){
        // if the message command is !ping, it executes the code here.
        message.createMessage({content: 'pong!'}); // create a message.
    }
});

Install stable builds

Install stable builds with npm:

npm install touchguild@latest

Install stable builds with yarn:

yarn add touchguild