Introduction
With the 2.0.0 release of Iron’s Spells ‘n Spellbooks you can now register your own spells and schools! There is also an API to compile against. If you are interested in developing using us as a dependency, you can help shape the roadmap by joining our discord and asking questions or providing feedback/suggestions.
Dependency Setup
In order to build against Spells ‘n Spellbooks, you need to configure your build.gradle file. You will need as least one of the following mavens under repositories. If you are not interested in building with snapshots, you only need the release maven.
1
2
3
4
5
6
7
8
maven {
name = "Iron's Maven - Release"
url = "https://code.redspace.io/releases"
}
maven {
name = "Iron's Maven - Snapshots"
url = "https://code.redspace.io/snapshots"
}
In order to include the api in your project, add the following under dependencies:
Forge (1.20.1 and below)
1
2
compileOnly fg.deobf("io.redspace.ironsspellbooks:irons_spellbooks:${irons_spells_version}:api")
runtimeOnly fg.deobf("io.redspace.ironsspellbooks:irons_spellbooks:${irons_spells_version}")
NeoForge (1.21+)
1
2
compileOnly "io.redspace:irons_spellbooks:${irons_spells_version}:api"
localRuntime "io.redspace:irons_spellbooks:${irons_spells_version}"
API vs Full Mod Dependency
Alternatively, you can use the entire mod as a dependency. What is the significance of this? The contents of io.redspace.ironsspellbooks.api are stable, though they may have limited functionality. If you use packages outside of this, you’ll have access to all the same tools that we do, but you might encounter breaking changes in future releases. If you’d like to expand the API, feel free to submit a pull request to our main repository at https://github.com/iron431/Irons-Spells-n-Spellbooks. To use the full mod dependency, replace the previously mentioned dependencies with the following in your build.gradle file (omit the api tag):
Forge
1
implementation fg.deobf("io.redspace.ironsspellbooks:irons_spellbooks:${irons_spells_version}")
NeoForge
1
implementation "io.redspace:irons_spellbooks:${irons_spells_version}"
Spell Registration
To register spells you will need to create your own registry using a DeferredRegister
1
2
3
4
5
6
7
8
9
10
11
12
13
public class ExampleSpellRegistry {
public static final DeferredRegister<AbstractSpell> SPELLS = DeferredRegister.create(SpellRegistry.SPELL_REGISTRY_KEY, IronsExampleMod.MODID);
public static void register(IEventBus eventBus) {
SPELLS.register(eventBus);
}
public static RegistryObject<AbstractSpell> registerSpell(AbstractSpell spell) {
return SPELLS.register(spell.getSpellName(), () -> spell);
}
public static final RegistryObject<AbstractSpell> SUPER_HEAL_SPELL = registerSpell(new SuperHealSpell());
}
This registry works as any other deferred register does, see the NeoForge docs for more info.
Configuration
Spells are highly config-driven, including attributes such as the spell’s School, Cooldown, Max Level, and more.
In order have your spells configuration injected into the server config file for Iron’s Spells n Spellbooks just add the @AutoSpellConfig annotation to the class for your spell.
The default values for the configuration are set by overriding the getDefaultConfig() method, where you return the default values for all your config settings.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
import io.redspace.ironsspellbooks.api.spells.*;
@AutoSpellConfig
public class YourNewSpell extends AbstractSpell {
/** Declare the default state of your config here */
private final DefaultConfig defaultConfig = new DefaultConfig()
.setMinRarity(SpellRarity.RARE)
.setSchoolResource(SchoolRegistry.HOLY_RESOURCE)
.setMaxLevel(10)
.setCooldownSeconds(20)
.build();
/** Return your config here */
@Override
public DefaultConfig getDefaultConfig() {
return defaultConfig;
}
//...
}
Other Links
You can now create spells the same way we do in the core mod. For examples of spells you can look at any of the spells here.