Skip to content

Discord Rich Presence integration plugin for RPG Maker MZ.

License

Notifications You must be signed in to change notification settings

00due/Discord-RPC-for-RMMZ

Repository files navigation

Discord Rich Presence for RPG Maker MZ / MV

This plugin for RPG Maker MZ and MV allows your game to show a rich presence in Discord. Image

Download

Requirements: You have to use nwjs version 0.49.2 or higher. If you don't know how to update nwjs, check this awesome guide!

https://github.com/00due/Discord-RPC-for-RMMZ/archive/refs/heads/master.zip

Current version: 1.2

After downloading, extract the ODUE_discord.js (or the MV version if you're using RMMV) file into <your project's folder>/js/plugins

Troubleshooting

Please submit your issue to Github issues.

Initial setup:

0.If you don't have Node.js installed, install it from https://nodejs.org/en/download

1.Open the folder of your game (where you have your game.rmmzproject / Game.rpgproject in) and open CMD or powershell there.

2.Run the command npm install discord-rpc

---If you're getting an error Command not found or something like that, make sure you have Node.js installed!---

3.Go to https://discord.com/developers/applications and create your application. Click 'New application' and give it your game's name. After creating it, open the Rich Presence --> Art assets tab, and upload the large and small images.

---Recommendation: The large image is typically the logo of your game.---

---WARNING: The art assets have about 10-15 minutes delay until they become visible.---

4.Copy the Application ID from the 'General information' tab, and paste it into the 'Discord application ID on this plugin.

5.Fill the other plugin parameters with anything you want.

REQUIRED TO FILL:

Application ID, Large picture, Large picture text, Row 1

WARNING: After exporting for MV:

Move the folder node_modules from www/ folder to the folder where the executable is. Otherwise it can't find the node module.

(MZ) Plugin commands

  1. Open Plugin commands --> ODUE_discord

  2. Select either Edit row 1 or 2

  3. Type the new value of it.

You can also save the current values for later use.

As of ver1.1, deleting the second row is also possible.

Changing the small picture is currently exclusive to MZ.

(MV) Plugin commands

rpc_replaceRow1 <text to replace with> - Replaces row 1 (maximum 128 characters) rpc_replaceRow2 <text to replace with> - Replaces row 2 (maximum 128 characters) rpc_saveRows - Save both rows for later use rpc_restore <row1 / row2> – Restores a saved row rpc_enable row2 - Enables the second row rpc_disable row2 - Disables the second row

Examples:

// On battle start
rpc_saveRows
rpc_replaceRow1 Fighting a monster
rpc_disable row2

// On battle end
rpc_restore row1
rpc_enable row2

Plugins Commands (v1.2 Extended by Maxii1996)

You can use:

\partyX[stat] or \v[x]

Inside a plugin command to return that stat or variables inside command plugins.

Example:

\party1[name] will return Party 1 position Name.

Terms of use:

  1. You must give credit to ODUE
  2. You can freely edit this plugin to your needs. However, you must still credit me.
  3. This plugin is free for commercial and non-commercial projects.
  4. This plugin is provided as is. I'm not responsible for anything you make with this plugin.
  5. You can send feature requests to me on platforms such as Reddit (to u/SanttuPOIKA----). However, I have no obligation to fulfill your requests.

About

Discord Rich Presence integration plugin for RPG Maker MZ.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •