Developer Resources

This page is the reference map for SoulFire plugin authors. If you already know what you are looking for, start here.

Official links

Resource	Link
SoulFire source repository	github.com/AlexProgrammerDE/SoulFire
Official plugin template	github.com/AlexProgrammerDE/SoulFirePluginExample
Aggregated Javadocs	ci.codemc.io/.../SoulFire/javadoc
Maven public repo	repo.codemc.org/repository/maven-public
`mod` metadata	maven-metadata.xml
`shared` metadata	maven-metadata.xml

Current package entry points in the Javadocs

These package summaries are the most useful places to start:

Artifact coordinates

Use these coordinates for most plugin projects:

groupId:    com.soulfiremc
artifactId: mod
artifactId: shared
repository: https://repo.codemc.org/repository/maven-public/

The public metadata currently reports:

latest release for mod: 2.7.0
latest snapshot for mod: 2.7.1-SNAPSHOT

Check the metadata again before pinning a version, because the template repository can lag behind current releases.

Source tree map

Location	What you learn there
`mod/src/main/java/com/soulfiremc/server/api`	plugin base classes, events, metadata helpers
`mod/src/main/java/com/soulfiremc/server/bot`	`BotConnection`, `ControlState`, `ControllingTask`
`mod/src/main/java/com/soulfiremc/server/settings`	property model and settings infrastructure
`mod/src/main/java/com/soulfiremc/server/grpc`	how client actions become runtime behavior
`proto/src/main/proto/soulfire`	server, instance, bot, command, and scripting contracts
`mod/src/main/java/com/soulfiremc/server/plugins`	built-in plugin implementations

Built-in plugins to study first

If you only read a few internal plugins, read these:

Plugin	Why it is useful
AntiAFK	small, clean example of event hooks plus settings page registration
AutoArmor	staged inventory control
AutoEat	action sequencing and fallback behavior
CaptchaSolver	richer settings, multiple property types, and more complex behavior
KillAura	metadata, control ownership, and manual task markers
DialogHandler	bridging Minecraft dialog state into the API layer

Template caveat

The official example template is the best starting point for project layout and first plugin scaffolding. It is not always the final word on low-level current internals.

Cross-check these three sources before shipping:

the current template repository
the current SoulFire Javadocs
the current built-in plugin and mixin sources

If an old template example and the current Javadocs disagree, trust the current Javadocs and current SoulFire source tree.