Getting Started

This section walks you through everything you need to write your first Plexcord plugin, from environment setup to a working, configurable plugin.

If you haven't read the Introduction yet, it covers what Plexcord is and what makes its plugin system powerful. Come back here when you're ready to build.

Before You Begin

You don't need to be an expert, but these basics will help:

If you're missing any of these, you'll pick them up as you go; the examples are practical and annotated.

Two Types of Plugins

Before writing a single line, decide where your plugin lives:

Official Plugins: src/plugins/

• Bundled with every Plexcord release
• Tracked in git, reviewed by maintainers
• Available to all users

Choose this when you want to contribute your plugin to the Plexcord project.

UserPlugins: src/userplugins/

• Private to your local installation
• Not tracked in git, no review needed
• Ideal for personal tools and experiments

Choose this when you're building something just for yourself, or when you're still experimenting.

Most developers start in src/userplugins/ and move to src/plugins/ when they're ready to contribute.

Your Path Through This Section

Follow these steps in order:

1. Prerequisites: Install Node.js, pnpm, and clone the repo
2. Quick Start: Build and run your first "Hello World" plugin
3. Plugin Structure: Understand the anatomy of a plugin file
4. Adding Settings: Make your plugin configurable with a settings UI
5. Next Steps: Where to go after the basics

Time Estimates

Getting Help

You can also use the search bar (Ctrl/Cmd + K) to find anything across the docs.

---

Next: Prerequisites →