Skip to content

checkall

Jump to bottom
Shu Hu edited this page Mar 12, 2024 · 1 revision

/checkall Command

The /checkall command is used to check and clean all player balances according to the configuration settings. This command is essential for maintaining the server's economy and ensuring inactive players are taxed appropriately.

Permission

To use the /checkall command, the player must have the ecobalancer.admin permission.

Configuration

The behavior of the /checkall command is influenced by several settings in the config.yml file:

  1. check-schedule: This section defines when the automatic balance checks and deductions occur.
  • type: Specifies the frequency of the checks (daily, weekly, or monthly).
  • days-of-week: If the type is set to 'weekly', this list specifies the days of the week when the checks will run (1 = Sunday, 2 = Monday, etc.).
  • dates-of-month: If the type is set to 'monthly', this list specifies the dates of the month when the checks will run.
  1. deduct-based-on-time: If set to true, the plugin will deduct player balances based on their inactivity time.
  • inactive-days-to-deduct: The number of days a player must be inactive before their balance starts being deducted.
  • inactive-days-to-clear: The number of days a player must be inactive before their balance is cleared entirely.
  1. tax-brackets: This section defines the tax rates for different balance thresholds.
  • threshold: The minimum balance for this tax bracket to apply. Use null for no upper limit.
  • rate: The tax rate for this bracket (e.g., 0.01 = 1% tax).
  1. tax-account: If set to true, the plugin will store the deducted funds in a separate account.
  • tax-account-name: The name of the account where the deducted funds will be stored.

Usage

To manually run the balance check and cleanup process, simply execute the /checkall command in the game or the server console. The plugin will then process all player balances according to the configuration settings.

Please note that this command may cause significant changes to player balances, so it should be used with caution. It is recommended to inform players about the tax system and the potential consequences of inactivity to maintain transparency and fairness on the server.

Clone this wiki locally