Skip to content

Repository files navigation

Simply Swords addon developer documentation

These documents explain how an addon can build weapons that behave like Simply Swords' built-in unique weapons. They target Minecraft 1.21.1 and Java 21.

Start here:

  1. Set up the dependency.
  2. Follow the complete unique weapon walkthrough.
  3. Use the API reference when adding more advanced behavior.
  4. Finish with the testing checklist.

What counts as a supported extension point?

The primary API lives in:

  • net.sweenus.simplyswords.api
  • net.sweenus.simplyswords.client.api

The following classes are also intended for addon use:

  • UniqueSwordItem
  • UniqueWeaponActiveAbility
  • GemPower, RunicGemPower, RunefusedGemPower, and NetherGemPower
  • GemPowerRegistry

Classes under world, mixin, and most of util are implementation details. The reference occasionally mentions a utility when it is the only practical way to match built-in behavior. Treat those utilities as less stable than the API package.

API registration rule

Register addon items normally, then register their Simply Swords integrations during common initialization. Client model properties and other rendering hooks belong in the addon's client initializer.

Simply Swords must be a required dependency so its registries and components exist before addon content is used.

Documents

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

Sponsor this project

Packages

Contributors

Languages