Metadata-Version: 2.4
Name: ncspot-rpc-adapter
Version: 1.0.0
Summary: A small, python based extension to read ncspot data and display it on your profile in Discord using Discord's Rich Presence Client Protocol (RPC) 
License: MIT License
        
        Copyright (c) 2026 linuxlarper
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://codeberg.org/thinkpad/ncspot-rpc/
Project-URL: Repository, https://codeberg.org/thinkpad/ncspot-rpc/
Project-URL: Issues, https://codeberg.org/thinkpad/ncspot-rpc/issues
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pypresence
Requires-Dist: colorama
Requires-Dist: pydantic
Requires-Dist: inotify
Dynamic: license-file

# ncspot-rpc

> Discord Rich Presence Client (RPC) adapter for [ncspot](https://github.com/hrkfdn/ncspot)

A simple, semi-lightweight, python based extension to display [ncspot](https://github.com/hrkfdn/ncspot) data from a socket to your Discord Profile using Discords RPC Protocol and PyPresence.

## Why?
By default, ncspot does not interact with the Discord RPC, nor does it natively support it. This program acts a middleman and adapter for that missing bridge. For people who want to show what their playing to their friends on Discord, this program also serves as a replacement for several similar projects that are no longer supported or outdated.

The program acts a daemon you launch from a command-line using `ncspot-rpc`. We recommend you automatically set it up in a way to start on launch, or some sort of automatic run script.

## Prerequisites
- [Discord Client](https://discord.com) or [Vesktop/Vencord](https://vencord.dev) *(recommended)*
- [ncspot](https://github.com/hrkfdn/ncspot)
- **Linux** or Unix Based System *(Linux is the only platform we currently support, future compatibility expected in another update)*

## Example
![Highlight][concept]
![In list][username]
![Final Concept][profile]

## Installation

We recommend installing via [pipx](https://pipx.pypa.io/latest/installation/) for the best experience.

```bash
pipx install ncspot-rpc-adapter
```

> Other installation methods are not officially supported at this time.

## Documentation
To view the documentation we currently have available, use the hyperlinks below.

- ![**Configuration Guide**](docs/SETTING_CONFIG.md)
- ![**Custom Discord Client**](docs/CUSTOM_CLIENT.md)
- ![**Tech Overview**](docs/TECH_OVERVIEW.md)

## Credits
The following resources, and repositories contributed, helped or served as inspiration to the development of this project:

- [PyPresence](https://github.com/qwertyquerty/pypresence)
- [RichSpot (original idea)](https://github.com/M1ndo/RichSpot/tree/main)

<!-- MARKDOWN LINKS --->
[concept]: docs/static/concept.png
[username]: docs/static/username.png
[profile]: docs/static/profile.png

[python-logo]: https://img.shields.io/badge/python-096cbd?style=for-the-badge&logo=python&logoColor=white
[python-url]: https://python.org
