[Abandoned] Cosmetic Ranks

Note

Please join the discord if you have any issues or feedback/suggestions

 

Also make sure to always end the match before stopping your server or else changes that you made to player's ranks in the most recent match won't be saved!

 

 

Command Usage

 The mod adds some chat commands to manage the ranks

 

.cr give [username/PlayFabID] [rank]

Manually assigns a rank to a player

 

.cr remove [username/PlayfabID]

Removes the current rank of a player

Note that if the user's rank can be auto-given and the user still meets the auto-give criteria, the rank will be given to the user again

 

.cr reload

Reloads the config file without having to end the match

 

 

Installation

Since this mod is designed to work on the server-side only, the installation steps are a bit different from some other mods

 

1. Download the mod's zip file from this page and extract the PAK-file to ...\Mordhau\Content\CustomPaks

If the CustomPaks folder doesn't exist, create it

 

2. In your Game.ini under [/Script/Mordhau.MordhauGameMode] add SpawnServerActorsOnMapLoad=/CosmeticRanks/RankHandler.RankHandler_C

 

Note that because of this manual installation, the mod will not update automatically

 

 

Dependencies

To use specific features, you'll need to install dependencies:

Playtime Tracker: Required if you want to use the GiveOnPlaytime configuration

Night Toolbox: Required if you want to use the Migrating configuration

 

 

Configuration

Permission configuration is done via the Game.ini:

<pre>[CosmeticRanks] ; The required permission level for using commands. 0 = Player, 1 = Admin, 2 = Custom list ; See below this line for how to make a custom list ; Default is 1. CommandPerm={0/1/2} ; The custom list for the commands if used. An array of PlayFabIDs can be added. CommandUser={PlayFabID}</pre>

 

Ranks are set up via the Ranks.json file located in ...\Mordhau\Saved\PlayerFiles\CosmeticRanks\Ranks.json

The file will be auto-generated upon first start with the mod installed, containing an example configuration

 

Here is an explanation for all the configurable features:

Name The name of the rank that will be used to manually give a rank (required)

Weight The weight of the rank - A player will always only have the rank with the lowest weight that is assigned to him (required)

Prefix The text that will be shown before a player's name (optional)

Suffix The text that will be shown after a player's name (optional)

GiveOnPerm Automatically give the rank to a player with the specifc permssion level - 0 = Player, 1 = Admin (optional)

GiveOnPlaytime Automatically give the rank to a player who has reached the specific playtime in hours. Requires the Playtime Tracker mod to be installed (optional)

Migrating Either true or false. Makes the rank a migrating rank. That means it will automatically be assigned to a random player and will migrate when the owner is killed. It won't migrate to lower weight rank players and it does not overwrite the normal rank. Requires the Night Toolbox mod to be installed (optional)

 

 

Developer Note

The source is available for download here

The source may be outdated but should still work when being used as a dependency

You can use the "Get Rank" and "Set Rank" functions anywhere in your mod to get/set a player's rank