Alfheim icon indicating copy to clipboard operation
Alfheim copied to clipboard

Feat: Use LazyInit to load LightEngine and make the server not force the client to install the same version of the mod.

Open KasumiNova opened this issue 1 year ago • 1 comments

📝 Description

This PR fixes plugin server compatibility. Changed WorldMixin to LazyInit at alfheim$getLightingEngine() instead of loading immediately at because the plugin server added a new method, but the mixin could not modify the newly added method properly (Like this: https://mclo.gs/Timk8ND).

Another feature, modified Alfheim.java, added a annotation content, so that the server can accept any version of the client's mod, because there is no relevant code involved in the dual-end interaction, so that the client does not need to force the installation of the same version of the mod with the server.

🚦 Testing

Works fine at SinglePlayer, Dedicated Server, Dedicated Plugin Server.

⏮️ Backwards Compatibility

Works fine.

📚 Related Issues & Documents

🖼️ Screenshots/Recordings

📖 Added to documentation?

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

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

Summary by CodeRabbit

  • New Features

    • Updated project version from 1.4 to 1.5, indicating a new release.
    • Added compatibility checks for remote versions, enhancing flexibility.
    • Introduced lazy initialization for the LightingEngine, improving performance and robustness.
  • Bug Fixes

    • Improved control flow for lighting engine access, reducing potential version-related issues.

KasumiNova avatar Sep 13 '24 08:09 KasumiNova

Walkthrough

The pull request introduces several changes, including an update to the project version in build.gradle.kts, the addition of the acceptableRemoteVersions attribute in the @Mod annotation of Alfheim.java, and modifications in WorldMixin.java that enhance the initialization process of the LightingEngine. These changes collectively aim to improve version management and control flow within the codebase.

Changes

File Change Summary
build.gradle.kts Updated version from "1.4" to "1.5".
src/main/java/dev/redstudio/alfheim/... Added acceptableRemoteVersions = "*" to @Mod annotation for version compatibility.
src/main/java/dev/redstudio/alfheim/... Modified WorldMixin to defer LightingEngine initialization to a lazy loading method.

Sequence Diagram(s)

sequenceDiagram
    participant World as WorldMixin
    participant Engine as LightingEngine

    World->>Engine: Request LightingEngine
    alt First Access
        Engine-->>World: Initialize LightingEngine
    end
    World->>Engine: Use LightingEngine

🐰 "In the code where changes bloom,
A version's rise dispels the gloom.
With lights that wait, and mods that play,
A brighter path is here to stay!
Hops of joy, we celebrate,
New features come, oh isn't it great!" 🐇✨


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>, please review it.
    • Generate unit testing code 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Sep 13 '24 08:09 coderabbitai[bot]

Could you send the full debug log of a crash? because it feels weird that the init inject would fail

Desoroxxx avatar Nov 04 '24 13:11 Desoroxxx

This was added in 1.6 Dev 2

Desoroxxx avatar Mar 12 '25 06:03 Desoroxxx