dinographicpixels / touchguild

TouchGuild is a NodeJS library for interfacing with Guilded.

const { Client } = require("touchguild");
const client = new Client({ token: "TOKEN" });

client.on("ready", () => {
    console.log(`Logged as ${client.user.username}`);
});

client.on('error', (err) => {
    console.error(err);
});

client.connect();

For more examples, check out the examples folder on GitHub.

---

Installation

NodeJS 16.16.0 or higher is required. Check out Development Builds if you wish to install in-dev versions.

npm install touchguild

Development Builds

npm install touchguild@dev

The documentation under dev is always for the latest commit. If something isn't working that's in the documentation, you're likely looking at the wrong documentation.

---

Links:

• Website
• Guide
• Release documentation
• Development documentation
• Discord server
• Guilded server

touchguild's Issues

Methods to lock or unlock a forum topic.

ForumTopic.edit() does not work.

Before fix:

return new ForumTopic(response.data.forumTopic, this);

After fix:

return new ForumTopic(response.data.forumTopic, this._client);

We're working on a new developer branch commit that fixes & enhances the whole library. It may take some time.
You can edit the TouchGuild's code to fix this issue for the time being.

Support Guilded's built-in XP system.

Add the possibility to disconnect the Client.

E.g.

Client.disconnect();

REST Methods processing multiple objects takes too much time.

REST Methods that treats multiple objects of information takes too much time to output.
We're working on it to make this process as fast as possible.

messageDelete event: cannot get message.content after deletion.

client.on('messageDelete', (message)=> {
    console.log(message.content) // outputs empty string
})

High latency

Seems like TouchGuild is having high latency issues.

I've saw a high difference of latency between TouchGuild and other libraries.

• The time to detect a message is around 1 second.
• The time to send a message is around 1 second.
  This equals a high latency, it has 2 seconds delay between the time you send a message and the bot's reply.

We're working on it, and may result in a major update.

Issue while importing TouchGuild on repl.it & other services. (import error)

Fix coming soon on Nightly.

Allow developers to send HTTP(S) requests through TouchGuild.

Support for ForumTopicComment & New Guilded's API Events

The Guilded API recently updated with some features including:

• ForumTopicComment & its methods
• ForumTopicComment gateway events: ForumTopicCommentCreated, ForumTopicCommentUpdated, ForumTopicCommentDeleted
• Event fired when a bot joined a guild (BotTeamMembershipCreated)

Source: https://www.guilded.gg/API-Official/blog/Announcements/Two-2-new-features

Information about webhooksCreate

webhooksCreate is a 'pre-create' event.

The webhooksCreate event is triggered when you're in the context menu, editing the name, and other information about the webhook. It means that it is triggered before you actually create the webhook. That is why, you can't edit the webhook's name.

Conclusion

If you'd like to edit the name of a new webhook, use the webhooksUpdate event. The webhooksUpdate event is triggered each time you actually create or update a webhook, so you can edit it.