Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anntnzrb/dicostapres
DIsCOrd STAtus PREsence System. A minimal Discord presence system.
https://github.com/anntnzrb/dicostapres
discord python rpc
Last synced: about 6 hours ago
JSON representation
DIsCOrd STAtus PREsence System. A minimal Discord presence system.
- Host: GitHub
- URL: https://github.com/anntnzrb/dicostapres
- Owner: anntnzrb
- License: gpl-3.0
- Created: 2024-03-14T04:03:36.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-08-28T06:35:52.000Z (3 months ago)
- Last Synced: 2024-08-28T07:52:56.469Z (3 months ago)
- Topics: discord, python, rpc
- Language: Python
- Homepage:
- Size: 75.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# dicostapres
`di`s`co`rd `sta`tus `pre`sence `s`ystem is a minimal presence system for discord.
dicostapres is a tiny and lightweight Python script that allows you to:
1. Set a custom online status for your Discord account
2. Display a custom status message
3. Keep your Discord account online 24/7
## What This Project Is Not
- A bot
- A Python app which uses the discord.py library
- Free from possible abandonment
- Anything other than a toy project
## Prerequisites
- Python `3.11`+
- Poetry
- Discord Token
### Nix
This project is [nix flakes](./flake.nix) ready. Just hook into the shell and
install the dependencies using `poetry`.
## Installation
1. `git clone` & `cd` into the repository
```sh
git clone https://github.com/anntnzrb/dicostapres
cd dicostapres/
```
2. Install dependencies using `poetry`
```sh
poetry install
```
3. Create the `.env` file by `cp`-ing the `.env.example` file
```sh
cp ./.env.example ./.env
```
4. Modify the `.env` file accordingly
## Usage
The `3` environment variables that are required to set are:
- `DISCORD_TOKEN` - The user's Discord token
- `DISCORD_STATUS` - The status of the user. Can be `online`, `idle`, `dnd`
- `DISCORD_STATUS_MSG` - The custom status message
### Running
Simply execute `just run`:
```sh
just run
```
[Installation](#Installation) steps #3 and #4 may be omitted if the environment
variables are set manually. However, the `.env` method is preferred for less
verbosity.
```
DISCORD_TOKEN=Ujg5NzI3Nz... DISCORD_STATUS=online DISCORD_STATUS_MSG='Playing with dicostapres' just run
```
## COPYING
Refer to the [COPYING](./COPYING) file for licensing information.
Unless otherwise noted, all code herein is distributed under the terms of the
[GNU General Public License Version 3 or later](https://www.gnu.org/licenses/gpl-3.0.en.html).