chore(README): include content

This commit is contained in:
Erica Marigold 2024-05-26 21:01:20 +05:30 committed by GitHub
parent c7adac472f
commit 3ac69631db
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -0,0 +1,29 @@
<img align="right" height="250" width="250" src="src/main/resources/assets/elytra-lock/icon.png" />
# elytra-lock
<div>
<a href="https://modrinth.com/mod/touch-grass-reminder">
<img alt="modrinth" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/modrinth_vector.svg" />
</a>
<a href="https://quiltmc.org">
<img alt="quilt" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/quilt_vector.svg" />
</a>
<a href="https://fabricmc.net">
<img alt="quilt" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/fabric_vector.svg" />
</a>
</div>
<br />
A client-side fabric (quilt-compatible) mod which allows you to lock elytra functionality.
It registers a keybind (by default, `J`) which can be used to toggle the lock.
## Usage
When locked, it is impossible to fly or equip the elytra with right-click - it is possible to
equip to it manually, by shift-clicking or dragging it onto the chestplate slot. If the
elytra is locked when it is already equipped or equipped manually, flight is disabled.