5 |
6 | # Swiftcord - A Discord Library for Swift
7 |
8 | ## Requirements
9 | 1. macOS, Linux, iOS, watchOS, tvOS (no voice for iOS, watchOS, or tvOS)
10 | 2. At least Swift 5.3
11 |
12 | ## Adding Sword
13 | ### Swift Package Manager
14 | In order to add Sword as a dependency, you must first create a Swift executable in a designated folder, like so `swift package init --type executable`. Then in the newly created Package.swift, open it and add Sword as a dependency
15 |
16 | ```swift
17 | // swift-tools-version: 5.3
18 |
19 | import PackageDescription
20 |
21 | let package = Package(
22 | name: "yourswiftexecutablehere",
23 | dependencies: [
24 | .package(url: "https://github.com/SketchMaster2001/Swiftcord", .branch("master"))
25 | ],
26 | targets: [
27 | .target(
28 | name: "yourswiftexecutablehere",
29 | dependencies: ["Swiftcord"]
30 | )
31 | ]
32 | )
33 | ```
34 |
35 | After that, open Sources/main.swift and remove everything and replace it with the example below.
36 |
37 | ```swift
38 | import Swiftcord
39 |
40 | let bot = Swiftcord(token: "Your bot token here")
41 |
42 | // Set activity if wanted
43 | let activity = Activities(name: "with Swiftcord!", type: .playing)
44 | bot.editStatus(status: .online, activity: activity)
45 |
46 | // Set intents which are required
47 | bot.setIntents(intents: .guildMessages)
48 |
49 | class MyBot: ListenerAdapter {
50 | override func onMessageCreate(event: Message) async {
51 | if msg.content == "!ping" {
52 | try! await msg.reply(with: "Pong!")
53 | }
54 | }
55 | }
56 |
57 | bot.addListeners(MyBot())
58 | bot.connect()
59 | ```
60 | For more examples, look in the examples folder or in the Wiki.
61 |
62 |
63 | ## Running the bot (SPM)
64 | First make sure you are in the directory with the `Package.swift` file. To build the executable, run `swift build`. To build the executable and run it immediately, run `swift run`
65 |
66 | ## Running the bot in Xcode (SPM)
67 | To run the bot in Xcode, all you need to do is open the directory the `Package.swift` file is located in Xcode. Click the play button at the top left corner and it will run!
68 |
69 | Then click the play button!
70 |
71 | ## Links
72 | [Documentation](https://sketchmaster2001.github.io/Swiftcord) - Created using Apple [docc](https://github.com/apple/swift-docc) and converted to HTML with [docc2html](https://github.com/DoccZz/docc2html)
73 |
74 | [Swiftcord Discord server](https://discord.gg/cE2Cpn4r9X)
75 |
--------------------------------------------------------------------------------
/Sources/Swiftcord/Gateway/GatewayHandler.swift:
--------------------------------------------------------------------------------
1 | //
2 | // GatewayHandler.swift
3 | // Swiftcord
4 | //
5 | // Created by Alejandro Alonso
6 | // Copyright © 2017 Alejandro Alonso. All rights reserved.
7 | //
8 | import Foundation
9 |
10 | /// Gateway Handler
11 | extension Shard {
12 |
13 | /**
14 | Handles all gateway events (except op: 0)
15 | - parameter payload: Payload sent with event
16 | */
17 | func handleGateway(_ payload: Payload) async {
18 |
19 | guard let op = OP(rawValue: payload.op) else {
20 | self.swiftcord.log(
21 | "Received unknown gateway\nOP: \(payload.op)\nData: \(payload.d)"
22 | )
23 | return
24 | }
25 |
26 | switch op {
27 |
28 | /// OP: 1
29 | case .heartbeat:
30 | self.send(self.heartbeatPayload.encode())
31 |
32 | /// OP: 11
33 | case .heartbeatACK:
34 | self.heartbeatQueue.sync { self.acksMissed = 0 }
35 |
36 | /// OP: 10
37 | case .hello:
38 | self.heartbeat(at: (payload.d as! [String: Any])["heartbeat_interval"] as! Int)
39 |
40 | guard !self.isReconnecting else {
41 | self.isReconnecting = false
42 | let data: [String: Any] = [
43 | "token": self.swiftcord.token,
44 | "session_id": self.sessionId!,
45 | "seq": self.lastSeq ?? NSNull()
46 | ]
47 |
48 | let payload = Payload(op: .resume, data: data)
49 | self.send(payload.encode())
50 | return
51 | }
52 |
53 | self.identify()
54 |
55 | /// OP: 9
56 | case .invalidSession:
57 | self.isReconnecting = payload.d as! Bool
58 | await self.reconnect()
59 |
60 | /// OP: 7
61 | case .reconnect:
62 | self.isReconnecting = true
63 | await self.reconnect()
64 |
65 | /// Others
66 | default:
67 | break
68 | }
69 |
70 | }
71 |
72 | }
73 |
--------------------------------------------------------------------------------
/Sources/Swiftcord/Gateway/Heartbeat.swift:
--------------------------------------------------------------------------------
1 | //
2 | // Heartbeat.swift
3 | // Swiftcord
4 | //
5 | // Created by Alejandro Alonso
6 | // Copyright © 2017 Alejandro Alonso. All rights reserved.
7 | //
8 |
9 | import Foundation
10 | import Dispatch
11 |
12 | /// <3
13 | extension Gateway {
14 | func heartbeat(at interval: Int) {
15 | guard self.isConnected else {
16 | return
17 | }
18 |
19 | guard self.acksMissed < 3 else {
20 | Task {
21 | self.swiftcord.debug("[Swiftcord] Did not receive ACK from server, reconnecting...")
22 | await self.reconnect()
23 | }
24 | return
25 | }
26 |
27 | self.acksMissed += 1
28 |
29 | self.send(self.heartbeatPayload.encode(), presence: false)
30 |
31 | self.heartbeatQueue.asyncAfter(
32 | deadline: .now() + .milliseconds(interval)
33 | ) { [unowned self] in
34 | self.heartbeat(at: interval)
35 | }
36 | }
37 | }
38 |
--------------------------------------------------------------------------------
/Sources/Swiftcord/Gateway/Payload.swift:
--------------------------------------------------------------------------------
1 | //
2 | // Payload.swift
3 | // Swiftcord
4 | //
5 | // Created by Alejandro Alonso
6 | // Copyright © 2017 Alejandro Alonso. All rights reserved.
7 | //
8 | /// Payload Type
9 | struct Payload {
10 |
11 | // MARK: Properties
12 | /// OP Code for payload
13 | var op: Int
14 |
15 | /// Data for payload
16 | var d: Any
17 |
18 | /// Sequence number from payload
19 | let s: Int?
20 |
21 | /// Event name from payload
22 | let t: String?
23 |
24 | // MARK: Initializers
25 | /**
26 | Creates a payload from JSON String
27 | - parameter text: JSON String
28 | */
29 | init(with text: String) {
30 | let data = text.decode() as! [String: Any]
31 | self.op = data["op"] as! Int
32 | self.d = data["d"]!
33 | self.s = data["s"] as? Int
34 | self.t = data["t"] as? String
35 | }
36 |
37 | /**
38 | Creates a payload from either an Array | Dictionary
39 | - parameter op: OP code to dispatch
40 | - parameter data: Either an Array | Dictionary to dispatch under the payload.d
41 | */
42 | init(op: OP, data: Any) {
43 | self.op = op.rawValue
44 | self.d = data
45 | self.s = nil
46 | self.t = nil
47 | }
48 |
49 | // MARK: Functions
50 | /// Returns self as a String
51 | func encode() -> String {
52 | var payload = ["op": self.op, "d": self.d]
53 |
54 | if self.t != nil {
55 | payload["s"] = self.s!
56 | payload["t"] = self.t!
57 | }
58 |
59 | return payload.encode()
60 | }
61 |
62 | }
63 |
--------------------------------------------------------------------------------
/Sources/Swiftcord/Gateway/ShardManager.swift:
--------------------------------------------------------------------------------
1 | //
2 | // ShardManager.swift
3 | // Swiftcord
4 | //
5 | // Created by Alejandro Alonso
6 | // Copyright © 2017 Alejandro Alonso. All rights reserved.
7 | //
8 |
9 | import NIOCore
10 | class ShardManager {
11 |
12 | /// The gateway url to connect to
13 | var gatewayUrl: String?
14 |
15 | /// Array of Shard class
16 | var shards = [Shard]()
17 |
18 | var eventLoopGroup: EventLoopGroup?
19 |
20 | /// Parent Swiftcord class
21 | weak var swiftcord: Swiftcord?
22 |
23 | init(eventLoopGroup: EventLoopGroup?) {
24 | self.eventLoopGroup = eventLoopGroup
25 | }
26 |
27 | /**
28 | Used to create a set amount of shards
29 | - parameter amount: Number of shards to instantiate
30 | */
31 | func create(_ amount: Int) {
32 | guard self.swiftcord != nil else { return }
33 | guard self.shards.isEmpty else { return }
34 |
35 | for id in 0 ..< amount {
36 | let shard = Shard(self.swiftcord!, id, amount, self.gatewayUrl!, eventLoopGroup: self.eventLoopGroup)
37 | self.shards.append(shard)
38 | Task {
39 | await shard.start()
40 | }
41 | }
42 | }
43 |
44 | /// Disconnects all shards from the gateway
45 | func disconnect() {
46 | guard self.shards.count > 0 else { return }
47 |
48 | for shard in self.shards {
49 | shard.stop()
50 | }
51 |
52 | self.shards.removeAll()
53 | }
54 |
55 | /**
56 | Kills a specific shard from the gateway
57 | - parameter id: Id of the shard to kill
58 | */
59 | func kill(_ id: Int) {
60 | guard let index = self.shards.firstIndex(where: { $0.id == id }) else { return }
61 |
62 | let shard = self.shards.remove(at: index)
63 |
64 | shard.stop()
65 | }
66 |
67 | /**
68 | Spawns a shard based off id
69 | - parameter id: Id of shard to spawn
70 | */
71 | func spawn(_ id: Int) {
72 | guard self.swiftcord != nil else { return }
73 | guard self.shards.first(where: { $0.id == id }) == nil else { return }
74 | guard self.gatewayUrl != nil else { return }
75 |
76 | let shard = Shard(
77 | self.swiftcord!,
78 | id,
79 | self.swiftcord!.shardCount,
80 | self.gatewayUrl!,
81 | eventLoopGroup: self.eventLoopGroup
82 | )
83 | self.shards.append(shard)
84 | }
85 |
86 | }
87 |
--------------------------------------------------------------------------------
/Sources/Swiftcord/Rest/RateLimit.swift:
--------------------------------------------------------------------------------
1 | //
2 | // RateLimit.swift
3 | // Swiftcord
4 | //
5 | // Created by Alejandro Alonso
6 | // Copyright © 2017 Alejandro Alonso. All rights reserved.
7 | //
8 |
9 | import Foundation
10 | import Dispatch
11 |
12 | /// Rate Limit
13 | extension Swiftcord {
14 |
15 | /**
16 | Gets the "route" for an HTTP request
17 |
18 | - parameter url: URL to get route from
19 | */
20 | func getRoute(for url: String) -> String {
21 |
22 | let regex = try! NSRegularExpression(
23 | pattern: "/([a-z-]+)/(?:[0-9]{17,})+?",
24 | options: .caseInsensitive
25 | )
26 |
27 | let string = NSString(string: url)
28 | let matches = regex.matches(
29 | in: url,
30 | options: [],
31 | range: NSRange(location: 0, length: string.length)
32 | )
33 |
34 | guard matches.count > 0 else {
35 | return url
36 | }
37 |
38 | var route = ""
39 |
40 | for match in matches {
41 | let miniRoute = string.substring(with: match.range)
42 | var parameters = miniRoute.components(separatedBy: "/")
43 |
44 | parameters.remove(at: 0)
45 |
46 | let parameterId = parameters[1]
47 | parameters[1] = ":id"
48 |
49 | if (parameters[0] == "channels" || parameters[0] == "guilds")
50 | && route.isEmpty {
51 | parameters[1] = parameterId
52 | }
53 |
54 | route += "/" + parameters.joined(separator: "/")
55 | }
56 |
57 | return route
58 | }
59 |
60 | /// Used to un clog the global queue full of requests that woudld've resulted in 429 because of global rate limit
61 | func globalUnlock() {
62 | self.isGloballyLocked = false
63 | for request in self.globalRequestQueue {
64 | request()
65 | }
66 | }
67 |
68 | /**
69 | Handles creating buckets, and making sure the bucket is up to date with the headers
70 |
71 | - parameter headers: The received headers from the request
72 | */
73 | func handleRateLimitHeaders(
74 | _ limitHeader: Any?,
75 | _ intervalHeader: Any?,
76 | _ date: Double,
77 | _ route: String
78 | ) {
79 | guard let limitHeader = limitHeader,
80 | let intervalHeader = intervalHeader else {
81 | return
82 | }
83 |
84 | let limit = Int(limitHeader as! String)!
85 | let interval = Int(round(Double(intervalHeader as! String)!)) - Int(date)
86 | if self.rateLimits[route] == nil {
87 | let bucket = Bucket(
88 | name: "me.azoy.swiftcord.rest.\(route)",
89 | limit: limit,
90 | interval: interval
91 | )
92 | bucket.take(1)
93 |
94 | self.rateLimits[route] = bucket
95 | }
96 | }
97 |
98 | }
99 |
--------------------------------------------------------------------------------
/Sources/Swiftcord/Types/Activities.swift:
--------------------------------------------------------------------------------
1 | //
2 | // Activities.swift
3 | // Swiftcord
4 | //
5 | // Created by Noah Pistilli on 2021-12-16.
6 | //
7 |
8 | import Foundation
9 |
10 | public struct Activities: Encodable {
11 | public let name: String
12 | public let type: Int
13 | public var url: String?
14 |
15 | public init(name: String, type: ActivityType, url: String? = nil) {
16 | self.name = name
17 | self.type = type.rawValue
18 | let isValidURL = validateUrl(url: url)
19 |
20 | if isValidURL {
21 | self.url = url
22 | } else {
23 | self.url = "https://www.twitch.tv/"
24 | }
25 | }
26 |
27 | private func validateUrl(url: String?) -> Bool {
28 | // If URL is nil then we can safely ignore
29 | if url == nil {
30 | return true
31 | }
32 |
33 | if !url!.contains("https://twitch.tv/") || !url!.contains("https://youtube.com/") {
34 | print("[Swiftcord] URL for activities requires either a Twitch or Youtube link. There will be no link to your stream in the RPC section.")
35 | return false
36 | }
37 |
38 | return true
39 | }
40 | }
41 |
42 | public enum ActivityType: Int, Encodable {
43 | case playing
44 | case streaming
45 | case listening
46 | case watching
47 | case custom
48 | case competing
49 | }
50 |
--------------------------------------------------------------------------------
/Sources/Swiftcord/Types/DM.swift:
--------------------------------------------------------------------------------
1 | //
2 | // DMChannel.swift
3 | // Swiftcord
4 | //
5 | // Created by Alejandro Alonso
6 | // Copyright © 2017 Alejandro Alonso. All rights reserved.
7 | //
8 |
9 | /// DM Type
10 | public struct DM: TextChannel {
11 |
12 | // MARK: Properties
13 |
14 | /// Parent class
15 | public internal(set) weak var swiftcord: Swiftcord?
16 |
17 | /// ID of DM
18 | public let id: Snowflake
19 |
20 | /// The recipient of this DM
21 | public internal(set) var recipient: User
22 |
23 | /// The last message's ID
24 | public let lastMessageId: Snowflake?
25 |
26 | /// Indicates what kind of channel this is
27 | public let type = ChannelType.dm
28 |
29 | // MARK: Initializer
30 |
31 | /**
32 | Creates a DMChannel struct
33 |
34 | - parameter swiftcord: Parent class
35 | - parameter json: JSON representable as a dictionary
36 | */
37 | init(_ swiftcord: Swiftcord, _ json: [String: Any]) {
38 | self.swiftcord = swiftcord
39 |
40 | self.id = Snowflake(json["id"])!
41 |
42 | let recipients = json["recipients"] as! [[String: Any]]
43 | self.recipient = User(swiftcord, recipients[0])
44 |
45 | self.lastMessageId = Snowflake(json["last_message_id"])
46 |
47 | swiftcord.dms[self.recipient.id] = self
48 | }
49 |
50 | }
51 |
--------------------------------------------------------------------------------
/Sources/Swiftcord/Types/GroupDM.swift:
--------------------------------------------------------------------------------
1 | //
2 | // GroupChannel.swift
3 | // Swiftcord
4 | //
5 | // Created by Alejandro Alonso
6 | // Copyright © 2017 Alejandro Alonso. All rights reserved.
7 | //
8 |
9 | /// GroupDM Type
10 | public struct GroupDM: TextChannel {
11 |
12 | // MARK: Properties
13 |
14 | /// Parent class
15 | public internal(set) weak var swiftcord: Swiftcord?
16 |
17 | /// ID of DM
18 | public let id: Snowflake
19 |
20 | /// The recipient of this DM
21 | public internal(set) var recipients = [User]()
22 |
23 | /// The last message's ID
24 | public let lastMessageId: Snowflake?
25 |
26 | /// Indicates what kind of channel this is
27 | public let type = ChannelType.groupDM
28 |
29 | // MARK: Initializer
30 |
31 | /**
32 | Creates a GroupChannel struct
33 |
34 | - parameter swiftcord: Parent class
35 | - parameter json: JSON representable as a dictionary
36 | */
37 | init(_ swiftcord: Swiftcord, _ json: [String: Any]) {
38 | self.swiftcord = swiftcord
39 |
40 | self.id = Snowflake(json["id"])!
41 |
42 | let recipients = json["recipients"] as! [[String: Any]]
43 | for recipient in recipients {
44 | self.recipients.append(User(swiftcord, recipient))
45 | }
46 |
47 | self.lastMessageId = Snowflake(json["last_message_id"])
48 |
49 | swiftcord.groups[self.id] = self
50 | }
51 |
52 | }
53 |
--------------------------------------------------------------------------------
/Sources/Swiftcord/Types/GuildCategory.swift:
--------------------------------------------------------------------------------
1 | //
2 | // Webhook.swift
3 | // Swiftcord
4 | //
5 | // Created by Alejandro Alonso
6 | // Copyright © 2017 Alejandro Alonso. All rights reserved.
7 | //
8 |
9 | /// Guild Channel Category Structure
10 | public class GuildCategory: GuildChannel {
11 |
12 | /// Parent class
13 | public weak var swiftcord: Swiftcord?
14 |
15 | /// Channel Category this channel belongs to
16 | public var category: GuildCategory? {
17 | guard let parentId = parentId else {
18 | return nil
19 | }
20 |
21 | return guild?.channels[parentId] as? GuildCategory
22 | }
23 |
24 | /// Collection of channels this category parents mapped by channel id
25 | public internal(set) var channels = [Snowflake: GuildChannel]()
26 |
27 | /// The id of the channel
28 | public let id: Snowflake
29 |
30 | /// Guild this channel belongs to
31 | public var guild: Guild? {
32 | return self.swiftcord?.getGuild(for: id)
33 | }
34 |
35 | /// Name of the channel
36 | public let name: String?
37 |
38 | /// Parent Category ID of this channel
39 | public let parentId: Snowflake?
40 |
41 | /// Collection of overwrites mapped by `OverwriteID`
42 | public internal(set) var permissionOverwrites = [Snowflake: Overwrite]()
43 |
44 | /// Position the channel is in guild
45 | public let position: Int?
46 |
47 | /// Indicates what type of channel this is (.guildCategory)
48 | public let type = ChannelType.guildCategory
49 |
50 | /**
51 | Creates Guild Category structure
52 |
53 | - parameter swiftcord: The parent class
54 | - parameter json: The data to transform to a webhook
55 | */
56 | init(_ swiftcord: Swiftcord, _ json: [String: Any]) {
57 | self.swiftcord = swiftcord
58 |
59 | self.id = Snowflake(json["id"])!
60 | self.name = json["name"] as? String
61 | self.parentId = Snowflake(json["parent_id"])
62 |
63 | if let overwrites = json["permission_overwrites"] as? [[String: Any]] {
64 | for overwrite in overwrites {
65 | let overwrite = Overwrite(overwrite)
66 | self.permissionOverwrites[overwrite.id] = overwrite
67 | }
68 | }
69 |
70 | self.position = json["position"] as? Int
71 |
72 | if let guildId = Snowflake(json["guild_id"]) {
73 | swiftcord.guilds[guildId]!.channels[self.id] = self
74 | }
75 | }
76 |
77 | }
78 |
--------------------------------------------------------------------------------
/Sources/Swiftcord/Types/Icon.swift:
--------------------------------------------------------------------------------
1 | //
2 | // Icon.swift
3 | // Swiftcord
4 | //
5 | // Created by Noah Pistilli on 2022-01-18.
6 | //
7 |
8 | import Foundation
9 |
10 | /// Represents the base64 encoded image needed to send to Discord for Emojis, Stickers, etc...
11 | public struct Icon {
12 | public let imageType: ImageType
13 | public let base64Image: String
14 |
15 | public init(imageType: ImageType, image: Data) {
16 | self.imageType = imageType
17 | self.base64Image = image.base64EncodedString()
18 | }
19 |
20 | func toDataString() -> String {
21 | return "data:\(self.imageType.rawValue);base64,\(self.base64Image)"
22 | }
23 | }
24 |
25 | public enum ImageType: String {
26 | case jpeg = "image/jpeg"
27 | case png = "image/png"
28 | case webp = "image/webp"
29 | case gif = "image/gif"
30 | }
31 |
--------------------------------------------------------------------------------
/Sources/Swiftcord/Types/Interactions/ActionRow.swift:
--------------------------------------------------------------------------------
1 | //
2 | // ActionRow.swift
3 | // Swiftcord
4 | //
5 | // Created by Noah Pistilli on 2021-12-19.
6 | //
7 |
8 | import Foundation
9 |
10 | /// ActionRow object that can hold any `Component`
11 | public struct ActionRow