[OFFICIAL] New Rule Changes

[JoeWilcox]

New Ruleset Changes


With this new build, there have been some big changes to how you configure rulesets for a hub. Hopefully this thread will answer what you need to know to get your hub back up and running.

1. Rules.ini is no longer used at all.
2. Rules are now defined in 1 or more JSON files stored in a new directory Saved/Config/Rulesets
3. When the game/server starts up all of the .json files in that directory and read and used to build the list of rules available.
4. Epic default rules are still auto-added, however you can use a JSON file to hide them (I’ll give an example in a second)
5. There is a new console command ExportGameRulesets <filename> that will create a json file in your saved folder with all of the current rule sets.

So let’s look at:

SampleRuleset.json:

{

"rules": [
{
  "uniqueTag": "TestRulet",
  "categories": [
      "Featured"
   ],
  "title": "Just a Test Rule",
  "tooltip": "Oi, go on and get!",
  "description": "Really tho... Get.\n\n<UT.Hub.RulesText_Small>TimeLimit : %TimeLimit% minutes</>\n<UT.Hub.RulesText_Small>Maximum players : %MaxPlayers%</>",
  "mapPrefixes": [],
  "maxMapsInList": 16,
  "defaultMap": "/Game/RestrictedAssets/Maps/WIP/FR-Fort",
  "customMapList": [
       "/Game/RestrictedAssets/Maps/WIP/FR-Fort",
       "/Game/RestrictedAssets/Maps/WIP/FR-Meltdown"
  ],
  "maxPlayers": 8,
  "displayTexture": "Texture2D'/Game/RestrictedAssets/UI/GameModeBadges/GB_Custom.GB_Custom'",
  "gameMode": "/Script/UnrealTournament.UTFlagRunGame",
  "gameOptions": "?Botfill=10",
  "requiredPackages": [],
  "bTeamGame": true,
  "bCompetitiveMatch": false,
  "optionFlags": 65535,
  "bHideFromUI": false
  }

]

}

This will create a custom version of Flag Run. Most of the fields are pretty self-explanatory but there are some I want to point out.


UniqueTag should be free of alphanumeric characters only without spaces or underscores.

mapPrefixes can be used to auto-scan all files with a given prefix into the map list.

requirePackages is the same as the ini version only is json format.

optionFlags shouldn’t be used.

bHideFromUI can be used to make rules that are for different purposes. You can use this feature to hide Epic default rules.

On that note, an example of hiding a Epic rule:


HideDuel.json

{

  "rules": [
    {
      "uniqueTag": "DUEL",
      "bHideFromUI": true
    }
  ]

}

The categories tabs will be auto-created based on the rule sets. Also note that there is no guarantee in the order in which rule sets are loaded.

[zunnie]

Thanks JoeWilcox
One question about prefixes: Can we name map series like "DM-UT99-Mapname-Version.pak" and use "DM-UT99" in the prefix area then? This would definately speed up the process of adding custom (re)makes from Unreal Tournament 99 for example.

PS: Should your example "bHideFromUI" not be true to hide it? Your example says false :P

[JoeWilcox]

Thanks for the catch, I edited my post. You should be able to use the map prefixes that way though admittedly I haven't tried that usage case.

[[PHX]Big_Deal]

Hi
What means
"maxMapsInList": 16, For example you have 30 maps in list, it will take 16 maps from that 30 to vote for? Will that 16 maps change everytime when a vote start or does it take everytime the first 16 maps what it will find for vote or what does this switch? Thx

[MΛuL]

Thanks for the heads up Joe!

[ÐutchSmºke]

Niceness! Highly appreciated Joe!

[JoeWilcox]

Big_Deal;n384517]Hi
What means
"maxMapsInList": 16, For example you have 30 maps in list, it will take 16 maps from that 30 to vote for? Will that 16 maps change everytime when a vote start or does it take everytime the first 16 maps what it will find for vote or what does this switch? Thx

Yes.. you guys should probably leave it at 0.

[Laambo]

Do we need to create this folder (Rulesets) ? as I am not seeing it after first launch and the game/server creating the "Saved" folder/s!?

[Real LoRD.]

i cant find the new "Rulesets" folder, help

[[PHX]Big_Deal]

Just create it and put your xxx.json file inside

[Real LoRD.]

Anyone can upload your custom rulesets please ?

[skandalouz]

Hi,

I'm trying to write a file to disable all default rulesets, but I can't figure out the uniqueTags for Blitz vs AI, Competitive CTF, and Translocator iCTF. Can anyone help me out?
Thanks

Edit: Someone on discord was kind enough to share a file with the default rulesets

[JoeWilcox]

I did say there was a console command that you could use to get all of the installed rulesets.

[Donzi]

...console command...

Did not work on LinuxServers, not tested on WinServers, worked on Win-Client console.

[eggster]

Original post isn't that clear where the ExportGameRuleset's json file ends up. This command saves the running json file client side (Check your client side Saved\Config folder).
Might want to update the post to say this (thanks to the kind folks on Discord for pointing this out to me).