pothtonswer/discordmuffin
1
0
Fork 1
Code Issues 2 Pull requests 1 Projects 2 Releases Packages Wiki Activity Actions

Updated to match current state of package

Browse source
This commit is contained in:
Bruce Marriner 2015-11-16 13:24:34 -06:00
parent 91207ece15
commit f9c5f2bdc8
1 changed files with 31 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
README.md
View file

@ -1,43 +1,47 @@
# Discordgo # Discordgo
Discord API for Golang A Discord API for Golang
This is my first Golang project and it is ~~probably~~ ~~not~~ ~~maybe even~~ Discordgo provides an almost complete low-level Golang interface to the Discord
barely suitable for use :) REST and Websocket API layers. The majority of both of these interfaces are
complete and I should have the remaining functions finished soon.
Everything here so far is likely to change as I learn Golang better and refine At this point Discordgo is suitable for use with most projects including bots
the API names and such. Because of that I do not yet recommend this for use or clients. The function naming conventions and usage style should not change
with anything super important :) in the future. Function names are based primarily on the naming used by Discord
within their API calls. Should Discord change their naming then Discordgo will
be updated to match it.
Initially my goal was to write a chatbot and I started working with Special thanks goes to both the below projects who helped me get started with
https://github.com/Xackery/discord as my API. But that code didn't work 100% this project. If you're looking for alternative Golang interfaces to Discord
at the time. So I started slowly making changes to it and eventually ended up please check both of these out.
with something entirely different. Anyhow, credit goes to
https://github.com/Xackery/discord for getting me started.
If you're looking for a more functional Discord API for Golang check out * https://github.com/gdraynz/go-discord
https://github.com/gdraynz/go-discord which I recently found. It's much more * https://github.com/Xackery/discord
complete and will likely help me learn how to improve what I have here.
# What Works # What Works
Low level functions exist for the core REST API and Websocket API. Low level functions exist for the majority of the REST and Websocket API.
* Login to Discord * Login/Logout
* Get User information for a given user. * Open/Close Websocket and listen for events.
* Get Private Channels (used for Private Messages) for a given user. * Accept/Create/Delete Invites
* Get Servers for a given user. * Get User details (Name, ID, Settings, etc)
* Get Members of a given Server * List/Create User Channels (Private Message Channels)
* Get Channels for a given Server * List/Create Guilds
* Get Messages for a given Channel * List/Create Guild Channels
* Send Messages to a given Channel * List Guild Members
* Start a Websocket connection and listen for and handle events. * Receive/Send Messages to Channels
* Logout from Discord.
# What's Left
* Permissions related functions.
* Editing User Profile settings
* Voice Channel support.
* Functions for Maintenance Status
# Other Discord APIs # Other Discord APIs
- [go-discord](https://github.com/gdraynz/go-discord)
- [discord-go](https://github.com/Xackery/discord)
- [discord.py](https://github.com/Rapptz/discord.py) - [discord.py](https://github.com/Rapptz/discord.py)
- [discord.js](https://github.com/discord-js/discord.js) - [discord.js](https://github.com/discord-js/discord.js)
- [discord.io](https://github.com/izy521/discord.io) - [discord.io](https://github.com/izy521/discord.io)