Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,24 @@
![RusherHack Logo](https://avatars.githubusercontent.com/u/121969799?s=280&v=4)

# Plugin/Theme Submission or Metadata Update
# Plugin/Theme Registry or Website Update

Thank you for contributing to the RusherHacks Plugin Collection!
Please fill out the details below to help keep review quick and clean.

## Type of Change

- [ ] Plugin/theme registry update
- [ ] Plugin/theme search website update
- [ ] Both

## Summary of Changes

<!--
Briefly describe what this PR does:
- Add a new plugin or theme
- Update an existing YAML entry
- Fix metadata, screenshots, descriptions, or formatting
- Update the plugin/theme search website
-->

## Before You Submit
Expand All @@ -29,14 +36,17 @@ PRs are mainly for:
- adding a new plugin or theme
- correcting metadata the automation cannot determine
- updating descriptions, screenshots, creator info, version support, or structure in `data/plugins-and-themes.yml`
- updating the plugin/theme search website

## Checklist

- [ ] I updated only `data/plugins-and-themes.yml` and, if needed, related `Assets/**` files for screenshots
- [ ] I updated only the relevant files for this PR
- [ ] If this is a registry update, I updated `data/plugins-and-themes.yml` and, if needed, related `Assets/**` files for screenshots
- [ ] If this is a website update, I changed only the relevant website files
- [ ] All required fields are present and correctly formatted
- [ ] YAML syntax is valid (quotes, spacing, indentation)
- [ ] GitHub repo is public and accessible
- [ ] MC versions and release info are accurate
- [ ] YAML syntax is valid (quotes, spacing, indentation), if applicable
- [ ] GitHub repo is public and accessible, if applicable
- [ ] MC versions and release info are accurate, if applicable
- [ ] This PR is not only for auto-managed release, jar, or generated file updates

> **When a PR is opened or updated, GitHub Actions automatically validates the PR changes and the YAML file.**
Expand Down
5 changes: 5 additions & 0 deletions .github/workflows/deploy-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ jobs:
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Fetch github stats
run: python3 scripts/fetch-stats.py
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Build static API
run: |
Expand Down
Binary file added Assets/CustomCapes/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 24 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,16 @@

# Contributing to the RusherHacks Plugin Collection

Thanks for helping improve the registry!
**TL;DR: You only need to edit one file:** `data/plugins-and-themes.yml`.
All pages, JSON, badges, and API files are generated automatically by our scripts and GitHub Actions.
Thanks for helping improve the registry and website.

**TL;DR:**
- For registry updates, you usually only need to edit `data/plugins-and-themes.yml`
- For website updates, only edit the relevant website files
- Generated pages, JSON, badges, and API files are handled automatically

## How it works

- **Source of truth:** `data/plugins-and-themes.yml`
- **Source of truth for plugin/theme data:** `data/plugins-and-themes.yml`
- **Auto-generated outputs (no manual edits):**
- `PLUGINS.md`, `THEMES.md`
- `README` badges / counts
Expand All @@ -20,7 +23,7 @@ If something is wrong, the checks will fail with a helpful error message.

After a YAML change is merged into `main`, GitHub Actions automatically regenerates the markdown and JSON output files.

### Automatic update handling
## Automatic update handling

Routine plugin and theme update maintenance is handled automatically by our scripts.
This includes things like refreshing release metadata, generated outputs, and related registry files.
Expand All @@ -35,18 +38,28 @@ PRs are mainly needed for:
- adding a new plugin or theme
- fixing or improving descriptions, screenshots, metadata, or structure in `data/plugins-and-themes.yml`
- correcting information the automation cannot determine on its own
- updating the plugin/theme search website

## What you need to do

### For registry updates

1. **Edit `data/plugins-and-themes.yml`**
- Add a new entry **or** update an existing one.
- Keep the existing structure and indentation.
- Add a new entry or update an existing one
- Keep the existing structure and indentation

2. **Open a Pull Request**
- Use the PR template and check the box confirming you only changed the YAML.
- Use the PR template and mark it as a registry update

> That’s it—no generated files need to be edited manually in your PR.
> No generated files need to be edited manually in your PR.

### For website updates

1. **Edit only the relevant website files**
2. **Open a Pull Request**
- Use the PR template and mark it as a website update

## Required fields (per entry)
## Required fields (per registry entry)

- `name`: Display name
- `repo`: GitHub repo (`owner/repo` format preferred)
Expand All @@ -60,7 +73,7 @@ PRs are mainly needed for:
- `added_at`: ISO date string when the plugin was added to the registry
- `updated_at`: ISO date string of the latest registry update (auto-managed by automation)

## Example entry
## Example registry entry

```yaml
- name: 2b2t.vc Rusherhack
Expand Down
50 changes: 33 additions & 17 deletions PLUGINS.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

# Plugins List

[![Plugins](https://img.shields.io/badge/Plugins-126-green)](#plugins-list)
[![Plugins](https://img.shields.io/badge/Plugins-127-green)](#plugins-list)
[![RusherHack v2.0.6](https://img.shields.io/badge/RusherHack-v2.0.6-purple?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOsAAADqCAYAAABDVrJwAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAnnSURBVHhe7d0xjx1XGcbxnRUkQUE4Ekj+AqvUqaCMBClooKKAzhJtOiLRuIGIloiI0kTuEBIVoqDhK7ijc0NppUIoQWEt38yxZq3rdx5rX58z98w8c/+/6E1GzsyZOTPz+Pgc390d3n/v6nDR2Te+OUxbfT297t7Vi48+/mTa2r9Hjx5NW/v39798Nm31czn9F8DGEVbABGEFTOTDehjne7GwP+WxxnLTow9l2aW2KjGyAiYIK2CCsAImCCtgIh/WYZwZx6rVYwFAKZccCy/bwz3q0Qf1DmerEiMrYIKwAiYIK2CCsAIm1glrjwUARU32l7yWJdvqQd2PrVvyemNbre1lVb4njKyACcIKmCCsgAnCCphYPqyVk+fVLLnIoNpS1aKlvXhcj2cVz1mqxZLXG9tqbS9L3ZPEdTCyAiYIK2CCsAImCCtgYvGwDuNkOdZM+bVYexUXDl6xeJDW0l7tcS3iOXud100iD4ysgAnCCpggrICJ4YPvv7vnGePqfvWbP0xbR9Qd38Fc7unTp9NWP7/99YfT1kLUcxDP6ztvvzFt9cPICpggrIAJwgqYIKyACcK6pOO/+L8pJbtf1s1fpB/XVmz52pQNXy9hBUwQVsAEYQVMEFbABGFd0lqLE7ULVi3Xq45VVXttmCGsgAnCCpggrIAJwgqYIKxZe1wkiX16nX6pY1WdE7XAtiDCCpggrIAJwgqYIKyACcKadcKFg9XEPu2lX2s58QIbYQVMEFbABGEFTBBWwARhPWcnXhDZFNVXVT1ULuwRVsAEYQVMEFbABGEFTAzfe+ed2fT2cJjPeOXce8jNyA/hx58Ph9PP5GUfLsV5n4nZveiXai/K3qNMW8+J30rVvZN9TZxX7ZMl+7Dw9SrpexeoZ39Qz14YRL8Oz6aNhWR6z8gKmCCsgAnCCpggrIAJucDUIrN4kF6cUJP45IJNZoHldWT6oBYJ6s+Y70P1fup+iLZkx5ILc2lhEbJQizipPijZaxPtqTOo1uR+LfckYGQFTBBWwARhBUwQVsBE0wJT7YJNy+S8ZYFFLmJVfpoqex1qwUIudrTspyTuibxedUqxmJRdOMm+I7XPOvscstehtPRVHqnai8eKfRhZAROEFTBBWAEThBUwkV5gapmgx98S0os66pzJxYPaBYsi01fZg4ZzSgv3f9Ze9joU8Ymjiw5f+piReX5F+jlsBCMrYIKwAiYIK2Bi+O6dO7M/4Ms/yS/45/umeVyD6rldEfZrmRfJY9Vvm+qrTqb/viR5jngtS96P5xr2E0fqawla+pA9Z/ZZK6oHmfOqczKyAiYIK2CCsAImCCtgQn8oQs3Ps195oSbjcT812Re/bbR8f+HsooA8Q6Zf2b4Laq/swoa855WWXjhR9yTbhzX6mm5fHCvvnBr6Kr+/sLo2RlbABGEFTBBWwARhBUws/m1d5KQ97pec2LcsgCjqBwxlv1Kk9lp+/+mn09YtVPPJ9Q/ls08+nrb6+de/P5+2jogFFtlV8U7I92v67wuZ963I7qck39e07PUFjKyACcIKmCCsgAnCCphYPKxlUSBWlNmnKFPuWFnq2PKDjmaVvZZhuLWaxIttbE46cfvy/pZfD9Vy72btDeMziyX2m/V9LL3f+D9iCfK9EaX2G//P/LwJjKyACcIKmCCsgAnCCphoCqtaKFB1cflylSl7rHHmPasy8Y6lyHOqEsqvxlLXEkstHHRRTpMpJe4jO19v4eZke7Pn/Gz8xVBxn1LlSzxjqf2U7LOOt7eUOoeqWUcFRlbABGEFTBBWwARhBUzosMbJbqkyqY4lqMn4bHJf9gs1zrLnJajJuTpnVryO50eObcYq3yPquNR1dFFOk6kM2fl6qjl5n8rziSWUX53VuO9tzznuU0peh5A9NluqPVkhI+MvzkqHFcDmEFbABGEFTBBWwMSlmuzKmf04WY6ljlWT7Exl21LUftn2VKljZ5+UwYy6l0p8tUop5ehZiXPEUuQzFbLtqYtT51DtZWr816wYWQEThBUwQVgBE4QVMFG+aG02V1YT5fFfs1ITY3lsgmprdmFjZdtX7aljValjYynZ/c7d0eN8UVK5f7Gi8XnFUs9BlXr2ityv7BoqfQ5Rs30ERlbABGEFTBBWwARhBUwMH/zgXT2bPaH//PeraauvO99+c9rq5/pafNyp+x3v44uv/j9t9fP2m29MW319eX09bR058XNlZAVMEFbABGEFTBBWwARhLR+KibWksugQa8uy9yO7316t8FwJK2CCsAImCCtgYh9hbZk/rTD32LTs/VD7ZWsrWt6bFTCyAiYIK2CCsAImCCtgYh9h3fIixpYtvcCi2lO1FWbvDSMrYIKwAiYIK2CCsAIm1gnrlhcdOkh3P71jJbMFFkeD+KcWIytggrACJggrYIKwAibWCata2IgLKfXz8NNY8NpU96X0jtiE+I6MdRD/1GJkBUwQVsAEYQVMEFbAxPD+e1fdly3W+KE+xZ//9s9p6wyUBY4tOPFz/flPfjht9ZX+gVjqOVTeE0ZWwARhBUwQVsAEYQVM6LAefQLjRS2pTLBjtTj19QK1FnzXGVkBE4QVMEFYAROEFTChw7rgpLgLt+vdqz08hw33gZEVMEFYAROEFTBBWAEThHUNfOLqtFoWiTb8bAgrYIKwAiYIK2CCsAIm9hvWDS8UNC2AZNWeo/a4Lck++7X6mr2+gJEVMEFYAROEFTBBWAETfmHNTs7XWjzYiux9itRxqtay5HXEtlrby6p8NxlZAROEFTBBWAETq/xgqj/99R/TVl9XV1fTVj/37t2btjYgzskWfvIPHz6ctvp5/PjxtNXXL376o2nrFmoeXHnfGVkBE4QVMEFYAROEFTBBWM/JzV/A39SZOxwOs1pcvOcNpyCsgAnCCpggrIAJwgqY2E5Yj7/y4abg71uiTi35Lg3DMKsu4rUlT8vICpggrIAJwgqYIKyAie2EdcFPemBD/ifq1JZ+lyoXhF6p8voYWQEThBUwQVgBE4QVMEFYgdtULgi9lsQCFmEFTBBWwARhBUwQVsDEZZzXvmJui7dCrWWNB7bGOc9NYgGLkRUwQVgBE4QVMEFYARNtP0VOLTQkWvvdH3M/bUx90+WW75Pz4MGDaaufJ0+eTFv7d/fu3Wmrn/v3709bff3yZz+etvphZAVMEFbABGEFTBBWwERbWG8+bXFcC4rfgLllcanZzSd3bgrIiO9Nw7vDyAqYIKyACcIKmCCsgAnCmnXChbSz07LoUnvcWuJ70/DuEFbABGEFTBBWwARhBUwQVvTXsuhSe9wOEFbABGEFTBBWwARhBUz0Cavbp06ADWJkBUwQVsAEYQVM9AnrGf9FNlYQ10h2sk7CyAqYIKyACcIKmCCsgIWLi68BQPqYEKtSNCEAAAAASUVORK5CYII=)](https://rusherhack.org/changelog.html)
[![↓ Go to Bottom](https://img.shields.io/badge/↓-Go%20to%20Bottom-blue?style=flat)](#plugins-bottom)

Expand Down Expand Up @@ -43,6 +43,16 @@ Core plugins provide deeper integration with RusherHack by modifying Minecraft

<table>
<tr>
<td align="left" valign="top" width="50%">
<a href="https://github.com/FelekDevYT/CustomCapes"><img src="https://avatars.githubusercontent.com/FelekDevYT?s=400" alt="CustomCapes" width="100" height="100" style="border-radius:12px;"></a>
<div><strong><a href="https://github.com/FelekDevYT/CustomCapes">CustomCapes</a></strong>&nbsp;<code>plugin</code></div>
<div style="margin:4px 0 6px 0;">A high-performance, client-side cosmetic extension for RusherHack that allows using any custom cape textures with automatic elytra synchronization.</div>
<div>
<img alt="stars" src="https://img.shields.io/github/stars/FelekDevYT/CustomCapes?style=flat">
&nbsp;<img alt="downloads" src="https://img.shields.io/github/downloads/FelekDevYT/CustomCapes/total?style=flat">
&nbsp;<img alt="added" src="https://img.shields.io/date/1775347200?label=added&style=flat">
</div>
</td>
<td align="left" valign="top" width="50%">
<a href="https://github.com/FelekDevYT/ChestIndexer"><img src="https://avatars.githubusercontent.com/FelekDevYT?s=400" alt="ChestIndexer" width="100" height="100" style="border-radius:12px;"></a>
<div><strong><a href="https://github.com/FelekDevYT/ChestIndexer">ChestIndexer</a></strong>&nbsp;<code>plugin</code></div>
Expand All @@ -52,7 +62,8 @@ Core plugins provide deeper integration with RusherHack by modifying Minecraft
&nbsp;<img alt="downloads" src="https://img.shields.io/github/downloads/FelekDevYT/ChestIndexer/total?style=flat">
&nbsp;<img alt="added" src="https://img.shields.io/date/1774656000?label=added&style=flat">
</div>
</td>
</td></tr>
<tr>
<td align="left" valign="top" width="50%">
<a href="https://github.com/FelekDevYT/phoenix"><img src="https://avatars.githubusercontent.com/FelekDevYT?s=400" alt="Phoenix" width="100" height="100" style="border-radius:12px;"></a>
<div><strong><a href="https://github.com/FelekDevYT/phoenix">Phoenix</a></strong>&nbsp;<code>plugin</code></div>
Expand All @@ -62,8 +73,7 @@ Core plugins provide deeper integration with RusherHack by modifying Minecraft
&nbsp;<img alt="downloads" src="https://img.shields.io/github/downloads/FelekDevYT/phoenix/total?style=flat">
&nbsp;<img alt="added" src="https://img.shields.io/date/1774310400?label=added&style=flat">
</div>
</td></tr>
<tr>
</td>
<td align="left" valign="top" width="50%">
<a href="https://github.com/FelekDevYT/RusherClicker"><img src="https://avatars.githubusercontent.com/FelekDevYT?s=400" alt="RusherClicker" width="100" height="100" style="border-radius:12px;"></a>
<div><strong><a href="https://github.com/FelekDevYT/RusherClicker">RusherClicker</a></strong>&nbsp;<code>plugin</code></div>
Expand All @@ -73,7 +83,8 @@ Core plugins provide deeper integration with RusherHack by modifying Minecraft
&nbsp;<img alt="downloads" src="https://img.shields.io/github/downloads/FelekDevYT/RusherClicker/total?style=flat">
&nbsp;<img alt="added" src="https://img.shields.io/date/1773100800?label=added&style=flat">
</div>
</td>
</td></tr>
<tr>
<td align="left" valign="top" width="50%">
<a href="https://github.com/KybesRusherhackPlugins/packets_in_out"><img src="https://avatars.githubusercontent.com/KybesRusherhackPlugins?s=400" alt="packets_in_out" width="100" height="100" style="border-radius:12px;"></a>
<div><strong><a href="https://github.com/KybesRusherhackPlugins/packets_in_out">packets_in_out</a></strong>&nbsp;<code>plugin</code></div>
Expand All @@ -83,8 +94,7 @@ Core plugins provide deeper integration with RusherHack by modifying Minecraft
&nbsp;<img alt="downloads" src="https://img.shields.io/github/downloads/KybesRusherhackPlugins/packets_in_out/total?style=flat">
&nbsp;<img alt="added" src="https://img.shields.io/date/1773100800?label=added&style=flat">
</div>
</td></tr>
<tr>
</td>
<td align="left" valign="top" width="50%">
<a href="https://github.com/KybesRusherhackPlugins/hotbar_randomizer"><img src="https://avatars.githubusercontent.com/KybesRusherhackPlugins?s=400" alt="hotbar_randomizer" width="100" height="100" style="border-radius:12px;"></a>
<div><strong><a href="https://github.com/KybesRusherhackPlugins/hotbar_randomizer">hotbar_randomizer</a></strong>&nbsp;<code>plugin</code></div>
Expand All @@ -94,16 +104,6 @@ Core plugins provide deeper integration with RusherHack by modifying Minecraft
&nbsp;<img alt="downloads" src="https://img.shields.io/github/downloads/KybesRusherhackPlugins/hotbar_randomizer/total?style=flat">
&nbsp;<img alt="added" src="https://img.shields.io/date/1773100800?label=added&style=flat">
</div>
</td>
<td align="left" valign="top" width="50%">
<a href="https://github.com/hx-4/RusherSearchTweaks"><img src="https://avatars.githubusercontent.com/hx-4?s=400" alt="RusherSearchTweaks" width="100" height="100" style="border-radius:12px;"></a>
<div><strong><a href="https://github.com/hx-4/RusherSearchTweaks">RusherSearchTweaks</a></strong>&nbsp;<code>plugin</code></div>
<div style="margin:4px 0 6px 0;">Adds group toggles to the Search module for quickly enabling or disabling categories.</div>
<div>
<img alt="stars" src="https://img.shields.io/github/stars/hx-4/RusherSearchTweaks?style=flat">
&nbsp;<img alt="downloads" src="https://img.shields.io/github/downloads/hx-4/RusherSearchTweaks/total?style=flat">
&nbsp;<img alt="added" src="https://img.shields.io/date/1773100800?label=added&style=flat">
</div>
</td></tr>
</table>
<!--- Recently Added Plugins End -->
Expand Down Expand Up @@ -136,6 +136,22 @@ Core plugins provide deeper integration with RusherHack by modifying Minecraft

---

- ### [CustomCapes](https://github.com/FelekDevYT/CustomCapes) <br>
[![Latest Release Date](https://img.shields.io/github/release-date/FelekDevYT/CustomCapes?label=Latest%20Release&color=green)](https://github.com/FelekDevYT/CustomCapes/releases) [![GitHub Downloads](https://img.shields.io/github/downloads/FelekDevYT/CustomCapes/total)](https://github.com/FelekDevYT/CustomCapes/releases/download/latest/customcapes-1.0.0.jar)<br>
![MC Version](https://img.shields.io/badge/MC%20Version-1%2021%204-blueviolet)<br>
![Core Plugin](https://img.shields.io/badge/Core%20Plugin-blue)<br>
**Creator**: <img src="https://github.com/FelekDevYT.png?size=20" width="20" height="20"> [FelekDevYT](https://github.com/FelekDevYT)<br>
A high-performance, client-side cosmetic extension for RusherHack that allows using any custom cape textures with automatic elytra synchronization.

<details>
<summary>Show Screenshots</summary>
<p align="center">
<img src="./Assets/CustomCapes/settings.png" alt="Settings" width="174">
</p>
</details>

---

- ### [2b2t.vc Rusherhack](https://github.com/rfresh2/2b2t.vc-rusherhack) <br>
[![Latest Release Date](https://img.shields.io/github/release-date/rfresh2/2b2t.vc-rusherhack?label=Latest%20Release&color=green)](https://github.com/rfresh2/2b2t.vc-rusherhack/releases) [![GitHub Downloads](https://img.shields.io/github/downloads/rfresh2/2b2t.vc-rusherhack/total)](https://github.com/rfresh2/2b2t.vc-rusherhack/releases/download/1.12/2b2t.vc-rusherhack-1.12.jar)<br>
![MC Version](https://img.shields.io/badge/MC%20Version-1%2020%201--1%2021%204-blueviolet)<br>
Expand Down
Loading
Loading