Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sentinelb51/revoltgo
Go package that provides low-level bindings to the Revolt API, just like discordgo
https://github.com/sentinelb51/revoltgo
Last synced: about 1 month ago
JSON representation
Go package that provides low-level bindings to the Revolt API, just like discordgo
- Host: GitHub
- URL: https://github.com/sentinelb51/revoltgo
- Owner: sentinelb51
- Created: 2023-06-13T15:30:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-17T02:18:04.000Z (6 months ago)
- Last Synced: 2024-08-24T09:28:53.208Z (4 months ago)
- Language: Go
- Size: 376 KB
- Stars: 9
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-revolt - revoltgo - Low-level bindings to the Revolt API, [like discordgo](https://github.com/bwmarrin/discordgo) (💻 API Libraries / Go)
README
## Support server
We have a Revolt server dedicated to this project, where you can discuss the project,
suggest features, or highlight issues.
[**Join our community.**](https://rvlt.gg/R55WJBjx)
## Why use revoltgo
At the time of writing, other (few) Revolt Go packages were simply unfeasible. They had:
- Hardcoded JSON payloads
- Poor API coverage and consistency
- Interface{} shoved in fields they were too lazy to add a struct for
- Hard-to-maintain codebase and odd design choices (wrapping Client and Time for each struct)
- ... this list can go on
## Features
RevoltGo as a project provides:
- Broader, up-to-date API coverage and functionality compared to other Revolt Go projects
- Extensive customisability due to low-level bindings
- Consistent, cleaner, and maintainable codebase
Additionally, revoltgo provides quality-of-life features such as:
- Permission calculator
- Lightweight ratelimit handling
- Automatic re-connects on websocket failures
- State/cache updates for members, roles, channels, and servers
## Getting started
### Installation
Assuming that you have a working Go environment ready, all you have to do is run
either of the following commands to install the package:
**Stable release**
```bash
go get github.com/sentinelb51/revoltgo
```
**Experimental release**
```bash
go get github.com/sentinelb51/revoltgo@latest
```
If you do not have a Go environment ready, **[see how to set it up here](https://go.dev/doc/install)**
### Usage
Now that the package is installed, you will have to import it
```go
import "github.com/sentinelb51/revoltgo"
```
Then, construct a new **session** using your bots token, and store it in a variable.
This "session" is a centralised store of all API and websocket methods at your fingertips, relevant to the bot you're about to connect with.
```go
session := revoltgo.New("your token here")
```
Finally, open the websocket connection to Revolt API. Your bot will attempt to login, and if successful, will receive events from the Revolt websocket about the world it's in.
Make sure to handle the error, as it can indicate any problem that could arise during the connection.
```go
err := session.Open()
```
To ensure the program keeps running, and accepts signals such as `Ctrl` + `C`, make a channel and wait for a signal from said channel:
```go
sc := make(chan os.Signal, 1)
signal.Notify(sc, syscall.SIGINT, syscall.SIGTERM, os.Interrupt, os.Kill)
<-sc
```
When it's time to close the connection, simply close the session as demonstrated below.
```go
session.Close()
```
### Examples
The following examples are available in the [examples](https://github.com/sentinelb51/revoltgo/tree/main/examples) directory:
- **ping_bot.go**: A simple **bot** that responds to the `!ping` command.
- **selfbot.go**: A simple **self-bot** that responds to the `!ping` command.
## Resource usage
The resource utilisation of the library depends on how many handlers are registered
and how many objects are cached in the state. More handlers will increase CPU usage, while
more objects in the state will increase memory usage.
For programs that need to be as lightweight as possible (and do not care about caching objects),
they can disable the state by setting the following tracking options in `Session.State`:
```go
/* Tracking options */
TrackUsers bool
TrackServers bool
TrackChannels bool
TrackMembers bool
TrackEmojis bool
TrackWebhooks bool
```
### Windows platforms
Standalone, with state enabled, the library uses:
- ~0.00% CPU
- ~6.0-6.8 MB of RAM
The memory usage is expected to grow with state enabled as more objects get cached.
### Linux platforms
Not tested, but it's expected to be around the same.