This is a guide than anyone (even if you don't know how to use the command line) can use to install and use SimplePresence!

⚠️ If you get any errors that are not mentioned in this guide, please click here for a list of common errors. If you don't find your error, please join the Discord Server.

Downloading

🚩Advanced users: Instead of using GitHub Desktop, you can just install Git and use git clone.

To download SimplePresence, you will need to clone the repository. The simplest way to do this, for beginners, is to use GitHub Desktop. Install it, then go to File > Clone Repository, then click the URL paste in justdotJS/SimplePresence in the URL field.

Title and Images

First, create an application at Discord's New App page. Set the App Name to the title of your Rich Presence playing status. For example, if you want Playing with discord, set the app name to with discord. You don't need to set a Redirect URI, Description, or App Icon, just click Create App. Next, click Enable Rich Presence here:

Uploading Images

Now you can upload your images. Scroll down to this part: You must upload one Large image. However, a small image is optional. Name it whatever you want, then click Upload Asset. Now you should have 1 or 2 assets:

Setting Up SimplePresence

Now that you have uploaded your images and set a title, it's time to set up your Rich Presence. Go back to GitHub Desktop, and go to Repository > Show in Finder/Explorer. A Finder/File Explorer window should open at the SimplePresence directory. Duplicate the config.json.example file, then rename it to config.json.
Now, open config.json in a code editor.

ℹ️ Examples of code editors include Atom and Visual Studio Code.

You should see something like this: First, set the Client ID. Go back to the Discord Developer Application page where you uploaded the images, and scroll to the top. You can find the Client ID here:
Now, set the details and state. Below, you can see which is which:

Now, its time to set up the imageConfig. Set the smallKey and largeKey to the names you used when you uploaded the images. In this example, smallKey is discordcanary and largeKey is eyes:

ℹ️ If you want no small image, set smallKey to none.

In our example, this is our finished config.json:

Setup

Now, its time to set up SimplePresence. If you are on macOS, open Terminal. If you are on Windows, open PowerShell.
Now, go to the SimplePresence directory, using the cd command.

ℹ️ On macOS, this will look like cd /Users/advaith/Documents/GitHub/SimplePresence. On Windows, this will look like cd C:\Users\advaith\Documents\GitHub\SimplePresence.

ℹ️ You will need npm/node.js. To check if you have npm, run npm -v. If it returns an error, download node.js here.

Now, run npm i.
Now, SimplePresence should be fully set up. Run npm run start to launch SimplePresence.

⚠️ If you get the error Electron failed to install correctly, try npm install electron, and do npm run start again.

The SimplePresence window should look like this:
And when you check your playing status, it should look like this:

Updating SimplePresence

🚩Advanced users: If you installed SimplePresence using command-line git, use git pull to update.

To update SimplePresence, simply go to GitHub Desktop, and click this button:

ℹ️ Don't worry, updating SimplePresence won't remove any of your settings.

Integrations and Customizations

You have now completed the SimplePresence guide! However, SimplePresence has many features not covered in this guide. Use the links below to check them out:

• Integrations
• Packaging
• Timestamps