MCPcopy Index your code
hub / github.com/StellarWind22/Shield-Lib

github.com/StellarWind22/Shield-Lib @v2.0.1+1.21.8

Chat with this repo
repository ↗ · DeepWiki ↗ · release v2.0.1+1.21.8 ↗ · + Follow
252 symbols 526 edges 46 files 7 documented · 3%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Shield Lib Banner


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

Custom Shapes:

Custom square shaped shield model in Blockbench, then in-game with globe banner pattern on it

Tooltips:

Vanilla shield with a new tooltip saying that when it's hit by an axe it will have 5 seconds of cooldown

Pages:


Importing

put this in gradle.properties

shieldlib_version=2.0.0-1.21.8

build.gradle in repositories just above dependencies

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

build.gradle in dependencies

dependencies {
    //Other stuff here

    //Shield Lib(replace [LOADER] with fabric OR neoforge)
    modImplementation "maven.modrinth:shieldlib:${project.shieldlib_version}-[LOADER]"
}

Documentation?

Architectury Fabric Neoforge

The example mod repo is a template repo you can use to quickly get started if your making a new mod. Although it isn't updated as frequently.

Extension points exported contracts — how you extend this code

ShieldModel (Interface)
(no doc) [16 implementers]
common/src/main/java/com/github/stellarwind22/shieldlib/lib/client/model/ShieldModel.java
ShieldModelRenderer (Interface)
(no doc) [8 implementers]
common/src/main/java/com/github/stellarwind22/shieldlib/lib/client/render/ShieldModelRenderer.java
ShieldClientEvents (Interface)
(no doc)
common/src/main/java/com/github/stellarwind22/shieldlib/lib/client/event/ShieldClientEvents.java
ShieldMovementModifier (Interface)
(no doc)
common/src/main/java/com/github/stellarwind22/shieldlib/lib/registry/ShieldMovementModifier.java
ShieldCooldownModifier (Interface)
(no doc)
common/src/main/java/com/github/stellarwind22/shieldlib/lib/registry/ShieldCooldownModifier.java

Core symbols most depended-on inside this repo

of
called by 43
common/src/main/java/com/github/stellarwind22/shieldlib/lib/object/ShieldLibDamage.java
defaultShieldProperties
called by 19
common/src/main/java/com/github/stellarwind22/shieldlib/lib/object/ShieldLibUtils.java
withCooldownSeconds
called by 9
common/src/main/java/com/github/stellarwind22/shieldlib/lib/object/ShieldLibUtils.java
getRoot
called by 7
common/src/main/java/com/github/stellarwind22/shieldlib/lib/client/model/ShieldModel.java
type
called by 6
common/src/main/java/com/github/stellarwind22/shieldlib/lib/client/render/TowerShieldModelRenderer.java
hasFeature
called by 6
common/src/main/java/com/github/stellarwind22/shieldlib/lib/component/ShieldInformation.java
init
called by 4
common/src/main/java/com/github/stellarwind22/shieldlib/init/ShieldLib.java
isType
called by 4
common/src/main/java/com/github/stellarwind22/shieldlib/lib/component/ShieldInformation.java

Shape

Method 190
Class 47
Interface 15

Languages

Java100%

Modules by API surface

common/src/main/java/com/github/stellarwind22/shieldlib/lib/object/ShieldLibUtils.java20 symbols
common/src/main/java/com/github/stellarwind22/shieldlib/lib/event/ShieldEvents.java13 symbols
common/src/main/java/com/github/stellarwind22/shieldlib/lib/client/render/ShieldModelRenderer.java9 symbols
common/src/main/java/com/github/stellarwind22/shieldlib/init/ShieldLib.java9 symbols
common/src/main/java/com/github/stellarwind22/shieldlib/lib/client/render/TowerShieldModelRenderer.java8 symbols
common/src/main/java/com/github/stellarwind22/shieldlib/lib/client/render/TargeShieldModelRenderer.java8 symbols
common/src/main/java/com/github/stellarwind22/shieldlib/lib/client/render/SpikedTowerShieldModelRenderer.java8 symbols
common/src/main/java/com/github/stellarwind22/shieldlib/lib/client/render/SpikedTargeShieldModelRenderer.java8 symbols
common/src/main/java/com/github/stellarwind22/shieldlib/lib/client/render/SpikedHeaterShieldModelRenderer.java8 symbols
common/src/main/java/com/github/stellarwind22/shieldlib/lib/client/render/SpikedBucklerShieldModelRenderer.java8 symbols
common/src/main/java/com/github/stellarwind22/shieldlib/lib/client/render/HeaterShieldModelRenderer.java8 symbols
common/src/main/java/com/github/stellarwind22/shieldlib/lib/client/render/BucklerShieldModelRenderer.java8 symbols

For agents

$ claude mcp add Shield-Lib \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page