/simple-discord

A simple API wrapper for Discord

Primary LanguageGo

simple-discord

simple-discord is designed to be a "simple" to use framework for interfacing with the Discord API. It takes advantage of the Gateway that Discord uses for requests back and forth between the simple-discord client and the actual API. Currently, the framework is limited in what it can do and is certainly not close to fully integrating with the Discord API.

Features

  • Golang Performance: Utilizes Go's performance by running the sending and receiving of data on different channels.
  • Custom JSON Unmarshalling: Populates an active session with easy-to-use Golang structs.
  • Active Cache: Maintains an active cache while the bot is running.

Installation

To run the project, simply install Go v1.22.3 or above, and run the following command to install the latest package into your project:

go get github.com/Carmen-Shannon/simple-discord@latest

Version

N/A no release yet, v0.1.0 will be the first release

In-Progress

This list will change as I want to add things

  • Struct definitions
  • Gateway management
    • Standard gateway management
    • Voice gateway management
  • Event handler
  • Shard management
  • HTTP requests
    • Application requests
    • Application Role Connection Metadata requests
    • Audit Log requests
    • Auto Moderation requests
    • Channel requests
    • Emoji requests
    • Guild requests
    • Guild Scheduled Event requests
    • Guild Template requests
    • Invite requests
    • Message requests
    • Poll requests
    • Stage Instance requests
    • Sticker requests
    • User requests
    • Voice requests
    • Webhook requests
  • Registering Custom Commands
    • Registering Global Commands
    • Registering Guild Commands
  • Tests
    • Integration tests
      • Gateway integration tests
      • HTTP integration tests
    • Unit tests