Plugin rules and submission
Writing a plugin is the primary way to contribute. Before starting:
- Consider whether the plugin would be useful to a large portion of users. Niche plugins are not accepted
- Check existing pull requests to see if someone is already working on a similar plugin
- Read the rules below
- Plugins only use the PhoenixCord API. If it is missing something, propose an API addition instead
- No simple slash command plugins like
/cat. Make a user-installable Discord app instead - No simple text replace plugins like Let me Google that for you. The TextReplace plugin can do this
- No FakeDeafen or FakeMute
- No StereoMic
- No plugins that simply hide or redesign UI elements. That belongs in a theme
- No plugins that interact with specific Discord bots (official Discord apps like YouTube Watch Together are fine)
- No selfbots or API spam (animated status, message pruner, auto reply, nitro snipers, etc.)
- No untrusted third-party APIs. Popular services like Google or GitHub are fine, self-hosted ones are not
- No plugins that require the user to enter their own API key
- Do not add dependencies unless absolutely necessary
AI policy
Section titled “AI policy”All AI usage must be disclosed, the human submitting a plugin must fully understand it, and AI-generated slop gets you blocked. The full policy is in CONTRIBUTING.md.
Submitting
Section titled “Submitting”Open a pull request with the plugin in plugins/ and a test in crates/host/tests. cargo xtask test must pass.