Skip to content

Commit 930969a

Browse files
imstuckbroKrigsgaldrnet
authored andcommitted
Misc/Config: Config file option description grammar improvements (TrinityCore/TrinityCore#31756)
1 parent 85502de commit 930969a

2 files changed

Lines changed: 21 additions & 20 deletions

File tree

src/server/authserver/authserver.conf.dist

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
# LogsDir
3737
# Description: Logs directory setting.
3838
# Important: LogsDir needs to be quoted, as the string might contain space characters.
39-
# Logs directory must exists, or log file creation will be disabled.
39+
# Logs directory must exist, or log file creation will be disabled.
4040
# Default: "" - (Log files will be stored in the current path)
4141

4242
LogsDir = ""
@@ -84,7 +84,8 @@ UseProcessors = 0
8484
#
8585
# ProcessPriority
8686
# Description: Process priority setting for Windows and Linux based systems.
87-
# Details: On Linux, a nice value of -15 is used. (requires superuser). On Windows, process is set to HIGH class.
87+
# Details: On Linux, a nice value of -15 is used (requires superuser).
88+
# On Windows, process is set to HIGH class.
8889
# Default: 0 - (Normal)
8990
# 1 - (High)
9091

@@ -160,7 +161,7 @@ SourceDirectory = ""
160161
# MySQLExecutable
161162
# Description: The path to your MySQL CLI binary.
162163
# If the path is left empty, built-in path from cmake is used.
163-
# Example: "C:/Program Files/MySQL/MySQL Server 5.6/bin/mysql.exe"
164+
# Example: "C:/Program Files/MySQL/MySQL Server 8.0/bin/mysql.exe"
164165
# "mysql.exe"
165166
# "/usr/bin/mysql"
166167
# Default: ""
@@ -208,7 +209,7 @@ LoginDatabaseInfo = "127.0.0.1;3306;trinity;trinity;auth"
208209

209210
#
210211
# LoginDatabase.WorkerThreads
211-
# Description: The amount of worker threads spawned to handle asynchronous (delayed) MySQL
212+
# Description: The number of worker threads spawned to handle asynchronous (delayed) MySQL
212213
# statements. Each worker thread is mirrored with its own connection to the
213214
# MySQL server and their own thread on the MySQL server.
214215
# Default: 1
@@ -217,7 +218,7 @@ LoginDatabase.WorkerThreads = 1
217218

218219
#
219220
# LoginDatabase.SynchThreads
220-
# Description: The amount of MySQL connections spawned to handle.
221+
# Description: The number of MySQL connections spawned to handle.
221222
# Default: 1 - (LoginDatabase.WorkerThreads)
222223

223224
LoginDatabase.SynchThreads = 1
@@ -293,7 +294,7 @@ Updates.AllowRehash = 1
293294

294295
#
295296
# Updates.CleanDeadRefMaxCount
296-
# Description: Cleans dead/ orphaned references that occur if an update was removed or renamed and edited in one step.
297+
# Description: Cleans dead/orphaned references that occur if an update was removed or renamed and edited in one step.
297298
# It only starts the clean up if the count of the missing updates is below or equal the Updates.CleanDeadRefMaxCount value.
298299
# This way prevents erasing of the update history due to wrong source directory state (maybe wrong branch or bad revision).
299300
# Disable this if you want to know if the database is in a possible "dirty state".

src/server/worldserver/worldserver.conf.dist

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ DataDir = "."
7979
# LogsDir
8080
# Description: Logs directory setting.
8181
# Important: LogsDir needs to be quoted, as the string might contain space characters.
82-
# Logs directory must exists, or log file creation will be disabled.
82+
# Logs directory must exist, or log file creation will be disabled.
8383
# Default: "" - (Log files will be stored in the current path)
8484

8585
LogsDir = ""
@@ -115,7 +115,7 @@ CharacterDatabaseInfo = "127.0.0.1;3306;trinity;trinity;characters"
115115
# LoginDatabase.WorkerThreads
116116
# WorldDatabase.WorkerThreads
117117
# CharacterDatabase.WorkerThreads
118-
# Description: The amount of worker threads spawned to handle asynchronous (delayed) MySQL
118+
# Description: The number of worker threads spawned to handle asynchronous (delayed) MySQL
119119
# statements. Each worker thread is mirrored with its own connection to the
120120
# MySQL server and their own thread on the MySQL server.
121121
# Default: 1 - (LoginDatabase.WorkerThreads)
@@ -130,7 +130,7 @@ CharacterDatabase.WorkerThreads = 1
130130
# LoginDatabase.SynchThreads
131131
# WorldDatabase.SynchThreads
132132
# CharacterDatabase.SynchThreads
133-
# Description: The amount of MySQL connections spawned to handle.
133+
# Description: The number of MySQL connections spawned to handle.
134134
# Default: 1 - (LoginDatabase.SynchThreads)
135135
# 1 - (WorldDatabase.SynchThreads)
136136
# 2 - (CharacterDatabase.SynchThreads)
@@ -205,7 +205,7 @@ SourceDirectory = ""
205205
# MySQLExecutable
206206
# Description: The path to your MySQL CLI binary.
207207
# If the path is left empty, built-in path from cmake is used.
208-
# Example: "C:/Program Files/MySQL/MySQL Server 5.6/bin/mysql.exe"
208+
# Example: "C:/Program Files/MySQL/MySQL Server 8.0/bin/mysql.exe"
209209
# "mysql.exe"
210210
# "/usr/bin/mysql"
211211
# Default: ""
@@ -239,7 +239,7 @@ UseProcessors = 0
239239
#
240240
# ProcessPriority
241241
# Description: Process priority setting for Windows and Linux based systems.
242-
# Details: On Linux, a nice value of -15 is used. (requires superuser).
242+
# Details: On Linux, a nice value of -15 is used (requires superuser).
243243
# On Windows, process is set to HIGH class.
244244
# Default: 0 - (Normal)
245245
# 1 - (High)
@@ -1140,17 +1140,17 @@ MaxRecruitAFriendBonusDistance = 100
11401140
#
11411141
# MinQuestScaledXPRatio
11421142
# Description: Min ratio of experience that a quest can grant when player level scaling is factored.
1143-
# Example: 50 (No less than 50% experience granted from a lower leveled quests completion)
1143+
# Example: 50 (No less than 50% experience granted from a lower-level quests completion)
11441144
# 100 (Quests always grant full experience upon completion)
11451145
# Default: 0 - (Quests too low may grant no experience)
11461146

11471147
MinQuestScaledXPRatio = 0
11481148

11491149
#
11501150
# MinCreatureScaledXPRatio
1151-
# Description: Min ratio of experience that a creature kill can grant when player level scaling is factored. This
1152-
# will also allow spell procs to trigger, such as Drain Soul, if > 0 and exp is grantable.
1153-
# Example: 50 (No less than 50% experience granted from a lower leveled creature kill)
1151+
# Description: Min ratio of experience that a creature kill can grant when player level scaling is factored.
1152+
# This will also allow spell procs to trigger, such as Drain Soul, if > 0 and experience is grantable.
1153+
# Example: 50 (No less than 50% experience granted from a lower-level creature kill)
11541154
# 100 (Creature kills always grant full experience upon kill)
11551155
# Default: 0 - (Creatures too low may grant no experience)
11561156

@@ -1299,7 +1299,7 @@ DBC.EnforceItemAttributes = 1
12991299

13001300
#
13011301
# AccountInstancesPerHour
1302-
# Description: Controls the max amount of different instances player can enter within hour.
1302+
# Description: Controls the maximum number of individual instances player can enter per hour.
13031303
# Default: 5
13041304

13051305
AccountInstancesPerHour = 5
@@ -1418,7 +1418,7 @@ Updates.AllowRehash = 1
14181418

14191419
#
14201420
# Updates.CleanDeadRefMaxCount
1421-
# Description: Cleans dead/ orphaned references that occur if an update was removed or renamed and edited in one step.
1421+
# Description: Cleans dead/orphaned references that occur if an update was removed or renamed and edited in one step.
14221422
# It only starts the clean up if the count of the missing updates is below or equal the Updates.CleanDeadRefMaxCount value.
14231423
# This way prevents erasing of the update history due to wrong source directory state (maybe wrong branch or bad revision).
14241424
# Disable this if you want to know if the database is in a possible "dirty state".
@@ -1605,12 +1605,12 @@ AllowTwoSide.Interaction.Guild = 0
16051605
# AllowTwoSide.Interaction.Auction
16061606
# Description: Allow auctions between factions.
16071607
# This results in all auctions being handled as if placed in the neutral
1608-
# auction house and will intentionally lock acces to the Horde and Alliance AH.
1608+
# auction house and will intentionally lock access to the Horde and Alliance AH.
16091609
# Deposit fee and auction cut values will be taken from neutral auction house.
16101610
# If used in combination with the AH-Bot, settings should be set for neutral
16111611
# auction house only.
16121612
#
1613-
# Warning: changing this in production results in players loosing access to their
1613+
# Warning: changing this in production results in players losing access to their
16141614
# already placed auctions in the faction houses - these auctions will expire after
16151615
# their regular timings.
16161616
# Default: 0 - (Disabled)
@@ -3832,7 +3832,7 @@ AuctionHouseBot.Buyer.ChanceFactor = 2
38323832

38333833
#
38343834
# AuctionHouseBot.Buyer.Baseprice.QUALITY
3835-
# Description: Base sell prices in copper for non priced items for each quality.
3835+
# Description: Base sell prices in copper for non-priced items for each quality.
38363836
# The default values are based on average item prices of each quality.
38373837
# Defaults: Gray 3504
38383838
# White 5429

0 commit comments

Comments
 (0)