feat: make /pkclear command configurable and available to regular players

[Rhefew]

This PR enhances the /pkclear chat command plugin to allow regular players (not just Game Masters) to clear their own PK status in exchange for Zen. It also introduces server configuration controls so administrators can adjust the Zen cost and toggle the feature's availability.

Key Changes

1. Plugin Access & Control:
   • Changed the minimum required character status for /pkclear to CharacterStatus.Normal.
   • Implemented ISupportCustomConfiguration on PkClearChatCommandPlugIn to expose a configuration schema:
     • ZenCostPerKill (default: 10,000,000 Zen): Cost per PK count.
     • AllowRegularPlayers (default: true): Toggles whether non-GMs can clear their own PK status.
2. Execution Rules & Restrictions:
   • Game Masters: Retain existing behavior. They bypass the Zen fee and can clear other players' PK status by running /pkclear <character_name>.
   • Regular Players: Can only target themselves. If AllowRegularPlayers is enabled, the command calculates PK Count * ZenCostPerKill and deducts the Zen. If they do not have enough Zen, the command fails with a localized "Not enough money" message.
3. Usability Enhancements:
   • Updated PkClearChatCommandArgs to make the CharacterName argument optional. Regular players can simply type /pkclear to clear their own status, whereas GMs are still prompted to specify a name if they attempt to target another player.
4. Unit Tests:
   • Added a new unit test suite PKClearChatCommandPlugInTest covering access rules, GM target clearing, regular player self-clearing, insufficient Zen failures, and targeting restrictions.

---

Verification Results

Tested locally and verified:

• All stylecop/codestyle rules are respected.
• NUnit Test Output:

  Passed!  - Failed: 0, Passed: 5, Skipped: 0, Total: 5, Duration: 144 ms - MUnique.OpenMU.Tests.dll (net10.0)
  

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request expands the functionality of the /pkclear chat command, enabling regular players to clear their own PK status for a configurable amount of Zen. It provides server administrators with granular control over the feature via a new configuration schema, while ensuring that Game Masters retain their ability to manage PK statuses for other players. The changes include robust validation to prevent unauthorized usage and ensure the economy remains balanced.

Highlights

• Command Accessibility: Updated the /pkclear command to be accessible by regular players, while maintaining existing functionality for Game Masters.
• Configurable Zen Cost: Introduced a configurable Zen cost per PK count, allowing server administrators to balance the economy and PK clearing mechanics.
• Execution Logic: Implemented logic to differentiate between self-clearing for regular players and target-clearing for Game Masters, including necessary validation checks.
• Testing: Added a comprehensive NUnit test suite to verify access rules, cost deduction, and targeting restrictions.

New Features

🧠 You can now enable Memory (public preview) to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request updates the /pkclear chat command to allow regular players to clear their PK status for a configurable Zen cost, and adds corresponding unit tests. The review feedback highlights several important issues: a potential integer overflow in the Zen cost calculation that could allow free PK clears, thread-safety and null-safety concerns in the command handler, a logical flaw where regular players specifying a target character silently clear their own status, and several hardcoded English messages that should be localized.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

[gemini-code-assist]

An integer overflow can occur when calculating the Zen cost if a player has a high PK count and ZenCostPerKill is set to a high value (e.g., the default 10,000,000). For example, if a player has 215 kills, 215 * 10,000,000 equals 2,150,000,000, which exceeds int.MaxValue (2,147,483,647) and overflows to a negative number (-2,144,967,296). Since the negative cost is not greater than 0, the check cost > 0 evaluates to false, allowing the player to clear their PK status for free.

To prevent this, calculate the cost using long arithmetic and ensure it does not exceed int.MaxValue before calling TryRemoveMoney.

            var cost = (long)targetCharacter.PlayerKillCount * configuration.ZenCostPerKill;
            if (cost > 0)
            {
                if (cost > int.MaxValue || !player.TryRemoveMoney((int)cost))
                {
                    await player.ShowLocalizedBlueMessageAsync(nameof(PlayerMessage.NotEnoughMoney)).ConfigureAwait(false);
                    return;
                }
            }

[gemini-code-assist]

There are two issues here:

1. Thread Safety: The plugin instance is shared and can be executed concurrently by multiple players. Mutating the instance property this.Configuration using ??= during command execution is not thread-safe. Instead, use a local fallback variable.
2. Null Safety: player.SelectedCharacter can be null (as seen in other parts of the codebase where it is guarded). Accessing it with ! without a guard can lead to a NullReferenceException.

We can resolve both by guarding player.SelectedCharacter at the start of the method and using a local fallback for the configuration.

        var selectedCharacter = player.SelectedCharacter;
        if (selectedCharacter is null)
        {
            return;
        }

        var configuration = this.Configuration ?? (PKClearConfiguration)this.CreateDefaultConfig();
        var isGameMaster = selectedCharacter.CharacterStatus >= CharacterStatus.GameMaster;

[gemini-code-assist]

If a regular player attempts to clear another player's PK status by typing /pkclear <other_character>, the command currently ignores the argument and silently clears the calling player's own PK status (deducting their Zen) instead of failing or showing an error. This can lead to accidental Zen loss and confusion.

Consider adding a check to ensure regular players cannot specify a different character name.

        else
        {
            if (!configuration.AllowRegularPlayers)
            {
                await player.ShowBlueMessageAsync("This command is only available to Game Masters.").ConfigureAwait(false);
                return;
            }

            if (!string.IsNullOrEmpty(arguments.CharacterName) && !arguments.CharacterName.Equals(player.Name, StringComparison.OrdinalIgnoreCase))
            {
                await player.ShowBlueMessageAsync("You can only clear your own PK status.").ConfigureAwait(false);
                return;
            }

            targetPlayer = player;
        }

[gemini-code-assist]

The message "This command is only available to Game Masters." is hardcoded in English. To support internationalization (i18n) and adhere to the project's standards, this should be localized using ShowLocalizedBlueMessageAsync with a corresponding key from PlayerMessage.

[gemini-code-assist]

The messages "{targetCharacter.Name} is not a Player Killer." and "You are not a Player Killer." are hardcoded in English. To support internationalization (i18n) and adhere to the project's standards, these should be localized using ShowLocalizedBlueMessageAsync with appropriate keys from PlayerMessage.