Giter Site home page Giter Site logo

alairon / switchrp Goto Github PK

View Code? Open in Web Editor NEW
3.0 0.0 1.0 4.5 MB

An electron application for Nintendo Switch users that allows them to manually update their game status via Discord Rich Presence.

License: MIT License

CSS 3.24% JavaScript 58.77% HTML 37.98%
discord electron-application nodejs discord-rich-presence game-status

switchrp's Introduction

Switch RP

Introduction

Switch RP (Rich Presence) is an electron application for that allows users to update their game status via Discord's Rich Presence. This application was created because I wanted to share with other Discord users when I was playing on my Switch, but wanted an easier way to update my status apart from going into the settings every time.

Switch RP main screen
Image of the main screen as of v1.0.0

Prerequisites

This application requires the desktop version of Discord. If you don't already have it installed, you can download a fresh copy from Discord.

Installation

Installing from Source

Prerequisites

If running the program from source, you must have Node.js installed on your computer before continuing with this guide.

Downloading Node Packages

Direct a terminal to the downloaded/cloned directory where package.json is located. Install the following dependencies by typing npm install into a terminal:

Note: When installing the required packages, you may receive WARN messages from npm asking you to install peer dependencies. This application does not make use of those dependencies, and can be safely ignored.

Building from Source

If you would like to create an executable without the need of a terminal, type npm run build-<arch> into the terminal, replacing <arch> with:

  • win32 for Windows
  • linux for Linux

The compiled files will be placed in the dist folder, where you can then freely move the contents elsewhere.

Running the Application

From Source

After installing the required packages, type npm start into a terminal to start the program.

From Executable

If you downloaded the precompiled executable from GitHub, uncompress the zip folder, then click on "SwitchRP.exe".
Note that this executable is not digitally signed. Depending on your computer's security configuration(s), you may be required to allow this program to run.

Using the Application

Ensure that Discord is open in the background prior to opening the application.

For more information, please refer to the Wiki.

Development Information

Builds of v1.0.0 and earlier used the following configuration:

  • Node.js v11.2.0
  • npm v6.4.1
  • Electron 4.0.3

Builds with v1.0.1 and later uses the following configuration:

  • Node.js v12.13.0
  • npm v6.12.0
  • Electron v7.1.2

Limitations

Discord

A limitation from Discord only allows users to update their status once every 15 seconds. Your status may not be updated immediately after pressing the "Update Status" and "Disconnect" buttons.

switchrp's People

Contributors

alairon avatar dependabot[bot] avatar

Stargazers

 avatar  avatar  avatar

Forkers

deux01

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.