Skip to content

Commit ff9ad54

Browse files
Update README.md config examples
1 parent 480b78d commit ff9ad54

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -69,16 +69,19 @@ You can customize the plugin to your liking by editing the `config.yml`, `upgrad
6969
# https://docs.advntr.dev/minimessage/format.html
7070
# With these, you can also add HEX colors, gradients, hover and click events, etc
7171

72-
# If set to true, LifeStealZ will check for updates and let you know if there's a newer version
72+
# If set to true, CookieClickerZ will check for updates and let you know if there's a newer version
7373
checkForUpdates: true
7474

7575
# Set the language to any code found in the "lang" folder (don't add the .yml extension)
76-
# You can add your own language files. Use https://github.com/KartoffelChipss/LifeStealZ/tree/main/src/main/resources/lang/en-US.yml as a template
77-
# If you want to help translating the plugin, please refer to this article: https://lsz.strassburger.dev/contributing/localization
76+
# You can add your own language files. Use https://github.com/KartoffelChipss/CookieClickerZ/tree/main/src/main/resources/lang/en-US.yml as a template
7877
lang: "en-US"
7978

8079
# The the cookie name
81-
cookieName: "&7Cookies"
80+
# This is to conveniently change the cookie name in most messages. You will probably also want to adjust some other messages in your respective language file.
81+
cookieName: "Cookies"
82+
83+
# The item that will be displayed in the middle of the main gui
84+
mainItem: "COOKIE"
8285

8386
offlineCookies:
8487
# If set to true, players will earn cookies while they are offline
@@ -87,7 +90,7 @@ offlineCookies:
8790
joinMessage: true
8891

8992
# Wether or not to show a hologram above the clicker block
90-
# You need to have DecentHolograms installed for this to work:
93+
# You need to have DecentHolograms or FancyHolograms installed for this to work (although DecentHolograms is recommended):
9194
# https://modrinth.com/plugin/decentholograms
9295
# You can change the content of the hologram in the language file
9396
hologram: true
@@ -145,23 +148,24 @@ anticheat:
145148
commands:
146149
# - "kick %player% &cYou are not moving!"
147150

151+
148152
# === EXPERT ===
149153
# This section is only relevant if you are an expert and know what you are doing
150154

151155
playerCache:
152-
# If set to true, the plugin will use a cache to store player data
153-
enabled: true
154-
# The amount of time (in seconds) the plugin will wait before saving the whole cache to the database
155-
saveInterval: 60
156-
# The maximum amount of players that will be stored in the cache
157-
maxSize: 1000
156+
# If set to true, the plugin will use a cache to store player data
157+
enabled: true
158+
# The amount of time (in seconds) the plugin will wait before saving the whole cache to the database
159+
saveInterval: 60
160+
# The maximum amount of players that will be stored in the cache
161+
maxSize: 1000
158162

159163

160164
# === STORAGE ===
161165

162166
storage:
163167
# The type of storage to use. You have the following options:
164-
# "SQLite"
168+
# "SQLite" | "MySQL"
165169
type: "SQLite"
166170

167171
# This section is only relevant if you use a remote database
@@ -211,6 +215,7 @@ wooden_pickaxe:
211215
# If set to true, the plugin will enable the prestige system
212216
enabled: true
213217

218+
# You can add or remove as many prestige levels as you want. (Everything beyond the 29th level will be ignored)
214219
levels:
215220
1:
216221
# The name of the prestige level

0 commit comments

Comments
 (0)