https://github.com/davidegalilei/nimpresence
A simple to use async Nim library which aims to use Discord's rich presence API with ease
https://github.com/davidegalilei/nimpresence
async discord library nim presence rich rich-presence
Last synced: 4 months ago
JSON representation
A simple to use async Nim library which aims to use Discord's rich presence API with ease
- Host: GitHub
- URL: https://github.com/davidegalilei/nimpresence
- Owner: DavideGalilei
- License: mit
- Created: 2021-11-15T20:28:59.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-11-16T19:58:10.000Z (over 3 years ago)
- Last Synced: 2024-11-14T20:43:10.597Z (6 months ago)
- Topics: async, discord, library, nim, presence, rich, rich-presence
- Language: Nim
- Homepage:
- Size: 44.9 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A simple to use async Nim library which aims to use Discord's rich presence API with ease
# NimPresence
## Features
- It's async
- Works on both Unix and Windows
- Has no external dependencies
- It's easy to use (check [examples](/examples) folder)
## Installation
```bash
$ nimble install https://github.com/DavideGalilei/nimpresence
```
## How to get Client ID?
Go to https://discord.com/developers/applications, authenticate, create an application, and get its client id. I will leave mine in the examples to make them reproducible.
## Usage
```nim
discard await presence.update(
state = some "Test #1",
details = some r"`\(^~^)/`"
`end` = some getTime().toUnix() + 1000,
buttons = some @[
Button(label: "aaaaa", url: "https://google.com"),
Button(label: "aaaaa", url: "https://google.com")
]
)
```
> ⚠️ **If the library is not working**
- Mixing parameters such as match/spectate/join with buttons is not permitted, and will not update your presence (try with different options)
- If you make too much requests in a short while, discord may ratelimit you for some minutes, try again later
- If it gives compile errors, remember that you need to use the `some` function from `std/options` library, since optional parameters are used in `Presence.update(...)`
## Credits
Special thanks to [pypresence](https://github.com/qwertyquerty/pypresence), which let me understand how Discord's socket works.
## License
This project is under MIT license.