-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
36 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,43 @@ | ||
# Discord-Luau | ||
<div align="center"> | ||
<p> | ||
<a href=""><img src="https://raw.githubusercontent.com/DiscordLuau/.github/master/resource/DiscordLuau-Banner.png" width="512" alt="discord-luau"/></a> | ||
</p> | ||
</div> | ||
|
||
A Luau discord API wrapper. This is the 'refactor' branch, where I take what i've learned from my first impl, and create a better library from what i've learned..! | ||
## About | ||
|
||
## Project Structure | ||
This is the **[Discord API](https://discord.com/developers/docs/intro) [Wrapper](https://rapidapi.com/blog/api-glossary/api-wrapper/)**, the resource that you'll be interacting with if you want to create a Discord Bot/Application! 🎉 | ||
|
||
- Package: responsible for containing all of the code used in this library | ||
- Classes: Generally contains the Luau 'objects' that the developer will be interacting with. | ||
- Data: Contains data that is used in multiple areas of the library, a singl source of truth in some sense. | ||
- Enums: Enums used internally | ||
- Std: The standard libraries that this project uses | ||
- If for instance, this library was to be ported to another runtime besides lune, you'd only need to change the Std files to get things up and working again :) | ||
- Types: Contains both internal and external types developers can use to assign types to things such as Messages | ||
- Utils: Simple utility scripts | ||
- Vendor: Modules pulled from other resources, most likely modified to run under Lune! | ||
### Project Structure | ||
|
||
- init.luau: requires 'Package/init.luau', useful if you call require() on this directory. | ||
- `init.luau`: Requires Package/init.luau | ||
- `/Package`: The source code for the Discord-Luau package | ||
- - `/Package/Classes`: All Discord-Luau generated obejcts/classes that the user can interact with. | ||
- - `/Package/Data`: Internal library 'data' modules, consisting of generic lua datatypes, with string values. | ||
- - `/Package/Enums`: Internal library 'enum' files, consisting of string keys and values. | ||
- - `/Package/Std`: Standard libraries that this library uses, if Discord-Luau were to switch to another Runtime, we'd just need to modify the `/Package/Std` folder to support the standard libraries for another Runtime. | ||
- - `/Package/Types`: Some awkward types that we need support for in Discord Luau | ||
- - `/Package/Utils`: Utility functions Discord Luau uses | ||
- - `/Package/Vendor`: Vendor, external resources or packages that Discord Luau uses | ||
- - `/Package/init.luau`: Entrypoint for Discord Luau | ||
|
||
## Project status | ||
### Project Status | ||
|
||
I'm activly working on this branch, ideally I have two days per week to commit/work on this project, so it's not going to be a quick library, but it'll be something! | ||
At the moment, I *([AsynchronousMatrix](https://github.com/4x8Matrix))* will write to the Master branch every now and again, if I introduce breaking changes, I may put that into it's own branch, but at the moment, since there's no `0.1.0` version in sight, the Master branch is where I lurk, adding potentially breaking changes every now and again..! | ||
|
||
:) | ||
Pull Requests are welcome! But there's no guarntee that what has been written in that Pull Request will be merged..! | ||
|
||
### Project Goals | ||
|
||
- Enabling developers to create a discord bot that connect to the Discord Websocket. | ||
- Send and recieve messages from a Discord websoket. | ||
- Take full advantage of the Discord REST Http Library. | ||
- Provide detailed and clear documentation on the Discord API Wrapper | ||
|
||
## Documentation | ||
|
||
Please head on over to the [Wiki](https://github.com/DiscordLuau/Discord-Luau/wiki) for further details, however, i'll soon enough set up a dedicated website for Discord Luau! | ||
|
||
## Examples | ||
|
||
Please take a look at the [/Examples](https://github.com/DiscordLuau/Discord-Luau/tree/Master/Examples) folder under the Master branch! |