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

Fix incompatibility with RenderLib 1.3.3+ #59

Merged
merged 1 commit into from
Mar 31, 2024

Conversation

Meldexun
Copy link
Contributor

@Meldexun Meldexun commented Mar 29, 2024

📝 Description

Replaces the mixin that overwrites the Minecraft#createDisplay method with two ModifyConstant mixins to fix compatibility with RenderLib 1.3.3+.

🎯 Goals

Fix compatibility with RenderLib 1.3.3+.

❌ Non Goals

Change any Valkyrie functionality or introduce new bugs.

🚦 Testing

Couldn't create a Valkyrie build and thus just created a test mod with the new ModifyConstant mixins.

⏮️ Backwards Compatibility

PR is backward compatible.

📚 Related Issues & Documents

#23

🖼️ Screenshots/Recordings

None

📖 Added to documentation?

  • 📜 README.md
  • 📑 Documentation
  • 📓 Javadoc
  • 🍕 Comments
  • 🙅 No documentation needed

😄 [optional] What gif best describes this PR or how it makes you feel?

😶

Summary by CodeRabbit

  • Refactor
    • Improved flexibility and configurability of the window title and depth buffer settings.

Copy link

coderabbitai bot commented Mar 29, 2024

Walkthrough

This update brings a more flexible and configurable approach to customizing the Minecraft client, particularly in how the window title and depth buffer settings are managed. By shifting from a direct overwrite to utilizing Mixin annotations like @ModifyConstant, the modification process becomes less intrusive and more adaptable to different configurations, enhancing the mod's compatibility and ease of use.

Changes

File Path Change Summary
.../valkyrie/mixin/MinecraftMixin.java Refactored createDisplay method to use @ModifyConstant for window title and depth buffer customization.

🐇✨
In the realm of code, where the bits entwine,
A rabbit hopped through, leaving changes so fine.
With a flick and a tweak, in the Java domain,
It danced through the mixins, a new elegance to claim.
"To improve, to enhance!" it cheerfully sings,
Leaving behind, in the code, its whimsical springs.
🌟🐰

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between fa5fd6f and a496eab.
Files selected for processing (1)
  • src/main/java/dev/redstudio/valkyrie/mixin/MinecraftMixin.java (1 hunks)
Additional Context Used
Additional comments not posted (3)
src/main/java/dev/redstudio/valkyrie/mixin/MinecraftMixin.java (3)

46-49: The change to use @ModifyConstant for modifying the window title based on configuration is a good approach for enhancing flexibility and compatibility. Ensure that ValkyrieConfig.general.windowTitle is properly sanitized to prevent potential security vulnerabilities.


55-57: The modification to allow configurable depth buffer settings through @ModifyConstant is a straightforward and effective way to enhance rendering capabilities based on user preferences. This change aligns well with the PR's objectives.


46-49: While the use of @Overwrite for setting window icons provides a flexible way to customize the game's appearance, it's important to carefully consider the implications of completely replacing the original method. Verify that this is the most appropriate approach and assess potential compatibility issues with other mods or future updates.

Copy link
Member

@Desoroxxx Desoroxxx left a comment

Choose a reason for hiding this comment

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

LGTM

@Desoroxxx Desoroxxx merged commit c1641d8 into Red-Studio-Ragnarok:main Mar 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants