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: Enhanced Item Accessibility and Progression #463

Merged
merged 14 commits into from
Feb 18, 2025

Conversation

Frost-bit-jpg
Copy link
Contributor

@Frost-bit-jpg Frost-bit-jpg commented Feb 2, 2025

This update introduces a significant overhaul to the forge system, focusing on providing players with greater access to previously unavailable weapons, equipment, and vehicle upgrades, while also improving the overall progression and item availability.

Description of changes

Reasons for changes

Related links

How have you tested your changes?

  • [] Compile
  • [] New game
  • [] Next turn
  • [] Space Travel
  • [] Ground Battle

This update introduces a significant overhaul to the forge system, focusing on providing players with greater access to previously unavailable weapons, equipment, and vehicle upgrades, while also improving the overall progression and item availability.

**Key Changes:**

*   **Expanded Crafting Options:** Previously unobtainable items are now craftable within the forge, pending certain research levels and STC unlocks, allowing for a wider array of strategic choices.
*   **Conditional Forge Costs:** Many items now feature conditional `forge_cost[i]` assignments, based on the player’s research levels, STC unlocks and specific requirements. This creates a more dynamic and engaging crafting system and makes a more natural progression for the player.
*   **New Item: Boltstorm Gauntlet:** A powerful new close-range option for those who like to enter the fray.
*   **Heavy Bolter and Storm Bolter Adjustments:** The forge cost for Heavy Bolters and Storm Bolters is now conditional on research progress, with their availability gated behind more demanding requirements, making them more appropriate for the mid-game.
*   **Stalker Pattern Bolter:** The crafting requirements for this weapon have been clarified and streamlined.
*   **Infernus Pistol Introduction:** This new flamer based pistol has been added to the armory.
*   **Incinerator Availability:** The Incinerator is now available for production (pending research), fixing its previously unintended state of being uncraftable.
*   **Vehicle Component Adjustments:** Many vehicle components now have more appropriate costs and crafting conditions, leading to a better gameplay progression.
*   **New Vehicle Weaponry:** Numerous vehicle weapons are now unlockable via research and STC unlocks, providing a much larger array of options.
*   **Improved Tooltips:** The research options now have new tooltips that properly describe their functions, making the tech tree easier to navigate.
*   **Vehicle Hangar Cost Impact:** The cost of vehicle components is now dynamically impacted by the size of the player's vehicle hangar. This encourages players to carefully manage their resources.
*  **Reorganized Bolter Progression**: The bolter tech tree was reorganized to properly follow their lore and power scale, while also unlocking new powerful options as the research is completed.
*  **Reworked Armour research:** The armour research was also reworked to require specific levels of research and to reflect the lore more accurately.
* **STC progression**: The STC technologies now impact a larger array of items, making them have more progression for the player.

**Purpose of Changes:**

*   **Enhanced Player Choice:** This overhaul aims to give players a wider range of options and flexibility, allowing them to customize their playstyle and strategic approach.
*  **Improved Progression:** The added conditional requirements and the STC progression will make the player journey into the game much more rewarding.
*   **Clearer Progression:** By gating items behind research and STC unlocks, we create a more compelling sense of progression, encouraging players to explore the full scope of the game's tech tree.

**Balance Notes:**

*   The changes made in this update have been designed to provide more options to the player and are still experimental, so they might be rebalanced in future updates based on feedback and observed game data.
Copy link
Contributor

sourcery-ai bot commented Feb 2, 2025

Reviewer's Guide by Sourcery

This pull request enhances item accessibility and progression in the game by adding new equipment, adjusting forge costs and research requirements for existing items, and introducing new research options. These changes affect various item categories, including equipment, armor, vehicles, and research, aiming to provide players with greater access to previously unavailable items and improve the overall progression system.

File-Level Changes

Change Details Files
Added new equipment items to the shop, including 'Boltstorm Gauntlet' and 'Infernus Pistol', with associated costs, forge costs, and research requirements.
  • Added 'Boltstorm Gauntlet' with cost 90, forge cost 300 (requires power fields and bolt research), and nobuy condition for rene = 1.
  • Added 'Infernus Pistol' with forge cost 100 (requires flame research) and cost 12.
objects/obj_shop/Create_0.gml
Modified forge costs and research requirements for various existing equipment items, such as 'Thunder Hammer', 'Heavy Thunder Hammer', 'Storm Shield', 'Bolt Pistol', 'Stalker Pattern Bolter', 'Heavy Bolter', 'Storm Bolter', and 'Incinerator'.
  • Reduced the research requirement for 'Thunder Hammer' and 'Heavy Thunder Hammer' forge cost from power_fields[0] > 2 to power_fields[0] > 1.
  • Reduced the research requirement for 'Storm Shield' forge cost from power_fields[0] > 2 to power_fields[0] > 1.
  • Reduced the forge cost for 'Bolt Pistol' from 100 to 50.
  • Set a fixed forge cost of 230 for 'Stalker Pattern Bolter'.
  • Added a research requirement (bolt[0] >= 2) for 'Heavy Bolter' and 'Storm Bolter' forge costs.
  • Added a research requirement (flame[0] < 1) to set forge_cost to 0 for 'Incinerator'.
  • Removed the line 'if (research.bolt[0]<2) then forge_cost[i] = 0;' for 'Heavy Bolter'.
objects/obj_shop/Create_0.gml
Adjusted forge costs and research requirements for various armor items, including 'MK4 Maximus', 'Terminator Armour', and 'Tartaros'.
  • Reduced the forge cost for 'MK4 Maximus' from 2000 to 1250 and adjusted tooltip requirements.
  • Adjusted the forge cost and tooltip requirements for 'Terminator Armour' based on research and STC wargear.
  • Adjusted the forge cost and tooltip requirements for 'Tartaros' based on research and STC wargear.
objects/obj_shop/Create_0.gml
Modified forge costs and research requirements for vehicle items and upgrades, including 'Rhino', 'Predator', 'Autocannon Turret', 'Twin Linked Lascannon Turret', 'Heavy Bolter Sponsons', 'Heavy Flamer Sponsons', 'Lascannon Sponsons', 'Land Raider', 'Twin Linked Heavy Bolter Mount', 'Quad Linked Heavy Bolter Sponsons', 'Twin Linked Assault Cannon Mount', 'Flamestorm Cannon Sponsons', 'Hurricane Bolter Sponsons', 'Twin Linked Lascannon Sponsons', 'Whirlwind', 'HK Missile', 'Hunter Killer Missile', 'Twin Linked Bolters', 'Bike', 'Dreadnought', 'Close Combat Weapon', 'Twin Linked Heavy Bolter', 'Twin Linked Lascannon', 'Autocannon', 'Inferno Cannon', 'Dreadnought Lightning Claw', 'Assault Cannon', 'Dreadnought Power Claw', 'Whirlwind Missiles', 'Heavy Conversion Beam Projector', 'Plasma Destroyer Turret', 'Flamestorm Cannon Turret', 'Magna-Melta Turret', 'Neutron Blaster Turret', 'Volkite Saker Turret', 'Volkite Culverin Sponsons', 'Twin Linked Volkite Culverin Sponsons', 'Twin Linked Multi-Melta Sponsons', 'Twin Linked Heavy Flamer Sponsons', 'Reaper Autocannon Mount', 'Vindicator', 'Land Speeder', 'Armoured Ceramite', 'Heavy Armour', 'Smoke Launchers', 'Dozer Blades', 'Searchlight', and 'Frag Assault Launchers'.
  • Reduced the forge cost for 'Rhino' and 'Predator' and made it dependent on player_hanger.
  • Added a research requirement (bolt[0] > 2) for 'Autocannon Turret' forge cost.
  • Added a research requirement (las[0] > 1) for 'Twin Linked Lascannon Turret' forge cost.
  • Added a forge cost for 'Heavy Bolter Sponsons' and made it dependent on player_hanger, also added a research requirement (bolt[0] > 2).
  • Added a forge cost for 'Heavy Flamer Sponsons' and made it dependent on player_hanger, also added a research requirement (flame[0] < 1) to set forge_cost to 0.
  • Added a research requirement (las[0] > 1) for 'Lascannon Sponsons' forge cost.
  • Adjusted the nobuy condition and added a forge cost for 'Land Raider' based on STC vehicles.
  • Added a research requirement (bolt[0] > 2) for 'Twin Linked Heavy Bolter Mount' forge cost.
  • Added a research requirement (bolt[0] > 3) for 'Quad Linked Heavy Bolter Sponsons' forge cost.
  • Added a research requirement (bolt[0] > 3) for 'Twin Linked Assault Cannon Mount' forge cost.
  • Added a forge cost for 'Flamestorm Cannon Sponsons' and made it dependent on player_hanger, also added a research requirement (flame[0] < 1) to set forge_cost to 0.
  • Added a research requirement (bolt[0] > 3) for 'Hurricane Bolter Sponsons' forge cost.
  • Added a research requirement (las[0] > 1) for 'Twin Linked Lascannon Sponsons' forge cost.
  • Added a forge cost for 'Whirlwind' and made it dependent on player_hanger.
  • Added a forge cost for 'HK Missile' and made it dependent on player_hanger.
  • Adjusted the nobuy condition and added a forge cost for 'Hunter Killer Missile' based on STC vehicles.
  • Added a research requirement (bolt[0] >= 2) for 'Twin Linked Bolters' forge cost.
  • Added a forge cost for 'Bike' and made it dependent on player_hanger.
  • Adjusted the forge cost and tooltip requirements for 'Dreadnought' based on research, STC wargear, and armour research.
  • Added a forge cost for 'Close Combat Weapon' and made it dependent on player_hanger.
  • Added a research requirement (bolt[0] > 2) for 'Twin Linked Heavy Bolter' forge cost.
  • Added a research requirement (las[0] > 1) for 'Twin Linked Lascannon' forge cost.
  • Added a research requirement (bolt[0] > 2) for 'Autocannon' forge cost.
  • Added a forge cost for 'Inferno Cannon' and made it dependent on player_hanger.
  • Added a forge cost for 'Dreadnought Lightning Claw' and made it dependent on player_hanger.
  • Added a research requirement (bolt[0] > 2) for 'Assault Cannon' forge cost.
  • Added a forge cost for 'Dreadnought Power Claw' and made it dependent on player_hanger.
  • Added a forge cost for 'Whirlwind Missiles' and made it dependent on player_hanger.
  • Added a forge cost for 'Heavy Conversion Beam Projector' and made it dependent on player_hanger.
  • Added a forge cost for 'Plasma Destroyer Turret' and made it dependent on player_hanger.
  • Added a forge cost for 'Flamestorm Cannon Turret' and made it dependent on player_hanger.
  • Added a forge cost for 'Magna-Melta Turret' and made it dependent on player_hanger.
  • Added a forge cost for 'Neutron Blaster Turret' and made it dependent on player_hanger.
  • Added a forge cost for 'Volkite Saker Turret' and made it dependent on player_hanger.
  • Added a forge cost for 'Volkite Culverin Sponsons' and made it dependent on player_hanger.
  • Added a forge cost for 'Twin Linked Volkite Culverin Sponsons' and made it dependent on player_hanger.
  • Added a forge cost for 'Twin Linked Multi-Melta Sponsons' and made it dependent on player_hanger.
  • Added a forge cost for 'Twin Linked Heavy Flamer Sponsons' and made it dependent on player_hanger.
  • Added a forge cost for 'Reaper Autocannon Mount' and made it dependent on player_hanger.
  • Adjusted the nobuy condition and added a forge cost for 'Vindicator' based on STC vehicles.
  • Adjusted the nobuy condition and added a forge cost for 'Land Speeder' based on STC vehicles.
  • Adjusted the cost and added a forge cost for 'Armoured Ceramite' based on STC vehicles.
  • Adjusted the cost and added a forge cost for 'Heavy Armour' based on STC vehicles.
  • Adjusted the cost and added a forge cost for 'Smoke Launchers' based on STC vehicles.
  • Adjusted the cost and added a forge cost for 'Dozer Blades' based on STC vehicles.
  • Adjusted the cost and added a forge cost for 'Searchlight' based on STC vehicles.
  • Adjusted the cost for 'Frag Assault Launchers' based on STC vehicles.
objects/obj_shop/Create_0.gml
Added and modified research items in the production shop, including 'Flame Weapons', 'Force Weapons', 'Las Weaponry', 'Chain Weaponry', 'Plasma Weapons', 'Advanced Bolt Weapons', 'Power Weapons', 'Melta Weaponry', 'Grav Weapons', 'Advanced Servo Motors', 'Advanced Ceramite Bonding', 'Ceremite Void Hardening', and 'Enhanced Nerve Interfacing', with associated costs and tooltip descriptions.
  • Added research item for 'Flame Weapons' with cost 3000 and a tooltip describing its effects.
  • Added research item for 'Force Weapons' with cost 3000 and a tooltip describing its effects.
  • Added research item for 'Las Weaponry' with cost 3000 and a tooltip describing its effects.
  • Added research item for 'Chain Weaponry' with cost 3000 and a tooltip describing its effects.
  • Added research item for 'Plasma Weapons' with cost 3000 and a tooltip describing its effects.
  • Added research item for 'Advanced Bolt Weapons' with cost 3000 and a tooltip describing its effects.
  • Added research item for 'Power Weapons' with cost 3000 and a tooltip describing its effects.
  • Added research item for 'Melta Weaponry' with cost 3000 and a tooltip describing its effects.
  • Added research item for 'Grav Weapons' with cost 3000 and a tooltip describing its effects.
  • Added research item for 'Advanced Servo Motors' with cost 3000 and a tooltip describing its effects.
  • Added research item for 'Advanced Ceramite Bonding' with cost 3000 and a tooltip describing its effects.
  • Added research item for 'Ceremite Void Hardening' with cost 3000 and a tooltip describing its effects.
  • Added research item for 'Enhanced Nerve Interfacing' with cost 3000 and a tooltip describing its effects.
objects/obj_shop/Create_0.gml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot previously approved these changes Feb 2, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @Frost-bit-jpg - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider cleaning up indentation inconsistencies throughout the file (e.g. mixed tabs/spaces and varying indent levels)
  • There are several repeated patterns like forge_cost[i] = X*player_hanger that could be extracted into helper functions to reduce code duplication
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@Frost-bit-jpg Frost-bit-jpg changed the title Forge Overhaul: Enhanced Item Accessibility and Progression <fix>(<Forge Overhaul>): <Enhanced Item Accessibility and Progression> Feb 2, 2025
@Frost-bit-jpg Frost-bit-jpg changed the title <fix>(<Forge Overhaul>): <Enhanced Item Accessibility and Progression> fix: Enhanced Item Accessibility and Progression Feb 2, 2025
@Frost-bit-jpg Frost-bit-jpg marked this pull request as draft February 2, 2025 08:48
@Frost-bit-jpg Frost-bit-jpg marked this pull request as ready for review February 2, 2025 08:51
@EttyKitty EttyKitty added the PR: Balance Noticeably affects game balance label Feb 3, 2025
@EttyKitty
Copy link
Collaborator

@sourcery-ai review

This pull request enables players to equip Rhinos with Hunter-Killer Missiles. Previously, the option to equip this system was unavailable.
This change fixes a typo with recruitment causing scouts to always have 10 corruption that cannot be reduced regardless of the training method.
@Frost-bit-jpg Frost-bit-jpg marked this pull request as draft February 7, 2025 02:02
@Frost-bit-jpg Frost-bit-jpg marked this pull request as ready for review February 7, 2025 02:09
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @Frost-bit-jpg - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Review the use of assignment operators in conditions (e.g., 'if (rene = 1)') to ensure you intended assignment and not comparison.
  • Remove or clarify commented-out code sections (such as the Executioner Power Axe block) to improve maintainability.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@OH296
Copy link
Collaborator

OH296 commented Feb 9, 2025

i'm vaguely concerned as i mentioned before on the discord that this work (being rather substantial) was not done in conjunction with https://github.com/Adeptus-Dominus/ChapterMaster/pull/425/files. Not the end of the world but just trying to consider how to rationalise the two. e.g push this through or merge this work and get the main rework going. Other wise this or could be considered doubling down on a very flawed system

@Frost-bit-jpg
Copy link
Contributor Author

Well the idea is that since the overhaul work would take potentially more time, the idea is this would serve as temporary place holder and experiment to some ideas around forge prices balance. I did take your concern in mind and discussed the matter before proceeding.
Tl;dr i expect this work to be discarded for the bigger overhaul work and i'm fine with that.

@Frost-bit-jpg
Copy link
Contributor Author

I'm also rather concerned to work on the newer system and potentially cause some issues with the logic flaw.

@OH296
Copy link
Collaborator

OH296 commented Feb 10, 2025

Well the idea is that since the overhaul work would take potentially more time, the idea is this would serve as temporary place holder and experiment to some ideas around forge prices balance. I did take your concern in mind and discussed the matter before proceeding. Tl;dr i expect this work to be discarded for the bigger overhaul work and i'm fine with that.

whelp no issue, as long as your happy,

@OH296
Copy link
Collaborator

OH296 commented Feb 10, 2025

@sourcery-ai review

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @Frost-bit-jpg - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider using constants for item names and research names to avoid typos and improve maintainability.
  • It looks like you're using a lot of hardcoded values for costs and research requirements; consider using a data-driven approach to make these more configurable.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟡 Review instructions: 2 issues found
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@EttyKitty EttyKitty added the PR: Improvment Makes something better label Feb 10, 2025
Copy link
Collaborator

@Blogaugis Blogaugis left a comment

Choose a reason for hiding this comment

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

I am for it, though, the #425 may render this a bit dated.

Copy link
Contributor

@MCPO-Spartan-117 MCPO-Spartan-117 left a comment

Choose a reason for hiding this comment

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

Please use git rebase and force push, and remove all unrelated changes, preferably through git reset --hard <Update Create_0.gml commit> to not have revert commits.

@EttyKitty
Copy link
Collaborator

@sourcery-ai review

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @Frost-bit-jpg - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider using constants for item names to avoid typos and improve maintainability.
  • It looks like you're using a lot of hardcoded values; consider using data tables or external configuration files.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟡 Review instructions: 2 issues found
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@OH296 OH296 merged commit 4fa956b into Adeptus-Dominus:main Feb 18, 2025
1 check passed
@EttyKitty EttyKitty added the PR: Backport Needs to be backported to stable label Feb 21, 2025
Copy link
Contributor

coderabbitai bot commented Feb 21, 2025

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The changes update the item handling logic within the Create_0.gml script of the shop system. A new item, "Boltstorm Gauntlet," has been added with a cost of 90 and a forge cost determined by research conditions. Existing item values are modified; for instance, the "Bolt Pistol" cost is lowered from 100 to 50, and the "Heavy Bolter" now requires research.bolt[0] >= 2 for a forge cost of 300. Additionally, conditional checks for items such as "Thunder Hammer" and "Heavy Thunder Hammer" have been revised from research.power_fields[0] > 2 to research.power_fields[0] > 1. Portions of the code handling the "Executioner Power Axe" are disabled via comments. Tooltips and research descriptions have been expanded, and further adjustments for vehicle and weaponry forge costs are introduced based on research progress. Glory to the Omnissiah for these precise tweaks in our code!

Possibly related PRs

Suggested labels

PR: Fix


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7038ad4 and 03b30d3.

📒 Files selected for processing (1)
  • objects/obj_shop/Create_0.gml (53 hunks)

🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 or @coderabbitai title 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: Backport Needs to be backported to stable PR: Balance Noticeably affects game balance PR: Improvment Makes something better
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants