Skufy Ranks

What the mod does

Installation

1. Copy the @Skufy_Ranks folder to the server and add it to the -mod= launch parameter (the same for clients, or through the Steam Workshop).
2. Put the Skufy.bikey key from @Skufy_Ranks/Keys into the server's keys folder.
3. No other mods are needed: Community Framework is not required.
4. To have books in the loot, add the lines of @Skufy_Ranks/ServerFiles/types.xml to your mission's db/types.xml (14 books). Without it books only come from the admin panel or as rewards.
5. Start the server once — the mod creates profiles/Skufy_Ranks with every file and ready content: ranks, quests, restrictions, books.
6. Put your SteamID64 into Admins (see Admins), restart the server, join and press Num 1 + Num 4 — or the ADMIN button in the rank menu (O).

Admins

The admin panel opens only for players whose SteamID64 (17 digits, starts with 7656119) is in the Admins list of Settings.json.

"Admins": [
    "76561198000000001",
    "76561198000000002"
],

• Adding admins is easier in the panel itself: SETTINGS → RANK ADMINS (SteamID64, comma separated).
• Rank restrictions do not apply to admins — unless AdminsRestricted is on.
• In single player (offline) every player is an admin: handy for tests.

Config files

Editing by hand

1. The admin panel is the easiest way: no broken commas or quotes, and every player gets the changes at once.
2. The files are read when the server starts. Edit them by hand on a stopped server: saving from the panel overwrites the files.
3. This is JSON: strings in double quotes, commas between elements, no comma after the last one, no comments. Switches are 1 or 0.
4. Every ID (ranks, quests, categories, restrictions) is Latin letters, digits, _ and -. Other files refer to IDs: rename in the panel — it renames the references too.
5. If a file cannot be read, the server log has a line [Skufy_Ranks] Quests.json is broken… with the reason, and a .broken copy appears next to it. Delete the file entirely and the mod creates it again with the default content.

How a rank grows

• XP always adds up and is never lost: the rank is the highest one whose XP threshold is reached and whose exams (and the exams of every lower rank) are done.
• If the next rank needs an exam, XP keeps growing and the rank window says the exam is needed. Once the exam is done the rank is given at once — sometimes several steps up.
• The rank reward is given once — when the rank is reached for the first time. If it does not fit into the inventory it appears on the ground at the player's feet.
• The whole server is told about the new rank (NoAnnounce turns it off), the player sees a rank-up banner.
• The death penalty (DeathPenalty, %) takes a part of the XP earned inside the current rank. A rank is never lost on death.
• Changed the thresholds or the order of ranks — each player's rank is recounted on their next login, without new rewards.

Default XP

Ranks · Ranks.json

The order of the Ranks list is the ladder from the bottom up. The first rank always starts at 0 XP, each next one must need more than the previous one (if not, the mod raises its threshold by 1).

{
    "Id": "sergeant",
    "Name": "Сержант",
    "NameEn": "Sergeant",
    "Glyph": "ins_chev3r1",
    "Hex": "34D1BF",
    "Xp": 3100,
    "Desc": "Сдал аттестацию. Допущен к армейскому оружию.",
    "DescEn": "Passed the exam. Cleared for military rifles.",
    "Quests": [ "exam_sergeant" ],
    "Rewards": [
        { "Item": "Binoculars", "Count": 1 },
        { "Item": "Ammo_762x39", "Count": 40 }
    ]
}

The default ladder

Insignia keys (Glyph)

Quests · Quests.json

The file has two lists: Categories — the journal sections, and Quests — the quests themselves. By default there are 52 quests in 9 categories, 4 of them are rank exams.

Categories

Quest fields

Goals

Example

{
    "Id": "patrol_cherno",
    "Title": "Патруль Черногорска",
    "TitleEn": "Chernogorsk patrol",
    "Desc": "Зачистите порт и отметьтесь на маяке.",
    "DescEn": "Clear the port and check in at the lighthouse.",
    "CatId": "combat",
    "Glyph": "",
    "MinRank": "private",
    "MaxRank": "",
    "MapName": "chernarusplus",
    "Xp": 400,
    "Repeat": 1,
    "Cooldown": 120,
    "TimeLimit": 60,
    "Disabled": 0,
    "Requires": [ "c_first" ],
    "Goals": [
        { "Kind": 0, "Count": 20, "Targets": [], "With": [], "Label": "", "LabelEn": "",
          "PosX": 7100, "PosZ": 2500, "Radius": 400 },
        { "Kind": 6, "Count": 1, "Targets": [], "With": [], "Label": "Маяк", "LabelEn": "Lighthouse",
          "PosX": 7480, "PosZ": 2290, "Radius": 40 }
    ],
    "Rewards": [ { "Item": "Ammo_762x39", "Count": 60 } ]
}

How a quest goes

• A player runs at most MaxActive quests at once (5 by default; quests ready to hand in count too).
• "Have on you", "Bring and hand in" and "Visit a place" are checked on their own every couple of seconds.
• The player claims the reward in the menu. With AutoClaim it is given as soon as the goals are done.
• A quest can be abandoned — the progress is reset.

