Configuration Structure


Overview of Configuration Structure
The configuration is divided into several main parts:

1. DCEveryDayCase
   The root section containing all plugin settings.
   
   
2. case_settings
   A subsection with settings related to daily cases.
   
   
3. debug
   A parameter to enable or disable debug mode.
   
   
4. Languages
   Language selection for messages.

Detailed Description of Configuration Parameters
1. case_settings
This section contains settings related to the daily cases logic. Below are all the parameters in this section:

case_name

• Type: String
  
  
• Default Value: "DCEveryDayCase"
  
  
• Description: The name of the case used for daily rewards.
  
  
• How it works:
  This parameter defines which case from the DonateCase system will issue keys to players. For example, if you change the value to "MyCustomCase", the plugin will issue keys for a case with that name.
  
  
• Example Usage:
  If you have multiple cases in the game, you can specify a particular one, such as "DailyRewardCase".

keys_amount

• Type: Integer (int)
  
  
• Default Value: 1
  
  
• Description: The number of keys a player receives for the daily reward.
  
  
• How it works:
  Determines how many keys a player gets each time they claim their daily reward. For example, if set to 2, the player will receive 2 keys.
  
  
• Example Usage:
  If you want to give out more keys (e.g., 3), just change this value.

claim_cooldown

• Type: Long integer (long)
  
  
• Default Value: 86400 (24 hours in seconds)
  
  
• Description: Time in seconds between possible claims for a daily reward.
  
  
• How it works:
  Sets the interval at which a player can claim their reward again. For example, 86400 seconds equals 24 hours.
  
  
• Example Usage:
  If you want the reward to be available every 12 hours, set it to 43200.

new_player_choice

• Type: String
  
  
• Default Value: "case"
  
  
• Possible Values: "case" or "timer"
  
  
• Description: Defines the behavior of the plugin for new players (those joining the game for the first time).
  
  
• How it works:
  • case: New players get a key immediately upon first login, and the timer starts after they open the case.
    
    
  • timer: New players do not get a key immediately, but the daily reward timer starts right away.
• Example Usage:
  If you want new players to wait 24 hours before their first reward, choose "timer".

turn_off_daily_case_logic

• Type: Boolean
  
  
• Default Value: false
  
  
• Description: Enables or disables the logic of daily cases.
  
  
• How it works:
  If set to true, the plugin will not issue keys or start timers automatically. However, if new_player_choice is set to "case", new players will still receive a key upon login, but without a timer.
  If set to false, the usual daily case logic will work.
  
  
• Example Usage:
  Set it to true if you want to temporarily disable daily rewards.

2. debug

• Type: Boolean
  
  
• Default Value: false
  
  
• Description: Enables or disables debug mode.
  
  
• How it works:
  If set to true, the plugin will output additional messages to the console for tracking actions (e.g., saving time to the database or issuing keys).
  
  
• Example Usage:
  Enable it (true) if you need to diagnose issues with the plugin.

3. Languages

• Type: String
  
  
• Default Value: "en_US"
  
  
• Description: Language code for messages shown to players.
  
  
• How it works:
  Determines which language file is loaded from the lang folder. For example, "en_US" loads the en_US.yml file.
  
  
• Example Usage:
  Change it to "ru_RU" if you want to use Russian (provided the ru_RU.yml file exists).

Supported Languages:

• uk_UA: Ukrainian (uk_UA.yml)
  
  
• ru_RU: Russian (ru_RU.yml)
  
  
• en_US: English (en_US.yml)

These language files are used for player-facing messages based on the Languages configuration parameter. If a specific language file is missing, the plugin defaults to en_US.

How the Parameters Affect the Plugin
Daily Case Behavior

• case_name: Defines which case players will open with the keys they receive.
  
  
• keys_amount: Controls how many keys are issued at a time.
  
  
• claim_cooldown: Regulates the frequency of rewards issuance.
  
  
• new_player_choice: Customizes the new player experience (immediate key or waiting time).
  
  
• turn_off_daily_case_logic: Allows you to completely disable automatic key issuance and timers.

Debugging and Messages

• debug: Helps developers or admins track the plugin’s actions.
  
  
• Languages: Provides localization of messages for players.

Messages (From Language Files)
Although messages are not part of the config.yml, they are related to the Languages parameter and are loaded from the appropriate language file (e.g., en_US.yml). Here's a list of some of the messages you can modify:

• available: Message when the case is available for claiming.
  
  
• remaining: Shows the time until the next reward.
  
  
• log_console_give_key: Console log when a key is issued.
  
  
• info_placeholder: Message for placeholders if information is unavailable.
  
  
• case_granted_on: Message when notifications are enabled.
  
  
• case_granted_off: Message when notifications are disabled.
  
  
• only_for_players: Message when the command is run by a non-player.
  
  
• no_permission: Message about lack of permissions.
  
  
• case_ready: Message when the case is ready for claiming.

These messages can be customized in language files, making the plugin flexible for different languages.

Conclusion
The configuration of your DCEveryDayCase plugin allows you to customize the following aspects:

• Which case and how many keys are issued (case_name, keys_amount).
  
  
• How often rewards are issued (claim_cooldown).
  
  
• How new players are handled (new_player_choice).
  
  
• Whether to enable daily case logic (turn_off_daily_case_logic).
  
  
• Whether to display debug logs (debug).
  
  
• Which language to use for messages (Languages).

Each parameter has a clear purpose and is integrated into the plugin’s code to provide flexibility and ease of use. If you have any additional questions or need example configurations, feel free to ask!