https://github.com/StellarWind22/Shield-Lib

Library for easily adding new shields, shield enchantments, and enabling you to enchant shields in general without worry of conflictions.
https://github.com/StellarWind22/Shield-Lib

architectury architectury-api architectury-mod enchantments fabric fabric-api fabric-mod fabricmc fabricmc-mod library minecraft minecraftmod neoforge neoforge-api neoforge-mod shields

Last synced: 4 months ago
JSON representation

Library for easily adding new shields, shield enchantments, and enabling you to enchant shields in general without worry of conflictions.

• Host: GitHub
• URL: https://github.com/StellarWind22/Shield-Lib
• Owner: StellarWind22
• License: lgpl-2.1
• Created: 2020-05-03T06:50:54.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2025-11-20T18:57:19.000Z (6 months ago)
• Last Synced: 2025-11-20T20:25:37.390Z (6 months ago)
• Topics: architectury, architectury-api, architectury-mod, enchantments, fabric, fabric-api, fabric-mod, fabricmc, fabricmc-mod, library, minecraft, minecraftmod, neoforge, neoforge-api, neoforge-mod, shields
• Language: Java
• Homepage: https://modrinth.com/mod/shieldlib
• Size: 4.95 MB
• Stars: 45
• Watchers: 5
• Forks: 19
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-fabric - Shield Lib - Library mod for easily adding shields, and shield enchantments into the game. ([Wiki](https://fabricmc.net/wiki/tutorial:shield)) `LGPL-2.1` (Uncategorized / Uncategorized)

README

          
![Shield Lib Banner](docs/image/banner_128.png)

---

### Shield Lib is a library that makes it easy to add custom shields with banner support, enchantments, custom shapes, & custom effects across Fabric & Neoforge without conflicts!

### We also provide event hooks & modifier registries for shields and shield enchantments for creating custom effects with them by modifying blocking, disabling, movement, or cooldown.

## Enchanting:

![Vanilla shield being enchanted](docs/image/showcase_enchanting.png)

## Custom Shapes:

![Custom square shaped shield model in Blockbench, then in-game with globe banner pattern on it](docs/image/showcase_shape.png)

## Tooltips:

![Vanilla shield with a new tooltip saying that when it's hit by an axe it will have 5 seconds of cooldown](docs/image/showcase_tooltip.png)

### Pages:

- [Github](https://github.com/StellarWind22/Shield-Lib)

- [Modrinth](https://modrinth.com/mod/shieldlib)

- [CurseForge](https://www.curseforge.com/minecraft/mc-mods/shield-lib)

---

## Importing

put this in `gradle.properties`

```properties

shieldlib_version=2.0.0-1.21.8

```

`build.gradle` in repositories just above dependencies

```gradle

maven {url = "https://api.modrinth.com/maven"}

```

`build.gradle` in dependencies

```gradle

dependencies {

	//Other stuff here

        

    //Shield Lib(replace [LOADER] with fabric OR neoforge)

	modImplementation "maven.modrinth:shieldlib:${project.shieldlib_version}-[LOADER]"

}

```

---

## Documentation?

[![Architectury](docs/image/architectury_64.png)](docs/page/architectury/getting_started.md) [![Fabric](docs/image/fabric_64.png)](docs/page/fabric/getting_started.md) [![Neoforge](docs/image/neoforge_64.png)](docs/page/neoforge/getting_started.md)

### The [example mod repo](https://github.com/CrimsonDawn45/Fabric-Shield-Lib-Example-Mod) is a template repo you can use to quickly get started if your making a new mod. Although it isn't updated as frequently.