Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thatsinewave/discord-rich-presence
A fully customizable CLI script that lets you run your own Custom Rich Presence
https://github.com/thatsinewave/discord-rich-presence
cli-app customizable discord discord-api discord-rpc discordrp good-first-contribution good-first-issue good-first-pr good-first-project mit-license open-source personal-use pypresence pypresence-library python rich-presence-cli rich-presence-discord rich-presence-statuses thatsinewave
Last synced: 3 days ago
JSON representation
A fully customizable CLI script that lets you run your own Custom Rich Presence
- Host: GitHub
- URL: https://github.com/thatsinewave/discord-rich-presence
- Owner: ThatSINEWAVE
- License: mit
- Created: 2024-03-01T10:54:26.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-08-09T06:01:44.000Z (3 months ago)
- Last Synced: 2024-08-09T07:23:34.134Z (3 months ago)
- Topics: cli-app, customizable, discord, discord-api, discord-rpc, discordrp, good-first-contribution, good-first-issue, good-first-pr, good-first-project, mit-license, open-source, personal-use, pypresence, pypresence-library, python, rich-presence-cli, rich-presence-discord, rich-presence-statuses, thatsinewave
- Language: Python
- Homepage: https://github.com/ThatSINEWAVE/Discord-Rich-Presence
- Size: 76.2 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Sinewave's CustomRP - Discord Rich Presence
Sinewave's CustomRP is a Python script designed to offer you the flexibility to showcase a fully customizable status (rich presence) on Discord. By leveraging the pypresence library, users can dynamically update their Discord presence with a variety of details, including project status, current activity, and more. This README provides all necessary details to get started, customize, and use the script effectively.
# [Join my discord server](https://discord.gg/2nHHHBWNDw)
## Features!
- **Multiple Rich Presence Configurations**: Configure and cycle through multiple rich presence settings as defined in a `config.json` file.
- **Dynamic Presence Updates**: Automatically update your Discord presence at specified intervals.
- **Customizable Elements**: Set detailed states, images, buttons, and more for each rich presence configuration.
- **Interactive Commands**: Control the script in real-time using command-line inputs.
- **Extensive Customization**: Utilize a wide array of parameters for rich presence, including details, state, images, and clickable buttons linking to external URLs.
## ☕ [Support my work on Ko-Fi](https://ko-fi.com/thatsinewave)
## Prerequisites
- **Python 3.6+**: Ensure Python is installed on your system. The script is compatible with Python 3.6 and newer versions.
- **pypresence Library**: A Python library that allows interaction with Discord's Rich Presence feature.
## Installation
1. **Install Python**: Download and install Python 3.6 or newer from the official Python website.
2. **Install pypresence**: Open a terminal or command prompt and install the pypresence library using pip:
```python
pip install pypresence
```
3. **Download the Script**: Download the Custom Discord Rich Presence script and the sample `config.json` file to your desired directory.
## Configuration (config.json)
The ``config.json`` file is where you define your rich presence configurations. Here's a breakdown of the file structure:
- `application_id`: Your Discord application ID.
- `timer_interval`: The interval (in seconds) at which the rich presence updates cycle through the configured messages.
- `message_sets`: An array of message configurations, each with the following fields:
- `name`: A unique identifier for the configuration.
- `details`, state: Text fields for setting the user's current activity.
- `large_image`, `small_image`: URLs or keys for the images to display.
- `large_text`, `small_text`: Hover texts for the images.
- `buttons`: An array of buttons, each with a label and a url.
- `party_size`: (Optional) Displays the current and maximum size of a party.
- `startTimestamp`, `endTimestamp`: (Optional) Timestamps to show elapsed or remaining time.
Refer to the provided config.json example for more detailed configurations.
## Usage
- **Start the Script**: Navigate to the script's directory in a terminal or command prompt and execute the script:
```python
python main.py
```
### Use Commands:
Once the script is running, it will prompt you for commands. Use the help command to see all available options:
- `start`: Initiates the rich presence update process.
- `stop`: Halts any ongoing rich presence updates.
- `mode `: Sets the update mode to cycle through all configured messages, stick to a single one or choose multiple ones.
- `timer `: Adjusts the interval between updates.
- `appid `: Updates the Discord application ID used for the rich presence.
- `help`: Displays a list of available commands.
- `info`: Information about your current setup.
- `about`: Shows information about the script.
- `quit`: Exits the script.
## Contributing
Contributions, issues, and feature requests are welcome! Feel free to fork the repository and submit pull requests.
## License
This project is open-source and available under the MIT License. See the LICENSE file for more details.
## Disclaimer
This script is not affiliated with or endorsed by Discord.
Use this script responsibly and in accordance with Discord's guidelines and terms of service.