Plexcord LogoPlexcord
Best Practices

Best Practices

Write production-quality Plexcord plugins. Code quality, performance, security, and maintenance guidelines.

Best Practices

This section covers the patterns and practices followed by high-quality Plexcord plugins. Read these before submitting a plugin to the official repository.

What's Covered

Quick Checklist

Before releasing or submitting a plugin:

  • stop() cleans up all resources from start()
  • No console.log: use Logger instead
  • No hardcoded user IDs or server IDs
  • Settings have sensible defaults
  • TypeScript compiles without any casts (if avoidable)
  • User inputs are validated before use
  • No network requests to external services without user consent
  • Flux handlers check relevance before heavy processing
  • Description accurately describes what the plugin does

The Golden Rules

  1. Always clean up in stop(): Remove every listener, interval, and DOM change
  2. Use the Logger: Don't pollute the console with raw console.log calls
  3. Respect user settings: Check your settings before doing anything
  4. Fail gracefully: Use try/catch around fragile code (patches, Webpack lookups)
  5. Keep it focused: One plugin, one purpose

Frequently Asked Questions

Find answers to common questions about Plexcord.

General

What is Plexcord?

Plexcord is an open-source Discord modification that enhances your Discord experience with additional features and customization options.

Is Plexcord safe to use?

Yes, Plexcord is completely open-source and regularly audited by the community. You can review all code on GitHub.

Is Plexcord free?

Yes, Plexcord is completely free and open-source under the MIT license.

Installation & Setup

Which Discord versions are supported?

Plexcord supports Discord Stable and PTB (Public Test Build) on Windows, macOS, and Linux.

Do I need to reinstall Plexcord after Discord updates?

Usually no, but major Discord updates may require reinstallation. Check the Installation Guide for details.

Can I use Plexcord with BetterDiscord?

While technically possible, it's not recommended as conflicts may occur. Choose one modification at a time.

Features & Configuration

How do I enable/disable specific features?

Go to Discord Settings → Plexcord → Features and toggle the features you want.

Can I create custom themes?

Yes! Check out the Theme Customization guide.

How do I create plugins?

See the Plugin Development guide for a complete walkthrough.

Troubleshooting

Plexcord isn't loading after installation

  1. Make sure Discord is completely closed
  2. Restart Discord
  3. Check if Plexcord files are in the correct directory
  4. See the Troubleshooting section

Discord crashes after installing Plexcord

This is usually due to conflicting modifications or corrupted installation:

  1. Completely uninstall Plexcord
  2. Reinstall Discord
  3. Install Plexcord again using the Installation Guide

Features are missing or not working

  1. Verify you have the latest Plexcord version
  2. Check if the features are enabled in settings
  3. Look for error messages in the console (Ctrl+Shift+I)

Contributing

How can I contribute to Plexcord?

Check out the GitHub repository for contribution guidelines.

I found a bug, where do I report it?

Please report bugs on GitHub Issues.

Can I translate the documentation?

Yes! Documentation translations are welcome. Contact the maintainers on GitHub.

Still have questions?

Join our Discord community or open an issue on GitHub.

On this page