readme updated
Some checks failed
build / build (push) Failing after 2s

This commit is contained in:
2025-12-22 23:27:30 -06:00
parent 675787729d
commit 6e685f8cdf

View File

@@ -1,63 +1,63 @@
# More Spear Enchantments
<img alt="fabric" height="42" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3.2.0/assets/compact/supported/fabric_vector.svg">
A Minecraft mod that adds powerful custom enchantments specifically designed for spears (tridents).
This mod adds enchantments that work only with the new spears.
## Features
More Spear Enchantments adds **three new spear-only enchantments** (for now), you can get these enchantments either through enchanting table or with a enchanted book and anvil.
This mod introduces two new enchantments that can only be applied to spears:
<details>
<summary><b>⚡ Thundering</b></summary>
### ⚡ Thundering (Levels I-III)
Strikes lightning at your target when you hit them with your spear.
- **Level I**: 40% chance to strike lightning
- **Level II**: 60% chance to strike lightning
- **Level III**: 80% chance to strike lightning
Call down the power of storms! When you strike an enemy with an enchanted spear, lightning bolts strike at their location.
### 💀 Withering (Levels I-III)
Inflicts the Wither effect on targets hit by your spear.
- **Level I**: Applies Wither 0 for 2 seconds
- **Level II**: Applies Wither I for 3 seconds
- **Level III**: Applies Wither II for 4 seconds
- **Max Level**: III
- **Effect**: Strikes lightning on hit targets
- **Scaling**: Higher levels increase the chance of lightning strikes (40% → 60% → 80%)
- **Works in**: All dimensions
## Installation
</details>
1. Download and install [Fabric Loader](https://fabricmc.net/use/)
2. Download and install [Fabric API](https://modrinth.com/mod/fabric-api)
3. Download this mod and place it in your `mods` folder
4. Launch Minecraft and enjoy!
<details>
<summary><b>💀 Withering</b></summary>
## Requirements
- **Max Level**: III
- **Effect**: Applies Wither status effect to hit targets
- **Scaling**: Higher levels increase both duration and potency
- Level I: Wither II for 2 seconds
- Level II: Wither III for 3 seconds
- Level III: Wither IV for 4 seconds
- **Minecraft**: 1.21.11
- **Fabric Loader**: 0.18.3+
- **Fabric API**: 0.140.2+1.21.11
</details>
## Usage
<details>
<summary><b>🧪 Poisoning</b></summary>
These enchantments can be obtained through:
- Enchanting tables
- Anvil combining
- Villager trading (if applicable)
- Creative mode enchanted book menu
- **Max Level**: III
- **Effect**: Applies Poison status effect to hit targets
- **Scaling**: Higher levels increase both duration and potency
- Level I: Poison II for 2 seconds
- Level II: Poison III for 3 seconds
- Level III: Poison IV for 4 seconds
The enchantments will only appear as options when enchanting tridents or other spear-type weapons.
</details>
## Compatibility
## How to Use
This mod is designed to work alongside other Fabric mods. The enchantments use the POST_ATTACK trigger, so they should be compatible with most combat-related mods.
1. Obtain a spear
2. Enchant it using an enchanting table, anvil, or enchanted books
These custom enchantments only work on spears.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Licensed under the MIT License. See the project repository for full license text.
## Support
## Links
If you encounter any issues or have suggestions:
- Report issues on the [issue tracker](https://git.sillyangel.dev/angel/more_spear_enchants/issues)
- Visit the project page at [sillyangel.dev](https://sillyangel.dev/)
- **Source Code**: [Gitea Repository](https://git.sillyangel.dev/angel/more_spear_enchants)
- **Author**: [sillyangel](https://sillyangel.dev/)
- **Issues**: Report bugs or request features on the [issue tracker](https://git.sillyangel.dev/angel/more_spear_enchants/issues)
## Credits
Created by [sillyangel](https://sillyangel.dev/)
Built with [Fabric](https://fabricmc.net/)
---
*made by sillyangel*