https://github.com/benjammin4dayz/jamrpc-alpha

A lightweight app to set Discord Rich Presence
https://github.com/benjammin4dayz/jamrpc-alpha

neutralinojs react

Last synced: about 1 month ago
JSON representation

A lightweight app to set Discord Rich Presence

• Host: GitHub
• URL: https://github.com/benjammin4dayz/jamrpc-alpha
• Owner: benjammin4dayz
• License: other
• Created: 2024-02-15T15:32:10.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-02-18T18:07:19.000Z (10 months ago)
• Last Synced: 2024-02-19T07:27:42.927Z (10 months ago)
• Topics: neutralinojs, react
• Language: JavaScript
• Homepage:
• Size: 620 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# JamRPC

This is a small desktop app which allows you to display rich presence on Discord.

![Preview](./img/preview.png)

Built using Neutralino, React, and Node.js, some features include:

- Continuously display rich presence.

- Hide the window in the system tray.

- Cross-platform (probably™).

Over time, I hope to expand these features with a drop-in module system to support different games or special activities. For example, a countdown to a special occasion, or the current score of your favorite sports match!

> [!Warning]  

> **Work in Progress** - features and bugs may appear or disappear at random. Check back often!

## 🧑‍💻 Setup Instructions

1.  #### Install the App

    Download the [latest release](https://github.com/benjammin4dayz/jamrpc-alpha/releases/latest) and extract it anywhere.

2.  #### Get Node.js

    Download a portable Node.js **binary** from [nodejs.org](https://nodejs.org/en/download/)

    - [v20.11.1 - Windows x64](https://nodejs.org/dist/v20.11.1/node-v20.11.1-win-x64.zip)

3.  #### Configure the App

    Drag and drop `node.exe` into the App's `extensions/` folder.

> [!NOTE]  

> This app expects a `node` executable inside the `extensions/` folder. Global installs are not supported at this time.

## 👥 Acknowledgements

| Name             | Reason                                                  | Links                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |

| ---------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

| Discord          | This project wouldn't exist without it                  |                                                                                                                                                                                                                                                                                                    |

| Neutralino.js    | A delightfully **tiny** framework for building web apps |       |

| Harald Schneider | Node IPC (backend) extension for Neutralino             |   |

---

### ✏️ Notes

Development

### Requirements:

[Node.js v20+](https://nodejs.org)

### Commands

1.  Prepare dependencies

        npm i -g @neutralinojs/neu && npm install

2.  Start the dev server

        npm run start

3.  Build the app

        npm run build

4.  Tidy up afterwards

        npm run clean

---