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.1] Relax extensible enum coherence checks for extensible enums without custom entries #1559

Open
wants to merge 3 commits into
base: 1.21.x
Choose a base branch
from

Conversation

XFactHD
Copy link
Member

@XFactHD XFactHD commented Sep 22, 2024

This PR relaxes the coherence checks on extensible enums to allow a client/server with an extensible enum without additional entries to connect to a server/client with the respective enum not made extensible. This ensures that a NeoForge version which makes a new enum extensible is network-compatible with the previous NeoForge version as long as no mod adds additional entries to the affected enum. With the current implementation, any additional enum being made extensible and marked as @NetworkedEnum would break network compatibility with the previous version, regardless of any mod actually making use of the extensibility.

@XFactHD XFactHD added enhancement New (or improvement to existing) feature or request networking Related to networking 1.21.1 Targeted at Minecraft 1.21.1 labels Sep 22, 2024
@neoforged-pr-publishing
Copy link

neoforged-pr-publishing bot commented Sep 22, 2024

  • Publish PR to GitHub Packages

Last commit published: f6ca17a4f50739cc89085b2e627307b270dd7675.

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 #1559' // https://github.com/neoforged/NeoForge/pull/1559
        url 'https://prmaven.neoforged.net/NeoForge/pr1559'
        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-pr1559.
On Powershell you will need to remove the -L flag from the curl invocation.

mkdir NeoForge-pr1559
cd NeoForge-pr1559
curl -L https://prmaven.neoforged.net/NeoForge/pr1559/net/neoforged/neoforge/21.1.65-pr-1559-relax_enum_checks/mdk-pr1559.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.

pupnewfster
pupnewfster previously approved these changes Sep 22, 2024
Copy link
Member

@pupnewfster pupnewfster left a comment

Choose a reason for hiding this comment

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

Code looks fine (though I have not personally tested the functionality)

@neoforged-automation
Copy link

@XFactHD, this pull request has conflicts, please resolve them for this PR to move forward.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.21.1 Targeted at Minecraft 1.21.1 enhancement New (or improvement to existing) feature or request networking Related to networking
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants