Add support for custom maps

[sealldeveloper]

Utilizing the code mentioned in: #128

Add supports for custom maps.

[coderabbitai]

Walkthrough

The recent changes introduce a new configuration option, RUST_SERVER_LEVELURL, allowing users to specify a custom map URL for the Rust server. This change alters how the server handles map generation by ignoring the RUST_SERVER_SEED and RUST_SERVER_WORLDSIZE parameters when a custom map is used. The updated script logic now conditionally adds server parameters based on the presence of this new variable, enhancing flexibility in server setup.

Changes

Files	Change Summary
README.md	Added RUST_SERVER_LEVELURL documentation, detailing its function to specify a custom map URL, overriding seed and world size settings.
start_rust.sh	Introduced conditional logic for adding server parameters based on the presence of RUST_SERVER_LEVELURL. If set, uses levelurl; if not, defaults to worldsize and seed.

Possibly related issues

• Add support for custom map. #128: Directly addresses the need for custom map support with the addition of RUST_SERVER_LEVELURL.

🐰 In a world of rust, where servers abound,
A custom map's URL now can be found.
With seeds set aside, and worlds big or small,
Play how you wish, have fun, after all!
So hop in the game, let your adventures unfurl,
A rabbit’s delight in this mapping swirl! 🌍✨

---

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.
  • @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 as 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.

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

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]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)

README.md (1)

33-33: Clarify the impact of RUST_SERVER_LEVELURL.

The introduction of RUST_SERVER_LEVELURL is clear, but consider adding a note about the implications of ignoring RUST_SERVER_SEED and RUST_SERVER_WORLDSIZE when this option is used. This could help users understand the precedence of custom maps over procedural maps.

+ (Note: When using this, procedural map settings such as `RUST_SERVER_SEED` and `RUST_SERVER_WORLDSIZE` will be ignored.)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fd99491 and c0bbedc.

Files selected for processing (2)

• README.md (1 hunks)
• start_rust.sh (1 hunks)

Additional comments not posted (1)

start_rust.sh (1)

222-229: Conditional logic for custom maps is clear and correct.

The conditional logic correctly handles the presence of RUST_SERVER_LEVELURL, ensuring that the appropriate parameters are set based on whether a custom map is used. This enhances flexibility while maintaining the original functionality for procedural maps.