Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[1.21.3] Allow mods to add custom FeatureFlags #1619

Merged
merged 1 commit into from
Nov 15, 2024

Conversation

XFactHD
Copy link
Member

@XFactHD XFactHD commented Oct 23, 2024

This PR makes it possible for mods to add custom FeatureFlags to the vanilla feature flag system. Since the FeatureFlagRegistry holding the flags is set in stone long before mods start loading, the flags are specified in a JSON file instead of being collected by an event or similar system. To allow adding more than the 64 flags allowed by vanilla (a limitation that is not unlikely to be hit with 100s of mods in a pack), the flag masks are extended by a long[] in the FeatureFlagSet and an offset field in FeatureFlag for indexing into the array.

Closes #1106.

This PR is the 1.21.3 port of #1538.

@neoforged-pr-publishing
Copy link

neoforged-pr-publishing bot commented Oct 23, 2024

  • Publish PR to GitHub Packages

Last commit published: 49d3b0aa7dce9cb08bf3eaf8ac8b3478191697a1.

PR Publishing

The artifacts published by this PR:

Repository Declaration

In order to use the artifacts published by the PR, add the following repository to your buildscript:

repositories {
    maven {
        name 'Maven for PR #1619' // https://github.com/neoforged/NeoForge/pull/1619
        url 'https://prmaven.neoforged.net/NeoForge/pr1619'
        content {
            includeModule('net.neoforged', 'testframework')
            includeModule('net.neoforged', 'neoforge')
        }
    }
}

MDK installation

In order to setup a MDK using the latest PR version, run the following commands in a terminal.
The script works on both *nix and Windows as long as you have the JDK bin folder on the path.
The script will clone the MDK in a folder named NeoForge-pr1619.
On Powershell you will need to remove the -L flag from the curl invocation.

mkdir NeoForge-pr1619
cd NeoForge-pr1619
curl -L https://prmaven.neoforged.net/NeoForge/pr1619/net/neoforged/neoforge/21.3.2-beta-pr-1619-modded_feature_flags_21.3/mdk-pr1619.zip -o mdk.zip
jar xf mdk.zip
rm mdk.zip || del mdk.zip

To test a production environment, you can download the installer from here.

@ApexModder ApexModder self-assigned this Oct 23, 2024
@XFactHD XFactHD added enhancement New (or improvement to existing) feature or request data driven This request involves a data driven system 1.21.3 Targeted at Minecraft 1.21.3 labels Oct 23, 2024
@ApexModder ApexModder added enhancement New (or improvement to existing) feature or request data driven This request involves a data driven system and removed enhancement New (or improvement to existing) feature or request data driven This request involves a data driven system labels Oct 23, 2024
Copy link
Contributor

@ApexModder ApexModder left a comment

Choose a reason for hiding this comment

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

Working locally in mod dev via pr-publishing 👍

image
Example is custom item depending on a custom experimental feature flag, level has said flag disabled

Copy link
Contributor

@ApexModder ApexModder left a comment

Choose a reason for hiding this comment

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

Update IMenuTypeExtension.create to allow modders to flag their MenuTypes if desired.
Reposted from Discord

Copy link
Contributor

@ApexModder ApexModder left a comment

Choose a reason for hiding this comment

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

Requested MenuType change was deemed not necessary, modders can simply invoke MenuType#new and pass in the desired FeatureFlagSet

@ApexModder ApexModder merged commit 0d3c57d into neoforged:1.21.x Nov 15, 2024
7 checks passed
@XFactHD XFactHD deleted the modded_feature_flags_21.3 branch November 15, 2024 22:47
@neoforged-releases
Copy link

🚀 This PR has been released as NeoForge version 21.3.31-beta.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.21.3 Targeted at Minecraft 1.21.3 data driven This request involves a data driven system enhancement New (or improvement to existing) feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Modded Experimental Feature Flag
2 participants