-
Notifications
You must be signed in to change notification settings - Fork 8
/
default_config.yml
95 lines (94 loc) · 4.69 KB
/
default_config.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# The language to translate to if using the `nice_time_delta` and `nice_expiration_date` settings
# Any valid language code shoud work, look here for examples: https://gist.github.com/jacobbubu/1836273
# By default it is English, leave it as `null` unless you want to translate it
language: null
# set to true if you want to test, it will not actually add VIP or message players but will log as if it was
dry_run: false
# The URL of your CRCON
# ex: http://example.com or https://example.com
# ex: http://127.0.0.1:8010/
base_url: ""
discord:
# A list of discord webhooks if you want to use Discord integrations
# Set to a blank list to disable
# ex: webhooks: []
# or a valid YAML sequence of URLs https://learnxinyminutes.com/docs/yaml/
webhooks: []
# {player_count} will display the total number of servers on the player and can be used
# in both the seeding_in_progress_message and seeding_complete_message
seeding_in_progress_message: "Server has reached {player_count} players"
seeding_complete_message: "Server is live!"
player_count_message: "{num_allied_players} - {num_axis_players}"
# A list of player counts to announce when the total players reachers it
# Set to a blank list to disable
# ex: seeding_player_buckets: []
seeding_player_buckets:
- 10
- 20
- 30
# How long to sleep between loops when seeding, no matter how low it's set it can't
# run any faster than the amount of time it takes to make all the network requests
# and process the data
poll_time_seeding: 30
# How long to sleep between loops when the server is seeded, no matter how low it's set it can't
# run any faster than the amount of time it takes to make all the network requests
# and process the data
poll_time_seeded: 300
player_messages:
# The message sent to a player after the server has seeded who has earned VIP
# you can use {vip_reward} and {vip_expiration} as variables, neither or both
# {vip_reward} is the amount of time added to their VIP expiration time in CRCN
# {vip_expiration} is when the players VIP will expire in CRCON
# set to an empty string "" to disable
reward: "Thank you for helping us seed.\n\nYou've been granted {vip_reward} of VIP\n\nYour VIP currently expires: {vip_expiration}"
# The message sent to a player after the server has seeded who did not earn VIP
# The non_vip message will also be sent to players who have VIP that doesn't expire
# set to an empty string "" to disable
non_vip: "Thank you for helping us seed.\n\nThe server is now live and the regular rules apply."
requirements:
# The amount of time (it is the sum of all the categories) that must pass before the server can go back into seeding mode after it has seeded
# This prevents messaging players/posting Discord messages continuously if the server is hovering around
# your player requirements and dips below and goes back to seeding multiple times
# Do note that anyone who joins the server during this buffer window won't earn any rewards if the server
# seeds again before the buffer expires
# Set to all 0s to disable
buffer:
seconds: 0
minutes: 10
hours: 0
# The min/max players per team the server needs to have to count as 'seeding'
min_allies: 0
min_axis: 0
max_allies: 20
max_axis: 20
# Whether the player needs to be online when the seed finishes to be rewarded
online_when_seeded: true
# The minimum amount of time a player needs to join before the seed finishes to be rewarded (it is the sum of all the categories)
minimum_play_time:
seconds: 0
minutes: 5
hours: 0
vip_reward:
# Whether to forward VIP if you use multiple game servers
forward: true
# The name used to add VIP in CRCON if the player isn't currently a VIP
# If the player is a current VIP their existing VIP name is used
# {player_name} is their current in game player name
player_name_not_current_vip: "{player_name} - HLL Seed VIP"
# If set to true (recommended) it will add their earned VIP time in CRCON
# If set to false it will overwrite their CRCON expiration date with the new expiration
cumulative: true
# How long the player earns VIP for helping seed (it is the sum of all the categories)
timeframe:
minutes: 0
hours: 0
days: 1
weeks: 0
# If set to true (recommended) it will use https://humanize.readthedocs.io/en/stable/
# and format VIP rewards nicely (i.e. `24 hours`)
# If set to false it will use Pythons built in formatting, (i.e. 25 hours would show as `1 day, 1:00:00`)
nice_time_delta: yes
# If set to true (recommended) it will use https://humanize.readthedocs.io/en/stable/
# and format dates nicely (i.e. `10 months from now`)
# If set to false it will use ISO dates (i.e. `2024-01-31T17:19:50.947186+00:00`)
nice_expiration_date: yes