Swiftcord - Swift wrapper for Discord's API. Maintained fork of Azoy's Sword

Sketch

Last update: Nov 30, 2022

Related tags

Official SDK Swiftcord

Overview

Swiftcord - A Discord Library for Swift

Requirements

macOS, Linux, iOS, watchOS, tvOS (no voice for iOS, watchOS, or tvOS)
At least Swift 5.3

Adding Sword

Swift Package Manager

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

// swift-tools-version: 5.3

import PackageDescription

let package = Package(
    name: "yourswiftexecutablehere",
    dependencies: [
        .package(url: "https://github.com/SketchMaster2001/Swiftcord", .branch("master"))
    ],
    targets: [
      .target(
        name: "yourswiftexecutablehere",
        dependencies: ["Swiftcord"]
      )
    ]
)

After that, open Sources/main.swift and remove everything and replace it with the example below.

import Swiftcord

let bot = Swiftcord(token: "Your bot token here")

// Set activity if wanted
let activity = Activities(name: "with Swiftcord!", type: .playing)
bot.editStatus(status: .online, activity: activity)

// Set intents which are required
bot.setIntents(intents: .guildMessages)

bot.on(.messageCreate) { data in
  let msg = data as! Message

  if msg.content == "!ping" {
    msg.reply(with: "Pong!")
  }
}

bot.connect()

For more examples, look in the examples folder or in the Wiki.

Running the bot (SPM)

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

Running the bot in Xcode (SPM)

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!

Then click the play button!

Links

Documentation - Created using Apple docc and converted to HTML with docc2html

Swiftcord Discord server

Comments

Add getApplicationCommands() methods, move towards Codable in request()

Adds getApplicationCommands() methods to Swiftcord and Guild, to return an array of ApplicationCommand objects which can be inspected. ApplicationCommand objects aren't meant to be used to make new commands, just see what's currently in the global and guild spaces for a bot.

Also add a parameter to request() and requestWithBodyAsData() and their associated baseRequest...() methods to tell them to return the JSON received from the API as the Data, rather than running it through JSONSerialization and turning it into objects. This is useful for callers who want to just use the straight JSON data to use JSONDecoder to build objects.

opened by TorgoKong 2
Robust-ify SlashCommandBuilder

Make init methods throwable for ApplicationCommand and other objects it uses, so we can check for property length/size requirements, thus avoiding "Invalid Form Body" errors coming back from the API in these situations. Some other changes regarding Codable conformance of property names (snake-case vs. camel-case).

opened by TorgoKong 1
Add `messageContent` privileged intent

This new privileged messageContent intent is now required for receiving full content of all messages. Without this, as of September 2022, a bot will receive content of messages only in specific circumstances, such as when you @mention the bot.

For example, without this, if you just write "Hello everybody!" in a guild, a bot will still receive the event with some related info in it, but the event won't contain "Hello everybody!" anywhere in it since this intent is not enabled.

related post: https://support-dev.discord.com/hc/en-us/articles/4404772028055

opened by MahdiBM 0
Added addChoices() that takes an array of ApplicationChoices, addRole() and removeRole() functions.

Added an addChoices() function to ApplicationCommandOptions that takes a pre-built array of ApplicationChoices, in addition to the variadic form. Added addRole() and removeRole() to Guild to implement those endpoints in the API.

opened by TorgoKong 0
Make InteractionEvent a class-only protocol

This allows the extension to mutate without needing mutating, allowing calling deferReply and setEpheremal from a ListenerAdapter, which receives classes by reference and not by inout (required to call mutating funcs).

In short, you can now call deferReply and setEpheremal on arguments in ListenerAdapter as the examples show.

opened by pontaoski 0
Fix evenloop lifecycles issues and add case for normalclosure

This PR fixes some eventloop lifecycle issues as well as adding a case for the websocket errorcode normal closure

Without the handling of that error code, discord would send the code and the bot would stop as discord said it wasn't needed anymore. Now however we try to reconnect on an incoming normal closure request

opened by BennyDeBock 0
Always use `guilds` intent

We need the guilds intent for caching. If the user doesn't include this intent, many functions are rendered useless. As such we will force the intent.

opened by noahpistilli 0
Fix gateway connection

I wouldn't have made this PR, but it is very important. So I didn't realize that url.path didn't include the params needed to connect to the proper API version. As such, it was actually on gateway v6. This PR fixes it and uses EmbedBuilder for sending embeds.

opened by noahpistilli 0
Add Support for the v9 API

This adds Slash Commands, User Commands, Message Commands, Button and Select Menus, Threads, Guild Scheduled Events, Stage channels and a more in depth Activities setup.

opened by noahpistilli 0
Update getting started code in Readme.md
Adds a notice because .package(url: String, requirement: Package.Dependency.Requirement) is deprecated in swift 5.5 and up

Fixes the code in the onMessageCreate function so that it now compiles

The main class example now uses 4 spaces for indention, to be more consistent with the Package.swift example
opened by Candygoblen123 0
Add subcommand support

Adds subcommand support for slash command To produce a clearer way to handle the subcommand type of option, a refactor to SlashCommandEvent might be needed.

opened by frank89722 0
Add Voice Support
This PR adds voice support to Swiftcord.

What works

Playing PCM and Opus Audio

Basic Gateway support

Todo

Handle Voice Gateway errors

Try to add ffmpeg support (I have had insane trouble with it taking too long)

Receiving audio
opened by noahpistilli 0

Releases(0.9.3)

0.9.3(May 9, 2022)

Swiftcord Release v0.9.3

This release fixes issues that may occur with the web socket connection.

Big thanks to @BennyDeBock and @0xTim!
Source code(tar.gz)
Source code(zip)