1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
# revolt.go
Revolt.go is a Go package for writing bots and self-bots in Revolt
easily. This project is a mantained and re-worked version
[ben-forster's fork](https://github.com/ben-forster/revolt) of
5elenay's library [revoltgo](https://github.com/5elenay/revoltgo).
## Features
- Multiple event listen
- Easy to use
- Supports self bots
- Simple cache system
## API Reference
Click [here](https://pkg.go.dev/within.website/x/web/revolt) for api reference.
## Notice
Please note that you will need the Go 1.20 to use revolt.
This package is still under development and while you can create a
working bot, the library is not finished. Create an issue if you would
like to contribute.
## Ping Pong Example (Bot)
```go
package main
import (
"os"
"os/signal"
"syscall"
"within.website/x/web/revolt"
)
func main() {
// Init a new client.
client := revolt.Client{
Token: "bot token",
}
// Listen a on message event.
client.OnMessage(func(m *revolt.Message) {
if m.Content == "!ping" {
sendMsg := &revolt.SendMessage{}
sendMsg.SetContent("🏓 Pong!")
m.Reply(true, sendMsg)
}
})
// Start the client.
client.Start()
// Wait for close.
sc := make(chan os.Signal, 1)
signal.Notify(
sc,
syscall.SIGINT,
syscall.SIGTERM,
os.Interrupt,
)
<-sc
// Destroy client.
client.Destroy()
}
```
## Ping Pong Example (Self-Bot)
```go
package main
import (
"os"
"os/signal"
"syscall"
"within.website/x/web/revolt"
)
func main() {
// Init a new client.
client := revolt.Client{
SelfBot: &revolt.SelfBot{
Id: "session id",
SessionToken: "session token",
UserId: "user id",
},
}
// Listen a on message event.
client.OnMessage(func(m *revolt.Message) {
if m.Content == "!ping" {
sendMsg := &revolt.SendMessage{}
sendMsg.SetContent("🏓 Pong!")
m.Reply(true, sendMsg)
}
})
// Start the client.
client.Start()
// Wait for close.
sc := make(chan os.Signal, 1)
signal.Notify(
sc,
syscall.SIGINT,
syscall.SIGTERM,
os.Interrupt,
)
<-sc
// Destroy client.
client.Destroy()
}
```
## To-Do
- [x] OnReady
- [x] OnMessage
- [x] OnMessageUpdate
- [ ] OnMessageAppend
- [x] OnMessageDelete
- [x] OnChannelCreate
- [x] OnChannelUpdate
- [x] OnChannelDelete
- [ ] OnChannelGroupJoin
- [ ] OnChannelGroupLeave
- [x] OnChannelStartTyping
- [x] OnChannelStopTyping
- [ ] OnChannelAck
- [x] OnServerCreate
- [x] OnServerUpdate
- [x] OnServerDelete
- [x] OnServerMemberUpdate
- [x] OnServerMemberJoin
- [x] OnServerMemberLeave
- [ ] OnServerRoleUpdate
- [ ] OnServerRoleDelete
- [ ] OnUserUpdate
- [ ] OnUserRelationship
- [ ] OnEmojiCreate
- [ ] OnEmojiDelete
|
