Update docs and example on aliases.

peterekepeter · Nov 19, 2023 · bb79769 · bb79769
1 parent 3da0420
commit bb79769
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 11 deletions.
diff --git a/ReleaseFiles/MVE2h/System/MVE_Config.ini b/ReleaseFiles/MVE2h/System/MVE_Config.ini
@@ -43,8 +43,8 @@ CustomGame[3]=(bEnabled=True,GameName="Capture the Flag",RuleName="Normal",GameC
 CustomGame[4]=(bEnabled=True,GameName="Capture the Flag",RuleName="InstaGib",GameClass="Botpack.CTFGame",FilterCode="ctf",bHasRandom=True,VotePriority=1.000000,MutatorList="Botpack.InstaGibDM",Settings="",Packages="",TickRate=0,ServerActors="")
 CustomGame[5]=(bEnabled=True,GameName="Capture the Flag",RuleName="Sniper Arena",GameClass="Botpack.CTFGame",FilterCode="ctf",bHasRandom=True,VotePriority=1.000000,MutatorList="Botpack.SniperArena",Settings="",Packages="",TickRate=0,ServerActors="")
 CustomGame[6]=(bEnabled=True,GameName="Capture the Flag",RuleName="Rocket Arena",GameClass="Botpack.CTFGame",FilterCode="ctf",bHasRandom=True,VotePriority=1.000000,MutatorList="Botpack.RocketArena",Settings="",Packages="",TickRate=0,ServerActors="")
-CustomGame[7]=(bEnabled=True,GameName="Capture the Flag",RuleName="LowGrav Sniper Arena",GameClass="Botpack.CTFGame",FilterCode="ctf",bHasRandom=True,VotePriority=1.000000,MutatorList="BotPack.SniperArena,Botpack.LowGrav",Settings="",Packages="",TickRate=0,ServerActors="")
-CustomGame[8]=(bEnabled=True,GameName="Capture the Flag",RuleName="LowGrav Rocket Arena",GameClass="Botpack.CTFGame",FilterCode="ctf",bHasRandom=True,VotePriority=1.000000,MutatorList="Botpack.RocketArena,Botpack.LowGrav",Settings="",Packages="",TickRate=0,ServerActors="")
+CustomGame[7]=(bEnabled=True,GameName="Capture the Flag",RuleName="LowGrav Sniper Arena",GameClass="Botpack.CTFGame",FilterCode="ctf",bHasRandom=True,VotePriority=1.000000,MutatorList="<lgsniper>",Settings="",Packages="",TickRate=0,ServerActors="")
+CustomGame[8]=(bEnabled=True,GameName="Capture the Flag",RuleName="LowGrav Rocket Arena",GameClass="Botpack.CTFGame",FilterCode="ctf",bHasRandom=True,VotePriority=1.000000,MutatorList="<lgrocket>",Settings="",Packages="",TickRate=0,ServerActors="")
 CustomGame[9]=(bEnabled=True,GameName="Deathmatch",RuleName="Normal",GameClass="Botpack.DeathMatchPlus",FilterCode="dm",bHasRandom=True,VotePriority=1.000000,MutatorList="",Settings="FragLimit=15,TimeLimit=5",Packages="",TickRate=0,ServerActors="")
 CustomGame[10]=(bEnabled=True,GameName="Deathmatch",RuleName="InstaGib",GameClass="Botpack.DeathMatchPlus",FilterCode="dm",bHasRandom=True,VotePriority=1.000000,MutatorList="Botpack.InstaGibDM",Settings="FragLimit=15,TimeLimit=5",Packages="",TickRate=0,ServerActors="")
 CustomGame[11]=(bEnabled=True,GameName="Deathmatch",RuleName="Rocket Arena",GameClass="Botpack.DeathMatchPlus",FilterCode="dm",bHasRandom=True,VotePriority=1.000000,MutatorList="Botpack.RocketArena",Settings="FragLimit=15,TimeLimit=5",Packages="",TickRate=0,ServerActors="")
@@ -136,8 +136,8 @@ CustomGame[96]=(bEnabled=False,GameName="",RuleName="",GameClass="",FilterCode="
 CustomGame[97]=(bEnabled=False,GameName="",RuleName="",GameClass="",FilterCode="",bHasRandom=True,VotePriority=1.000000,MutatorList="",Settings="",Packages="",TickRate=0,ServerActors="")
 CustomGame[98]=(bEnabled=False,GameName="",RuleName="",GameClass="",FilterCode="",bHasRandom=True,VotePriority=1.000000,MutatorList="",Settings="",Packages="",TickRate=0,ServerActors="")
 CustomGame[99]=(bEnabled=False,GameName="",RuleName="",GameClass="",FilterCode="",bHasRandom=True,VotePriority=1.000000,MutatorList="",Settings="",Packages="",TickRate=0,ServerActors="")
-Aliases[0]=
-Aliases[1]=
+Aliases[0]=<lgsniper>=BotPack.SniperArena,Botpack.LowGrav
+Aliases[1]=<lgrocket>=BotPack.RocketArena,Botpack.LowGrav
 Aliases[2]=
 Aliases[3]=
 Aliases[4]=

diff --git a/docs/feature-documentation.md b/docs/feature-documentation.md
@@ -6,6 +6,34 @@
  - **MAX** maps: 4096
  - **MAX** gametypes: 100
 
+## Configuration reuse via aliases
+
+When configuring a lot of gametypes you'll notice that you're repeating the 
+same configuration over and over again. You can reduce the repetition by 
+reusing parts of configuration. This can be done using aliases.
+
+Aliases are basically shorthands that get replaced with a longer definition.
+You can reference an alias from the MutatorList.
+
+When the configuration is loaded, the alias will be substituted based on the 
+alias definition. Please note that this is basic text substitution and you 
+will have to ensure that the commas are in the right place after substitution.
+
+```ini
+CustomGame[7]=(GameName="CTF",MutatorList="<lgsniper>",...)
+CustomGame[8]=(GameName="DM",MutatorList="<lgsniper>",...)
+Aliases[0]=<lgsniper>=Botpack.LowGrav,BotPack.SniperArena
+```
+
+The configuration above is same as manually typing out all the mutators as 
+seen in the configuration below:
+
+```ini
+CustomGame[7]=(GameName="CTF",MutatorList="Botpack.LowGrav,BotPack.SniperArena",...)
+CustomGame[8]=(GameName="DM",MutatorList="Botpack.LowGrav,BotPack.SniperArena",...)
+```
+
+Note: not all properties support aliases, but mutators do.
 
 ## Premade lists
 

diff --git a/docs/todo.md b/docs/todo.md
@@ -1,14 +1,14 @@
  - RELOAD can fail, write state to config before reload to prevent infinite crash loop
 
- - populate/patch server mutators string
  - inject CLIENT_VERSION and SERVER_VERSION
  - test the release package with a clean UT99 to see if it works
 
-## Map Groups
+## Map Groups???
 
-In the map list have the maps groupped by section.
-For example BT maps groupped by difficulty.
-Tournament maps groupped by size.
+ - would complicate the UI :(
+ - In the map list have the maps groupped by section.
+ - For example BT maps groupped by difficulty.
+ - Tournament maps groupped by size.
 
 ## Idle Switch
 
@@ -18,8 +18,6 @@ Tournament maps groupped by size.
     ServerIdleAfterMinutes=60
 ```
 
-accept !vote as command, more explicit
-
 ## Priority List
 
 - switch to a default map/gametype when server empty (configurable threshold 5mins 10mins 15mins)