Standardize Module usage + add child modules #8346

sovdeeth · 2026-01-04T04:28:49Z

Problem

Skript contains a lot of modules now, some properly using the registry api, some not, and all in a very flat structure.
It would be better to have all the bukkit modules under a single bukkit module parent, and it would be nice to standardize how modules are made in Skript.

Solution

Refactors all existing modules to fit the same standard for addon modules, creating a required name() method for creating origins, using origins properly, and creating ChildAddonModules. These act nearly identically to AddonModules, but contain a reference to a parent module for use during loading or creating origins.

Module origins can now have multiple providing modules, with the most specific first. Child modules will automatically handle this, providing origins that may have a list of modules like [interactions, entities, bukkit].

Testing Completed

No new tests, just existing ones.

Supporting Information

Completes: none
Related: none
AI assistance: none

UnderscoreTud · 2026-01-04T05:05:42Z

src/main/java/org/skriptlang/skript/bukkit/brewing/elements/ExprBrewingTime.java

 	private static final boolean BREWING_START_EVENT_1_21 = Skript.methodExists(BrewingStartEvent.class, "setBrewingTime", int.class);

-	public static void register(SyntaxRegistry registry) {
+	public static void register(SyntaxRegistry registry, AddonModule.ModuleOrigin origin) {


Suggested change

public static void register(SyntaxRegistry registry, AddonModule.ModuleOrigin origin) {

public static void register(SyntaxRegistry registry, ModuleOrigin origin) {

UnderscoreTud · 2026-01-04T05:06:26Z

...main/java/org/skriptlang/skript/bukkit/damagesource/elements/conditions/CondWasIndirect.java

-		Skript.registerCondition(CondWasIndirect.class, ConditionType.PROPERTY,
-			"%damagesources% (was|were) ([:in]directly caused|caused [:in]directly)",
-			"%damagesources% (was not|wasn't|were not|weren't) ([:in]directly caused|caused [:in]directly)"
+	public static void register(SyntaxRegistry registry, AddonModule.ModuleOrigin origin) {


Suggested change

public static void register(SyntaxRegistry registry, AddonModule.ModuleOrigin origin) {

public static void register(SyntaxRegistry registry, ModuleOrigin origin) {

UnderscoreTud · 2026-01-04T05:06:47Z

.../org/skriptlang/skript/bukkit/damagesource/elements/expressions/ExprCreatedDamageSource.java

+	public static void register(SyntaxRegistry registry, ModuleOrigin origin) {
+		registry.register(
+			SyntaxRegistry.EXPRESSION,
+			infoBuilder(ExprCreatedDamageSource.class, DamageSource.class,"created damage source")


Suggested change

infoBuilder(ExprCreatedDamageSource.class, DamageSource.class,"created damage source")

infoBuilder(ExprCreatedDamageSource.class, DamageSource.class, "created damage source")

UnderscoreTud · 2026-01-04T05:07:34Z

...main/java/org/skriptlang/skript/bukkit/damagesource/elements/expressions/ExprDamageType.java

+	public static void register(SyntaxRegistry registry, ModuleOrigin origin) {
+		registry.register(
+			SyntaxRegistry.EXPRESSION,
+			infoBuilder(ExprDamageType.class, DamageType.class,"damage type", "damagesources", true)


Suggested change

infoBuilder(ExprDamageType.class, DamageType.class,"damage type", "damagesources", true)

infoBuilder(ExprDamageType.class, DamageType.class, "damage type", "damagesources", true)

UnderscoreTud · 2026-01-04T05:07:51Z

...in/java/org/skriptlang/skript/bukkit/damagesource/elements/expressions/ExprDirectEntity.java

+	public static void register(SyntaxRegistry registry, AddonModule.ModuleOrigin origin) {
+		registry.register(
+			SyntaxRegistry.EXPRESSION,
+			infoBuilder(ExprDirectEntity.class, Entity.class,"direct entity", "damagesources", true)


Suggested change

infoBuilder(ExprDirectEntity.class, Entity.class,"direct entity", "damagesources", true)

infoBuilder(ExprDirectEntity.class, Entity.class, "direct entity", "damagesources", true)

UnderscoreTud · 2026-01-04T05:08:04Z

.../java/org/skriptlang/skript/bukkit/damagesource/elements/expressions/ExprFoodExhaustion.java

+	public static void register(SyntaxRegistry registry, ModuleOrigin origin) {
+		registry.register(
+			SyntaxRegistry.EXPRESSION,
+			infoBuilder(ExprFoodExhaustion.class, Float.class,"food exhaustion", "damagesources", true)


Suggested change

infoBuilder(ExprFoodExhaustion.class, Float.class,"food exhaustion", "damagesources", true)

infoBuilder(ExprFoodExhaustion.class, Float.class, "food exhaustion", "damagesources", true)

UnderscoreTud · 2026-01-04T05:08:17Z

...in/java/org/skriptlang/skript/bukkit/damagesource/elements/expressions/ExprDirectEntity.java


-	static {
-		registerDefault(ExprDirectEntity.class, Entity.class, "direct entity", "damagesources");
+	public static void register(SyntaxRegistry registry, AddonModule.ModuleOrigin origin) {


Suggested change

public static void register(SyntaxRegistry registry, AddonModule.ModuleOrigin origin) {

public static void register(SyntaxRegistry registry, ModuleOrigin origin) {

UnderscoreTud · 2026-01-04T05:08:46Z

.../java/org/skriptlang/skript/bukkit/damagesource/elements/expressions/ExprSourceLocation.java

+	public static void register(SyntaxRegistry registry, ModuleOrigin origin) {
+		registry.register(
+			SyntaxRegistry.EXPRESSION,
+			infoBuilder(ExprSourceLocation.class, Location.class,"source location", "damagesources", true)


Suggested change

infoBuilder(ExprSourceLocation.class, Location.class,"source location", "damagesources", true)

infoBuilder(ExprSourceLocation.class, Location.class, "source location", "damagesources", true)

UnderscoreTud · 2026-01-04T05:11:41Z

src/main/java/org/skriptlang/skript/bukkit/fishing/elements/conditions/CondFishingLure.java

-		Skript.registerCondition(CondFishingLure.class,
-			"lure enchantment bonus is (applied|active)",
-			"lure enchantment bonus is(n't| not) (applied|active)");
+	public static void register(SyntaxRegistry registry, Origin origin) {


Shouldn't these take in ModuleOrigin?

no the others should be taking in Origin

APickledWalrus

Looks pretty good overall, just what I found from a Quick Look

APickledWalrus · 2026-01-05T20:46:58Z

src/main/java/org/skriptlang/skript/addon/AddonModule.java

-		 * @return The name of the module represented by this origin.
+		 * @return The names of the modules represented by this origin.
 		 */
-		String moduleName();


A deprecated version of this method should be retained. It can just join moduleNames with a space or something.

APickledWalrus · 2026-01-05T20:47:48Z

src/main/java/org/skriptlang/skript/addon/AddonModule.java

+	 * @param consumers The consumers that will register syntax to the registry.
+	 */
+	@SafeVarargs
+	static void register(SyntaxRegistry registry, ModuleOrigin origin, BiConsumer<SyntaxRegistry, ModuleOrigin>... consumers) {


I think we are fine to just allow Origin here

APickledWalrus · 2026-01-05T20:48:23Z

src/main/java/org/skriptlang/skript/addon/ChildAddonModule.java

+	@Override
+	public ModuleOrigin origin(SkriptAddon addon) {
+		return ChildAddonModule.origin(addon, parentModule, name());
+	}


Suggested change

}

}

APickledWalrus · 2026-01-05T20:51:37Z

src/main/java/org/skriptlang/skript/addon/ChildAddonModule.java

+		 * @param moduleName The name of the providing module.
+		 */
+		public ChildModuleOriginImpl(SkriptAddon addon, AddonModule parentModule, String moduleName) {
+			this.addon = addon;


This should be an unmodifiable view. I need to fix this for the regular ModuleOrigin too.

APickledWalrus · 2026-01-05T20:53:49Z

...n/java/org/skriptlang/skript/bukkit/damagesource/elements/expressions/ExprCausingEntity.java

+	public static void register(SyntaxRegistry registry, ModuleOrigin origin) {
+		registry.register(
+			SyntaxRegistry.EXPRESSION,
+			infoBuilder(ExprCausingEntity.class, Entity.class,"(causing|responsible) entity", "damagesources", true)


Suggested change

infoBuilder(ExprCausingEntity.class, Entity.class,"(causing|responsible) entity", "damagesources", true)

infoBuilder(ExprCausingEntity.class, Entity.class, "(causing|responsible) entity", "damagesources", true)

APickledWalrus · 2026-01-05T21:00:28Z

...main/java/org/skriptlang/skript/bukkit/fishing/elements/expressions/ExprFishingBiteTime.java

-				"fish[ing] bit(e|ing) [wait] time");
+	public static void register(SyntaxRegistry registry, Origin origin) {
+		registry.register(SyntaxRegistry.EXPRESSION,
+			DefaultSyntaxInfos.Expression.builder(ExprFishingBiteTime.class, Timespan.class)


Suggested change

DefaultSyntaxInfos.Expression.builder(ExprFishingBiteTime.class, Timespan.class)

SyntaxInfo.Expression.builder(ExprFishingBiteTime.class, Timespan.class)

And same with priority here too

APickledWalrus · 2026-01-05T21:01:03Z

...in/java/org/skriptlang/skript/bukkit/fishing/elements/expressions/ExprFishingHookEntity.java

-			"hook[ed] entity");
+	public static void register(SyntaxRegistry registry, Origin origin) {
+		registry.register(SyntaxRegistry.EXPRESSION,
+			DefaultSyntaxInfos.Expression.builder(ExprFishingHookEntity.class, Entity.class)


Suggested change

DefaultSyntaxInfos.Expression.builder(ExprFishingHookEntity.class, Entity.class)

SyntaxInfo.Expression.builder(ExprFishingHookEntity.class, Entity.class)

And same with priority here too

APickledWalrus · 2026-01-05T21:01:19Z

...main/java/org/skriptlang/skript/bukkit/fishing/elements/expressions/ExprFishingWaitTime.java

-			"(min:min[imum]|max[imum]) fish[ing] wait[ing] time");
+	public static void register(SyntaxRegistry registry, Origin origin) {
+		registry.register(SyntaxRegistry.EXPRESSION,
+			DefaultSyntaxInfos.Expression.builder(ExprFishingWaitTime.class, Timespan.class)


Suggested change

DefaultSyntaxInfos.Expression.builder(ExprFishingWaitTime.class, Timespan.class)

SyntaxInfo.Expression.builder(ExprFishingWaitTime.class, Timespan.class)

And same with priority here too

APickledWalrus · 2026-01-05T21:01:47Z

...java/org/skriptlang/skript/bukkit/damagesource/elements/expressions/ExprSecDamageSource.java

+	public static void register(SyntaxRegistry registry, ModuleOrigin origin) {
+		registry.register(
+			SyntaxRegistry.EXPRESSION,
+			DefaultSyntaxInfos.Expression.builder(ExprSecDamageSource.class, DamageSource.class)


Suggested change

DefaultSyntaxInfos.Expression.builder(ExprSecDamageSource.class, DamageSource.class)

SyntaxInfo.Expression.builder(ExprSecDamageSource.class, DamageSource.class)

APickledWalrus · 2026-01-05T21:06:46Z

src/main/java/org/skriptlang/skript/addon/AddonModule.java

+	/**
+	 * @return A name representing this module to be using in the {@link ModuleOrigin}. e.g. "discord", "nbt", "particles"...
+	 */
+	String name();


We'll ideally want to avoid a breaking change here. Maybe we can provide a default implementation for now that returns the addon name or something? Not sure how feasible it would be, but we could also log a warning that the addon needs to implement it.

sovdeeth added 4 commits December 23, 2025 11:10

child module support

88c3679

Create child modules and move over existing Bukkit addon modules.

edd20a1

Merge branch 'dev/feature' into feature/modularization

d8f8e78

Update newer modules

0d33e7c

sovdeeth added the enhancement Feature request, an issue about something that could be improved, or a PR improving something. label Jan 4, 2026

sovdeeth requested review from a team and APickledWalrus as code owners January 4, 2026 04:28

sovdeeth requested review from Efnilite and removed request for a team January 4, 2026 04:28

sovdeeth added this to 2.15 Releases Jan 4, 2026

skriptlang-automation bot added the needs reviews A PR that needs additional reviews label Jan 4, 2026

sovdeeth moved this to In Progress in 2.15 Releases Jan 4, 2026

UnderscoreTud requested changes Jan 4, 2026

View reviewed changes

github-project-automation bot moved this from In Progress to In Review in 2.15 Releases Jan 4, 2026

APickledWalrus requested changes Jan 5, 2026

View reviewed changes

skriptlang-automation bot removed the needs reviews A PR that needs additional reviews label Jan 5, 2026

sovdeeth marked this pull request as draft January 6, 2026 00:35

	public static void register(SyntaxRegistry registry, AddonModule.ModuleOrigin origin) {
	public static void register(SyntaxRegistry registry, ModuleOrigin origin) {

	infoBuilder(ExprCreatedDamageSource.class, DamageSource.class,"created damage source")
	infoBuilder(ExprCreatedDamageSource.class, DamageSource.class, "created damage source")

	infoBuilder(ExprDamageType.class, DamageType.class,"damage type", "damagesources", true)
	infoBuilder(ExprDamageType.class, DamageType.class, "damage type", "damagesources", true)

	infoBuilder(ExprDirectEntity.class, Entity.class,"direct entity", "damagesources", true)
	infoBuilder(ExprDirectEntity.class, Entity.class, "direct entity", "damagesources", true)

	infoBuilder(ExprFoodExhaustion.class, Float.class,"food exhaustion", "damagesources", true)
	infoBuilder(ExprFoodExhaustion.class, Float.class, "food exhaustion", "damagesources", true)

	infoBuilder(ExprSourceLocation.class, Location.class,"source location", "damagesources", true)
	infoBuilder(ExprSourceLocation.class, Location.class, "source location", "damagesources", true)

	infoBuilder(ExprCausingEntity.class, Entity.class,"(causing\|responsible) entity", "damagesources", true)
	infoBuilder(ExprCausingEntity.class, Entity.class, "(causing\|responsible) entity", "damagesources", true)

	DefaultSyntaxInfos.Expression.builder(ExprFishingBiteTime.class, Timespan.class)
	SyntaxInfo.Expression.builder(ExprFishingBiteTime.class, Timespan.class)

	DefaultSyntaxInfos.Expression.builder(ExprSecDamageSource.class, DamageSource.class)
	SyntaxInfo.Expression.builder(ExprSecDamageSource.class, DamageSource.class)

Uh oh!

Standardize Module usage + add child modules #8346

Are you sure you want to change the base?

Standardize Module usage + add child modules #8346

Conversation

sovdeeth commented Jan 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem

Solution

Testing Completed

Supporting Information

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

APickledWalrus left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

sovdeeth commented Jan 4, 2026 •

edited

Loading