Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hopto-dot/ttu-rich-presence

Adds Discord Rich Presence for https://reader.ttsu.app/
https://github.com/hopto-dot/ttu-rich-presence

chrome-extension discordrichpresence ebook japanese light-novel-reader light-novels rich-presence

Last synced: about 1 month ago
JSON representation

Adds Discord Rich Presence for https://reader.ttsu.app/

Awesome Lists containing this project

README

        

# ッツ Rich Presence
ttu-rich-presence is a chrome extension and accompanying server that adds Discord rich presence support for [ッツ Ebook Reader](https://reader.ttsu.app/).

The extension displays the book you're reading in your Discord status, along with how long you've been reading that book.

I am not a javascript programmer but I made this extension to fill a gap of missing functionality, feel free to dis my code. And, to the devs of ッツ Ebook Reader, feel free to natively add support for this!

**🗒 Make sure the rich presence server is running, otherwise the extension won't work! 🗒**

## [Firefox extension here 🦊](https://addons.mozilla.org/firefox/addon/ttu-reader-rich-presence/)

![image](https://github.com/hopto-dot/ttu-rich-presence/assets/66906618/573e2c12-6301-4a22-b673-b4bc176fd38f)

![image](https://github.com/hopto-dot/ttu-rich-presence/assets/66906618/cea310d0-ac03-44d6-b474-9e5a51d69dc1)

## Getting Started

To use this extension and server, follow the steps below:

### Requirements

- [Node.js](https://nodejs.org/)
- [Git](https://git-scm.com/downloads) (optional but recommended)

### Setting Up the Server
1. **Clone the Repository**

[Git method] Download the extension and rich presence server with the following commands:
```
git clone https://github.com/hopto-dot/ttu-rich-presence.git
```

[Non-git method] Download the source code for the [latest release](https://github.com/hopto-dot/ttu-rich-presence/releases/latest) (zip), unzip it, then place it where you want to store the extension and server.

2. **Run the Server**

Go into `ttu-server` and run `run_ttu_server.bat` (Windows only).

**OR**

Start the server using this command:
```
node server.js
```

➡ The Discord client (not website version) must be running for the Rich Presence to display.

### Setting Up the Extension
1. **Load the Extension into Chrome**
- Open Chrome and navigate to `chrome://extensions/`
- Make sure Developer mode is enabled at the top right
- Click "Load unpacked" and select the `ttu-rich-presence` folder

2. **Using the Extension**

➡ In order to use the extension the server must be running.

- Go to `https://reader.ttsu.app/` and open a book. That book will appear in your Discord rich presence.

## Contributing

Feel free to fork this repository and submit pull requests with any improvements or bug fixes.

## License

[CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/)