Restrictions · Rules.json

Each restriction blocks something for players below the given rank. A blocked action is not even offered in game, and the server checks everything again — a modified client gains nothing. The player sees a hint telling from which rank it opens.

Default restrictions

{
    "Id": "tisy",
    "Title": "Военная база Тисы",
    "TitleEn": "Tisy military base",
    "Kind": 10,
    "MinRank": "sergeant",
    "Disabled": 0,
    "Classes": [],
    "Actions": [],
    "Zoned": 1,
    "PosX": 1650,
    "PosZ": 14000,
    "Radius": 500,
    "Msg": "",
    "MsgEn": ""
}

Books · Books.json

A book is taken into hands and studied: a full reading animation for Seconds seconds, then the XP. The item tooltip shows how much XP it gives this player or why it cannot be studied yet.

• The pause between any two books of one player is BookCooldown (minutes) in Settings.json.
• For a "Study a book" goal: Skufy_RK_Manual_Base — any manual, Skufy_RK_Read_Base — any library book.
• Loot frequency is in @Skufy_Ranks/ServerFiles/types.xml: library books are more common (towns, villages, schools, offices), manuals rarer, the top volumes rarest.

Settings.json

General settings. Under the default value is the allowed range: anything outside it is corrected by the mod on load. All of this is on the SETTINGS tab of the admin panel.

{
    "Version": 1,
    "Admins": [ "76561198000000001" ],
    "MaxActive": 5,
    "AutoClaim": 0,
    "DeathPenalty": 0,
    "NoHud": 0,
    "NoTop": 0,
    "TopSize": 20,
    "NoAnnounce": 0,
    "AdminsRestricted": 0,
    "NoHints": 0,
    "BookCooldown": 0,
    "ZoneWarn": 60,
    "XpZombie": 2,
    "XpAnimal": 5,
    "XpPlayer": 20,
    "XpCraft": 1,
    "XpBuild": 2,
    "XpHarvest": 2,
    "XpFish": 3,
    "PlayMinutes": 15,
    "PlayXp": 10
}

Player profiles

Each player is a file Players/<SteamID64>.json. The server writes it; changing XP and rank is easier on the PLAYERS tab of the admin panel — it works for offline players too.

Admin panel (Num 1 + Num 4)

Opened with the key combination or the ADMIN button in the rank menu. At the bottom are SAVE and REVERT: a save is written to the files and sent to every player at once, no restart needed.

How players play

The rank menu — O

• PROFILE — rank badge and name, XP bar, the next rank and the exam it needs, statistics, active quests, what gives XP.
• QUESTS — filters "active / available / completed / all", search, categories, the quest card with goals, reward and conditions. A quest can be taken, abandoned and pinned — up to 3 quests are shown on screen.
• RANKS — the whole ladder: thresholds, exams, rewards and what each rank opens.
• ACCESS — every restriction of the server: what is open, what is closed and from which rank.
• LEADERS — the best players of the server and your place.

On screen

• The rank window: rank, XP bar with a flash on every gain, what is left to the next rank and the pinned quests with the distance to their point. It hides in menus, after death and when the game HUD is off.
• A player can move the window in their own Skufy_Ranks_Client.json (DayZ profile folder): Corner — 0 top left, 1 top right, 2 bottom left, 3 bottom right; Hidden: 1 hides the window.
• Notifications: XP, goals done, rewards, a quest failed on time, blocks with the rank needed, closed zones.

Troubleshooting

The admin panel does not open

Check that your SteamID64 (17 digits) is in Admins of Settings.json and restart the server. Check the keys in "Settings → Controls → Skufy Ranks". The ADMIN button in the rank menu is shown to admins only.

No books in the loot

Add the lines of @Skufy_Ranks/ServerFiles/types.xml to the mission's db/types.xml and restart the server. You can also give books to yourself in the admin panel: MANUALS → TAKE.

A book cannot be studied

Hover the book in the inventory — the tooltip tells why: another rank is needed, the book was already studied ("Once"), the BookCooldown pause has not passed or the book is disabled. A book is studied in hands.

Enough XP but the rank does not grow

The next rank needs an exam — the rank window says so. Complete the exam quest from the "Rank exams" category and the rank is given at once.

Changed the JSON but nothing changed in game

The files are read when the server starts. Edit them on a stopped server — or change things in the admin panel, where changes apply at once. Saving from the panel overwrites the files.

My ranks or quests are gone after an edit

The file has an error: the mod runs on the defaults and leaves a .broken copy, the log has a line [Skufy_Ranks] … is broken with the reason. Fix the error in the copy, rename it back and restart the server.

A player does not see a quest

Check MinRank / MaxRank (a quest with an upper limit is hidden from higher ranks), Requires (other quests must be done first), MapName (a quest for another map) and Disabled.

A restriction does not work on me

You are an admin: restrictions do not apply to admins unless AdminsRestricted is on. Turn it on to test, or join as a non-admin.

I want everything back as it was

Delete the file (Ranks.json, Quests.json, Rules.json, Books.json) on a stopped server — on start the mod creates it again with the default content. Player profiles live separately in Players/.