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

feat: implement tutorial mode with guided gameplay and bonus explanations #39

Closed
wants to merge 1 commit into from

Conversation

Mystic-Nayy
Copy link

@Mystic-Nayy Mystic-Nayy commented Sep 5, 2024

Resolves #22

Summary by CodeRabbit

  • New Features

    • Introduced a new game mode: Tutorial Mode, enhancing user experience with guided gameplay.
  • Improvements

    • Enhanced rendering logic for displaying game modes, providing clearer mode titles.
    • Streamlined code formatting in the Home component for better readability and maintainability.

Copy link

vercel bot commented Sep 5, 2024

@Gift-Naomi is attempting to deploy a commit to the z-korp Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

coderabbitai bot commented Sep 5, 2024

Walkthrough

The changes introduce a new "Tutorial" mode to the game, enhancing the existing gameplay options. This includes modifications to the ModeType enum to accommodate the new mode, updates to the rendering logic in the Start component to display the tutorial title, and formatting improvements in the Home component for better readability and structure.

Changes

File Change Summary
client/src/dojo/game/types/mode.ts Added Tutorial enum member with value "Totorial" to ModeType.
client/src/ui/actions/Start.tsx Replaced conditional rendering with switch-case for displaying mode titles, added semicolon.
client/src/ui/screens/Home.tsx Streamlined imports, adjusted state initialization, improved conditional rendering structure.

Assessment against linked issues

Objective Addressed Explanation
Implement a new "Tutorial" mode (22)
Add a "Tutorial" option to the main menu or game mode selection screen (22)
Ensure players can easily access and start the Tutorial mode (22) Implementation details for access not specified.

Possibly related issues

🐇 In the meadow where bunnies play,
A new Tutorial mode is here to stay!
With cubes to slide and bonuses bright,
Guiding each player, oh what a delight!
Hop in, dear friends, let’s learn and explore,
A world of fun awaits—come, let’s score! 🐰✨


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

@Mystic-Nayy Mystic-Nayy changed the title implement new game mode option for Tutoria feat: implement tutorial mode with guided gameplay and bonus explanations Sep 5, 2024
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: 1

Outside diff range, codebase verification and nitpick comments (1)
client/src/dojo/game/types/mode.ts (1)

Line range hint 20-20: Handle the new Tutorial mode in duration and price methods.

The duration and price methods in the Mode class do not handle the new Tutorial mode. This could lead to unexpected behavior when this mode is used.

Consider adding cases for Tutorial in these methods. For example:

  public duration(): number {
    switch (this.value) {
      case ModeType.Normal:
        return 60480000;
      case ModeType.Daily:
        return 86400;
      case ModeType.None:
        return 0;
+     case ModeType.Tutorial:
+       return 3600; // Example duration for tutorial mode
    }
  }

  public price(): bigint {
    switch (this.value) {
      case ModeType.Normal:
        return BigInt(0);
      case ModeType.Daily:
        return BigInt(0);
      case ModeType.None:
        return BigInt(0);
+     case ModeType.Tutorial:
+       return BigInt(0); // Assuming no cost for tutorial mode
    }
  }

Also applies to: 30-30

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1eff92c and c8d2357.

Files selected for processing (3)
  • client/src/dojo/game/types/mode.ts (1 hunks)
  • client/src/ui/actions/Start.tsx (2 hunks)
  • client/src/ui/screens/Home.tsx (5 hunks)
Files skipped from review due to trivial changes (1)
  • client/src/ui/screens/Home.tsx
Additional comments not posted (2)
client/src/ui/actions/Start.tsx (2)

90-101: Approve the enhanced mode title determination logic.

The switch-case structure for determining the mode title is a clear improvement over the previous ternary operator. It enhances readability and maintainability, especially with the addition of the new Tutorial Mode.


65-65: Approve the syntax improvement.

The addition of a semicolon at the end of the handleGameMode function call is a minor but positive change for maintaining consistency in code style.

@@ -2,6 +2,7 @@ export enum ModeType {
None = "None",
Normal = "Normal",
Daily = "Daily",
Tutorial = "Totorial",
Copy link

Choose a reason for hiding this comment

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

Correct the spelling mistake in the enum value.

The enum value for Tutorial is misspelled as "Totorial". This should be corrected to maintain consistency and avoid potential bugs.

Apply this diff to correct the spelling:

-  Tutorial = "Totorial",
+  Tutorial = "Tutorial",
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Tutorial = "Totorial",
Tutorial = "Tutorial",

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.

Implement Tutorial Mode with Guided Gameplay and Bonus Explanations
2 participants