Add dimension Blacklist/Whitelist for cloud rendering

[michelegargiulo]

📝 Description

This PR adds configuration that allows players and modpack makers to specify a list of dimensions where Cloud Rendering is enabled (whitelist) or not enabled (blacklist), by writing a list of dimension IDs and if such list is a blacklist or a whitelist, in mod configuration. Config is reloadable (no MC restart or World Reload required). Config are also localized, in line with the other config options

🎯 Goals

Enhance mod configurability and customizability

❌ Non Goals

The PR aims to limit where could can render, instead of adding cloud rendering to more dimensions. For example, this PR allows players to disable Clouds in The Overworld but not in Twilight Forest. Before this PR one could only enable or disable cloud rendering for both at the same time. This PR does not allow one to add clouds to The Nether or The End.

🚦 Testing

Tested in both dev environment and custom modpack (500+ mods)

⏮️ Backwards Compatibility

This chance is Backwards compatible. By default, the dimension list is an empty blacklist. Configuration still obeys to master switch "enable clouds", and players that update the mod without knowing this change, will not experience any change whatsoever

📚 Related Issues & Documents

None that I know of

🖼️ Screenshots/Recordings

Nothing to show, just new configs

📖 Added to documentation?

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

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

Advanced Rocketry planets with clouds: 🤮

Summary by CodeRabbit

• New Features
  • Introduced new configuration options for cloud graphics, including the ability to whitelist or blacklist clouds in specific dimensions.
• Enhancements
  • Improved cloud rendering logic to respect the new dimension-based settings.

[coderabbitai]

Walkthrough

The update introduces a new feature to the Valkyrie project, allowing users to control the rendering of clouds based on the world's dimension. It adds configuration options to specify dimensions where clouds should be shown or hidden, enhancing customization for different game environments. This is achieved by introducing a dimension list and a blacklist flag in the configuration, along with logic in the cloud renderer to apply these settings.

Changes

File Path	Change Summary
.../config/ValkyrieConfig.java	Added dimensionList and dimensionListIsBlacklist to CloudsConfig.
.../renderer/CloudRenderer.java	Updated updateSettings() to include dimension list logic.
.../assets/valkyrie/lang/en_us.lang	Added new cloud graphics configuration options.

🐰✨
Over the hills, under the sky so vast,
Clouds dance freely, as dimensions pass.
In realms where Valkyries dare to tread,
New rules in place, by clever minds led.
🌥️🚫🌍
So hop with joy, for now, we choose,
Where clouds may roam, or take their snooze.
🐇💻🎉

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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 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 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 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.

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.
• 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/coderabbit-overrides.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]

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between d4fab4b and 1990f64.

Files selected for processing (3)

• src/main/java/dev/redstudio/valkyrie/config/ValkyrieConfig.java (1 hunks)
• src/main/java/dev/redstudio/valkyrie/renderer/CloudRenderer.java (2 hunks)
• src/main/resources/assets/valkyrie/lang/en_us.lang (1 hunks)

Additional comments not posted (7)

src/main/java/dev/redstudio/valkyrie/config/ValkyrieConfig.java (2)

61-61: The addition of the dimensionList field is correctly implemented and initialized.

---

63-63: The addition of the dimensionListIsBlacklist field is correctly implemented and initialized.

src/main/resources/assets/valkyrie/lang/en_us.lang (4)

63-63: The addition of the dimensionlist configuration option is correctly implemented.

---

64-64: The tooltip for the dimensionlist configuration option is clear and informative.

---

65-65: The addition of the dimensionlistisblacklist configuration option is correctly implemented.

---

66-66: The tooltip for the dimensionlistisblacklist configuration option is clear and informative.

src/main/java/dev/redstudio/valkyrie/renderer/CloudRenderer.java (1)

207-208: The updated logic in the updateSettings() method correctly implements the feature to enable or disable cloud rendering based on the dimension list and blacklist/whitelist setting.

[Desoroxxx]

Wow, I am so sorry, I just didn't or forgot this existed, will take a look at it later today