Skip to content

Standardize Module usage + add child modules#8346

Merged
sovdeeth merged 19 commits intoSkriptLang:dev/featurefrom
sovdeeth:feature/modularization
Mar 20, 2026
Merged

Standardize Module usage + add child modules#8346
sovdeeth merged 19 commits intoSkriptLang:dev/featurefrom
sovdeeth:feature/modularization

Conversation

@sovdeeth
Copy link
Copy Markdown
Member

@sovdeeth sovdeeth commented Jan 4, 2026 •
edited
Loading

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.

Adds a HierarchicalAddonModule abstract class for module to extend if they contain child modules or are child modules themselves. It provides automatic handling of canload/init/load for child modules and generates origins based on the module hierarchy. 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].

Moves some modules around to take advantage of the new hierarchical system.

Testing Completed

No new tests, just existing ones.

Supporting Information

Completes: none
Related: none
AI assistance: Claude code was used to help transfer old registration methods over to new ones.

@sovdeeth sovdeeth added the enhancement Feature request, an issue about something that could be improved, or a PR improving something. label Jan 4, 2026
@sovdeeth sovdeeth requested review from a team and APickledWalrus as code owners January 4, 2026 04:28
@sovdeeth sovdeeth requested review from Efnilite and removed request for a team January 4, 2026 04:28
@skriptlang-automation skriptlang-automation bot added the needs reviews A PR that needs additional reviews label Jan 4, 2026
@sovdeeth sovdeeth moved this to In Progress in 2.15 Releases Jan 4, 2026
UnderscoreTud
UnderscoreTud requested changes Jan 4, 2026
View reviewed changes
@github-project-automation github-project-automation bot moved this from In Progress to In Review in 2.15 Releases Jan 4, 2026
APickledWalrus
APickledWalrus requested changes Jan 5, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@APickledWalrus APickledWalrus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@skriptlang-automation skriptlang-automation bot removed the needs reviews A PR that needs additional reviews label Jan 5, 2026
@sovdeeth sovdeeth marked this pull request as draft January 6, 2026 00:35
@sovdeeth sovdeeth marked this pull request as ready for review February 6, 2026 03:13
APickledWalrus
APickledWalrus requested changes Feb 6, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@APickledWalrus APickledWalrus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking great!

Some other general notes:

  • Lots of elements (such as Brewing) have ModuleOrigin imports (some added in an early version of this PR) that can be removed. We should clean those up.
  • Fishing events can use ERS interface
  • I don't think javadocs are necessary for the constructors of our actual modules

@sovdeeth
Replace ChildAddonModule with HierarchicalAddonModule, move display/i…
725088d 
…nteraction modules into entity module, few other requested changes
UnderscoreTud
UnderscoreTud approved these changes Mar 12, 2026
View reviewed changes
APickledWalrus
APickledWalrus requested changes Mar 12, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@APickledWalrus APickledWalrus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking really good! Should be just about ready.

Also, some Interaction syntaxes still have unnecessary Origin imports

Pesekjak
Pesekjak approved these changes Mar 16, 2026
View reviewed changes
APickledWalrus
APickledWalrus approved these changes Mar 17, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@APickledWalrus APickledWalrus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks about ready to me! Great work!

@github-project-automation github-project-automation bot moved this from In Review to Awaiting Merge in 2.15 Releases Mar 17, 2026
@sovdeeth sovdeeth merged commit 57f6cb6 into SkriptLang:dev/feature Mar 20, 2026
9 checks passed
@github-project-automation github-project-automation bot moved this from Awaiting Merge to Done - Awaiting Release in 2.15 Releases Mar 20, 2026
@APickledWalrus APickledWalrus mentioned this pull request Mar 30, 2026
Merged
sovdeeth added a commit that referenced this pull request Apr 2, 2026
@sovdeeth @APickledWalrus
@miberss @UnderscoreTud @devdinc @tibisabau @Efnilite @Pesekjak
1564 (#8521)
d20832a 
* Add Origin-applying SyntaxRegistry (#8376)

* Add reduce/fold Expression (#8353)

* Location with Yaw/Pitch (#8351)

* Test framework: support directory resources (#8377)

* Test framework: support directory resources

* use walkFileTree

* oops forgot imports

* Pattern Stringification Customization (#8391)

* Implement StringificationProperties

* Package cleanup

* Fix missing call in GroupPatternElement stringification (#8449)

Fix GroupPatternElement stringification

* Stabilise damage source experiment (#8414)

* Stabilise damage source experiment

* Replace STABLE with MAINSTREAM

* Remove experiment from damage source test

* Remove unstable API usage supression

---------

Co-authored-by: sovdee <10354869+sovdeeth@users.noreply.github.com>

* Add vector(n) (#8412)

* Init commit

* Fix not registering overloading for old namespaces

* Standardize Module usage + add child modules (#8346)

* child module support

* Create child modules and move over existing Bukkit addon modules.

* Update newer modules

* Clean up

* Requested changes and additional conversions

Just tags left!

* convert last module

* standardize package hierarchies

* remove bad imports

* fix bad examples

* Replace ChildAddonModule with HierarchicalAddonModule, move display/interaction modules into entity module, few other requested changes

* requested changes

* varargs registrar (thanks blue!)

* Use addonmodule javadocs to point to other useful tools

* Requested Changes

* Requested Changes

* Added option to compress file backups (#8396)

* Add fast path for integer strings in variable name comparator (#8483)

* Initial conversion

* Some more conversion

* fixes

* Update StructCommand.java

* no tests

---------

Co-authored-by: Patrick Miller <apickledwalrus@icloud.com>
Co-authored-by: mibers <midaswoah2@gmail.com>
Co-authored-by: _tud <98935832+UnderscoreTud@users.noreply.github.com>
Co-authored-by: devdinc <234956748+devdinc@users.noreply.github.com>
Co-authored-by: Tiberiu Sabău <96194994+tibisabau@users.noreply.github.com>
Co-authored-by: Efnilite <35348263+Efnilite@users.noreply.github.com>
Co-authored-by: Pesek <42549665+Pesekjak@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@APickledWalrus APickledWalrus APickledWalrus approved these changes

@Pesekjak Pesekjak Pesekjak approved these changes

@UnderscoreTud UnderscoreTud UnderscoreTud approved these changes

@Efnilite Efnilite Awaiting requested review from Efnilite Efnilite is a code owner automatically assigned from SkriptLang/core-developers

+1 more reviewer

@bluelhf bluelhf bluelhf left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

enhancement Feature request, an issue about something that could be improved, or a PR improving something.

Projects

2.15 Releases
Status: Done - Awaiting Release

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@sovdeeth @APickledWalrus @Pesekjak @bluelhf @UnderscoreTud