Description

This mod allows to add a starter kit to the server.

Commands

/starterkit or /sk – gives the player a starter kit (requires the chat privilege; must be executed by a player);
/starterkit update – updates the configuration from the /VintagestoryData/ModConfig/StarterKit.json file on a running server (requires the root privilege);
/starterkit resetall – resets the number of starter kits already received for all players (requires the root privilege). This command also currently deletes the information recorded by the mod before its removal from the server;
/starterkit reset player1, player2, ... – does the same as resetall, but for the specified players (requires the root privilege).

Configuration

ResetOnDeath – (System.Boolean) specifies whether the counter for received sets must be reset upon death;
PermittedReceives – (System.Int32) the number of starter kits each player can receive. A value ≤0 disables the ability to receive starter kits;
Items – (StackInfo[]) information about the item stacks included in the starter kit.

Items in the Items array are added according to the rules for JSON documents. The configuration can only be changed via the config file, but the /starterkit update command allows to apply changes without restarting the server.

Configuration example (each player can receive 2 starter kits, each consisting of one temporal gear, 16 horsetail poultices and a crude bow is only for a hunter):

{
  "ResetOnDeath": false,
  "PermittedReceives": 2,
  "Items": [
    {
      "Code": "game:gear-temporal",
      "Amount": 1
    },
    {
      "Code": "game:poultice-linen-horsetail",
      "Amount": 16
    },
    {
      "Code": "game:bow-crude",
      "Amount": 1,
      "ForClass": "hunter"
    }
  ]
} 

StackInfo model

Code – (System.String) the item code, for example, "game:gear-temporal";
Amount – (System.Int32) the number of items in the stack to be given. A value ≤0 will be ignored;
ForClass – (System.String) the class the item stack is intended for. If not specified, any class will receive the stack;
Attributes – (StackAttribute[]) attributes of the item stack.

StackAttribute model

Type – (System.String) attribute value type;
Key – (System.String) attribute key;
Value – (System.String) attribute string value.

I haven't tested all possible attribute value deviations from the norm, but be careful with them.

{
  "Code": "game:pickaxe-steel",
  "Amount": 1,
  "Attributes": [
    { "Type": "int", "Key": "durability", "Value": "347" }
  ]
}

{
  "Code": "game:book-normal-brickred",
  "Amount": 1,
  "Attributes": [
    { "Type": "string", "Key": "title", "Value": "Book title" },
    { "Type": "string", "Key": "text", "Value": "Book text\nLine 2" },
    { "Type": "string", "Key": "signedby", "Value": "Tulikettu" },
    { "Type": "string", "Key": "signedbyuid", "Value": "gC8QxMPxcegHcHCd7dqwhzhf" }
  ]
}