|
2 | 2 |
|
3 | 3 | A search aggregator for finding Minecraft: Java Edition server plugins on [Spigot](https://www.spigotmc.org), [Modrinth](https://modrinth.com/plugins), and [Hangar](https://hangar.papermc.io).
|
4 | 4 |
|
5 |
| -### Live Application: [https://mcpluginfinder.com](https://mcpluginfinder.com) |
| 5 | +### Try it out here: [https://mcpluginfinder.com](https://mcpluginfinder.com) |
6 | 6 |
|
7 | 7 | 
|
8 | 8 |
|
9 | 9 | ## Elevator Pitch
|
10 | 10 |
|
11 |
| -As a Minecraft server admin, have you ever been annoyed when trying to find a plugin? Do I have to search for it on Spigot? Or maybe it's on Modrinth? Or Hangar? And on top of all that, the plugin developer might have only posted their latest version on some platforms but not others. What a mess. |
| 11 | +As a Minecraft server admin, have you ever been annoyed when trying to find a plugin? Do I have to search for it on Spigot? Or maybe it's on Modrinth? Or Hangar? Then you have to check if the plugin has been recently updated or supports your Minecraft version. And on top of all that, the plugin developer might have only uploaded their latest version on some platforms but not others. |
| 12 | + |
| 13 | +What a mess. |
12 | 14 |
|
13 | 15 | MC Plugin Finder seeks to solve this problem by being the one-stop shop for searching all three of these platforms simultaneously, thanks to their public APIs. You can filter and sort your search results as desired, and you can compare versions of the same plugin on each platform to ensure that you are getting the latest version.
|
14 | 16 |
|
15 | 17 | ## How it Works
|
16 | 18 |
|
17 | 19 | MC Plugin Finder has two main components: The **ingest tool** and the **web app**.
|
18 | 20 |
|
| 21 | + |
| 22 | + |
19 | 23 | The **ingest tool** is a CLI application that retrieves plugin project data from the [Spiget API](https://spiget.org/) (for Spigot), [Modrinth API](https://docs.modrinth.com/), and [Hangar API](https://hangar.papermc.io/api-docs). The tool runs daily to update the database with the latest plugin information. It also considers projects from different plugin repositories to be the same if they **share the same source code repository URL**.
|
20 | 24 |
|
21 |
| -For example, suppose there was a project named "Foo" on Spigot and another project named "Bar" on Modrinth, and both projects have `https://github.com/example/asdf` as their source code repository URL. Both projects would be considered the same on MC Plugin Finder, even though their project names are different. |
| 25 | +For example, suppose there was a project named "Foo" on Spigot and another project named "Bar" on Modrinth, and both projects have `https://github.com/foo/foo` as their source code repository URL. Both projects would be considered the same on MC Plugin Finder, even though their project names are different. |
22 | 26 |
|
23 | 27 | On the other hand, if there were two projects named "Baz" on Spigot and Modrinth each, but the plugin developer forgot to add a source code URL to one of these plugin repositories, then these projects would **not** be considered be the same on MC Plugin Finder, even though their project names match.
|
24 | 28 |
|
| 29 | +**Examples illustrated:** |
| 30 | + |
| 31 | +| Spigot Plugin Name | Spigot Plugin Source URL | Modrinth Plugin Name | Modrinth Plugin Source URL | Considered the same plugin by MC Plugin Finder | |
| 32 | +| ------------------ | ---------------------------- | -------------------- | ---------------------------- | ---------------------------------------------- | |
| 33 | +| Foo | `https://github.com/foo/foo` | Bar | `https://github.com/foo/foo` | :heavy_check_mark: | |
| 34 | +| Baz | `https://github.com/baz/baz` | Baz | N/A | :x: | |
| 35 | + |
25 | 36 | MC Plugin Finder will only recognize URLs from these source code repository hosts:
|
26 | 37 | - [github.com](https://github.com)
|
27 | 38 | - [gitlab.com](https://gitlab.com)
|
28 | 39 | - [bitbucket.org](https://bitbucket.org)
|
29 | 40 | - [codeberg.org](https://codeberg.org)
|
30 | 41 |
|
31 |
| - |
32 |
| - |
33 | 42 | The **web app** allows users to search the database for plugins.
|
34 | 43 |
|
35 | 44 | The MC Plugin Finder hosted infrastructure runs an instance of [imageproxy](https://github.com/willnorris/imageproxy) to cache plugin project icons from Modrinth and Hangar as they are requested by users. This reduces the load on the Modrinth and Hangar CDNs, and provides improved image loading performance. Icon data for Spigot-hosted plugins are provided directly by the Spiget API and stored in the database, so no proxy or caching is needed in that case.
|
|
0 commit comments