README.md

DiscordRPC

A DiscordRPC with buttons, images, details and timestamp!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This repository was created so that people can easily create a custom rpc on their discord profile.

Here's why:

• You can promote your projects in discord states.
• It has buttons and timestamp.
• It is easy to install and use.
• fully customizable.

Use the install.bat to get started.

(back to top)

Getting Started

Follow the steps below to be able to run the rpc

Prerequisites

• node js Download Here

Installation

You should open a terminal window and install some dependencies.

1. Install Nodejs at Here (If you already have it, skip this step.)

2. Clone the repo

   git clone https://github.com/almightybtw/DiscordRPC.git

3. Install NPM packages

   install.bat

4. configure the file config.json

   {
    "clientId": "ClientID",
    "details": "Details",
    "largeImageKeyName": "largeImage",
    "largeImageText": "Text of largeImage",
    "smallImageKeyName": "smallImage",
    "smallImageText": "Text of smallImage",
    "buttonOneText": "ButtonText",
    "buttonOneURL": "ButtonURL",
    "buttonTwoText": "ButtonTwoText",
    "buttonTwoURL": "ButtonTwoURL"
    }

(back to top)

Usage

Use it to freely customize your discord rpc.

1. start the project

   start.bat

(back to top)

Roadmap

• Buttons
• Images
• customizable
• Multi-language Support
  • Spanish

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again! ⭐

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

My Discord - almighty#3225

DiscordRPC https://github.com/almightybtw/DiscordRPC

(back to top)