Code Monkey home page Code Monkey logo

urban-octo-guacamole's Introduction

Replugged plugin template

Use this template

Prerequisites

Install

  1. Create a copy of this template
  2. Clone your new repository and cd into it
  3. Install dependencies: pnpm i
  4. Build the plugin: pnpm run build
  5. Reload Discord to load the plugin

The unmodified plugin will log "Typing prevented" in the console when you start typing in any channel.

Development

The code must be rebuilt after every change. You can use pnpm run watch to automatically rebuild the plugin when you save a file.

Building using the script above will automatically install the updated version of the plugin in Replugged. You can find the plugin folder directories for your OS here.
If you don't want to install the updated version, append the --no-install flag: pnpm run build --no-install.

You can format the code by running pnpm run lint:fix. The repository includes VSCode settings to automatically format on save.

API docs coming soon(tm)

Distribution

For plugin distribution, Replugged uses bundled .asar files. Bundled plugins can be installed to the same plugin folder as listed above.

This repository includes a GitHub workflow to compile and publish a release with the asar file. To trigger it, create a tag with the version number preceded by a v (e.g. v1.0.0) and push it to GitHub:

git tag v1.0.0
git push --tags

The Replugged updater (coming soon™) will automatically check for updates on the repository specified in the manifest. Make sure to update it to point to the correct repository!

You can manually compile the asar file with pnpm run build-and-bundle.

Troubleshooting

Make sure Replugged is installed and running.

Open Discord settings and make sure the Replugged tab is there. If not, follow these instructions to install Replugged.

Make sure the plugin is installed.

Check the plugin folder for your OS and make sure the plugin is there. If not, make sure you have built the plugin and that the NO_INSTALL environment variable is not set.
You can run replugged.plugins.plugins.keys() in the console to see a list of plugins in the plugin folder.

Make sure the plugin is running.

Check the console for a message saying [Replugged:Plugin:Plugin Template] Plugin started. If you don't see it, try reloading Discord. If that doesn't work, check for any errors in the console.

urban-octo-guacamole's People

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.