Skip to content

Commit e61e8bd

Browse files
authored
Update README.md
Demo MVP similar to modrinth desc
1 parent a6bd851 commit e61e8bd

1 file changed

Lines changed: 85 additions & 10 deletions

File tree

README.md

Lines changed: 85 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,90 @@
1-
# Plugin Portal
1+
# 🌐 Plugin Portal
22

3-
Plugin Portal is an in-game Minecraft plugin downloader and updater using the SpigotMC, Modrinth & Hangar marketplaces. View resource data, install and update plugins all from the comfort of your Minecraft chatbar.
3+
**Plugin Portal** is the ultimate in-game plugin downloader and updater for Minecraft servers, integrating directly with the **Polymart**, **SpigotMC**, **Modrinth**, and **Hangar** marketplaces. Browse, preview, install, and update plugins all from the comfort of your Minecraft chatbar.
44

5-
Grab it from your favourite marketplace:
5+
> **Premium version available:** Unlock auto-updates, malware scanning, external source support, and more!
6+
> [🔗 View Plugin Portal Premium](https://polymart.org/product/6974/plugin-portal-premium)
67
7-
* **Modrinth:** https://modrinth.com/plugin/pluginportal
8-
* **Hangar:** https://hangar.papermc.io/Flyte/PluginPortal
9-
* * **SpigotMC:** https://www.spigotmc.org/resources/plugin-portal.108700/
8+
---
109

11-
Get support, suggest changes or chat about the project in our Discord: https://discord.gg/flyte
10+
## ✨ Features
1211

13-
## Carbon CLI (for developers)
14-
- Ensure you have built the file already
15-
- `carbon deploy ./plugin/build/libs/PluginPortal-2.2.1.jar /plugins --star <Carbon Star ID> -wr"`
12+
* 🚀 **Direct Install**: Install plugins directly from **Polymart**, **Spigot**, **Modrinth**, and **Hangar** with a single command.
13+
* 📚 **Massive Plugin Directory**: Instantly search and install from **100,000+ plugins** — no browser required.
14+
* 🔍 **Plugin Previewing**: View icons, descriptions, stats, and ratings in-game with `/pp view`.
15+
* 🔄 **Self-Updating**: Plugin Portal keeps itself up-to-date, automatically.
16+
* 🧭 **Cross-Version Compatible**: Works with **1.8+** and supports all major server jars — including **Folia**.
17+
* 🧹 **No Junk Plugins**: Automatically filters out inactive, deprecated, and abandoned plugins.
18+
19+
> Want even more? Scroll down to see what **Plugin Portal Premium** has to offer!
20+
21+
---
22+
23+
## 🖼️ Screenshots
24+
25+
**Installing from the chatbar:**
26+
27+
![Installing Plugin](https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExMjNmMDkyOWFlZWZjYjk1ODIwMzY2ZmQ5YmM0ZWI5ODQyM2U3NzEwNSZjdD1n/ibAI3FM0CPySWIbdJU/giphy.gif)
28+
29+
**Previewing a plugin in-game:**
30+
31+
![Plugin View](https://i.imgur.com/hTUkP2n.png)
32+
33+
**Updating your plugins effortlessly:**
34+
35+
![Plugin Update](https://i.imgur.com/SzQFXqj.png)
36+
37+
---
38+
39+
## 💻 Commands & Permissions
40+
41+
| Command | Permission | Description |
42+
| -------------------------------------------------- | ------------------------------- | ------------------------------------------------------------------------- |
43+
| `/pp view <name\|id> [platform] [-byId]` | `pluginportal.view` | View plugin preview including image, description, stats, and ratings. |
44+
| `/pp install <name\|id> [platform] [-byId]` | `pluginportal.manage.install` | Install a plugin from a marketplace using its name or ID. |
45+
| `/pp update <name\|id> [-byId]` | `pluginportal.maintain.update` | Update a plugin to its latest version from the original source. |
46+
| `/pp uninstall` or `/pp delete <name\|id> [-byId]` | `pluginportal.manage.uninstall` | Remove a plugin installed by Plugin Portal. |
47+
| `/pp list` | `pluginportal.view` | List all plugins installed through Plugin Portal. |
48+
| `/pp help` | `pluginportal.view` | Display the help menu with all commands. |
49+
| `/pp dump` | `pluginportal.dump` | Dump Plugin Portal's internal logs to [https://mclo.gs](https://mclo.gs). |
50+
51+
---
52+
53+
## 💎 Plugin Portal Premium
54+
55+
Upgrade to **Premium** for powerful features designed for serious server owners:
56+
57+
* 🔍 **Plugin Recognition**: Auto-detect and manage existing plugins not installed via Plugin Portal.
58+
* 🛡️ **Malware Detection**: Each download is scanned for safety using a Minecraft-specific scanner.
59+
* 🔄 **Automatic Updates**: Keep every plugin up to date automatically — no commands required.
60+
* 🌐 **Custom Adapters**: Install from GitHub, Jenkins, or other external sources.
61+
* 🕰️ **Install Specific Versions**: Need a particular version of a plugin? No problem.
62+
* 🧯 **Plugin Backups**: Roll back to earlier plugin versions if something breaks.
63+
* 🚀 **Priority Releases & Support**: Get updates and help faster than everyone else.
64+
65+
🔗 [**Get Plugin Portal Premium** on Polymart](https://polymart.org/product/6974/plugin-portal-premium)
66+
67+
---
68+
69+
## 🤝 Support
70+
71+
Need help or want to share feedback?
72+
73+
🧠 Join our Discord community: [https://discord.gg/flyte](https://discord.gg/flyte)
74+
75+
We have an active, friendly community of developers ready to assist you. ❤️
76+
77+
---
78+
79+
## 🛠️ Contribute
80+
81+
Plugin Portal is open source and community-driven!
82+
GitHub: [https://github.com/flytegg/plugin-portal](https://github.com/flytegg/plugin-portal)
83+
84+
### Ways to Contribute:
85+
86+
* 🧑‍💻 Open a PR to fix bugs or add features
87+
* 🐛 Report issues you encounter
88+
* 💡 Suggest features in our [Discord server](https://discord.gg/flyte) our via GitHub Issues
89+
90+
Thanks for using Plugin Portal! We hope it makes your server management easier than ever. ❤️

0 commit comments

Comments
 (0)