Skip to content

WelcomePack ​

Description ​

WelcomePack delivers a supply chest at the player’s position on request. Players normally claim it once per SteamID. The server stores claims under $profile:AC/Modules/WelcomePack/<SteamID>.json. Superadmins can request it repeatedly.

Configuration ​

Default configuration ​

WelcomePack.json
json
{
    "m_Enable": 0,
    "m_Logging": 1,
    "m_Container": "AC_WelcomePack_SeaChest",
    "m_QuantityMax": 5,
    "m_Items": [
        {
            "m_Class": "Battery9V",
            "m_Chance": 90,
            "m_StackMin": 75,
            "m_StackMax": 100,
            "m_QuantityMax": 1,
            "m_Attachments": []
        },
        {
            "m_Class": "M68Optic",
            "m_Chance": 50,
            "m_StackMin": 0,
            "m_StackMax": 100,
            "m_QuantityMax": 1,
            "m_Attachments": []
        },
        {
            "m_Class": "M68Optic",
            "m_Chance": 25,
            "m_StackMin": 0,
            "m_StackMax": 100,
            "m_QuantityMax": 1,
            "m_Attachments": [
                "Battery9V"
            ]
        },
        {
            "m_Class": "Mag_STANAG_30Rnd",
            "m_Chance": 75,
            "m_StackMin": 50,
            "m_StackMax": 100,
            "m_QuantityMax": 3,
            "m_Attachments": []
        },
        {
            "m_Class": "Mag_AKM_30Rnd",
            "m_Chance": 75,
            "m_StackMin": 50,
            "m_StackMax": 100,
            "m_QuantityMax": 3,
            "m_Attachments": []
        },
        {
            "m_Class": "Mag_FAL_20Rnd",
            "m_Chance": 75,
            "m_StackMin": 50,
            "m_StackMax": 100,
            "m_QuantityMax": 3,
            "m_Attachments": []
        },
        {
            "m_Class": "M4_RISHndgrd",
            "m_Chance": 75,
            "m_StackMin": 0,
            "m_StackMax": 100,
            "m_QuantityMax": 5,
            "m_Attachments": []
        },
        {
            "m_Class": "AK_WoodHndgrd",
            "m_Chance": 75,
            "m_StackMin": 0,
            "m_StackMax": 100,
            "m_QuantityMax": 5,
            "m_Attachments": []
        },
        {
            "m_Class": "M4_OEBttstck",
            "m_Chance": 75,
            "m_StackMin": 0,
            "m_StackMax": 100,
            "m_QuantityMax": 5,
            "m_Attachments": []
        },
        {
            "m_Class": "AK_WoodBttstck",
            "m_Chance": 75,
            "m_StackMin": 0,
            "m_StackMax": 100,
            "m_QuantityMax": 5,
            "m_Attachments": []
        },
        {
            "m_Class": "Fal_FoldingBttstck",
            "m_Chance": 75,
            "m_StackMin": 0,
            "m_StackMax": 100,
            "m_QuantityMax": 5,
            "m_Attachments": []
        },
        {
            "m_Class": "M4_Suppressor",
            "m_Chance": 50,
            "m_StackMin": 0,
            "m_StackMax": 100,
            "m_QuantityMax": 5,
            "m_Attachments": []
        },
        {
            "m_Class": "AK_Suppressor",
            "m_Chance": 50,
            "m_StackMin": 0,
            "m_StackMax": 100,
            "m_QuantityMax": 5,
            "m_Attachments": []
        },
        {
            "m_Class": "M4A1",
            "m_Chance": 40,
            "m_StackMin": 0,
            "m_StackMax": 100,
            "m_QuantityMax": 1,
            "m_Attachments": []
        },
        {
            "m_Class": "AKM",
            "m_Chance": 30,
            "m_StackMin": 0,
            "m_StackMax": 100,
            "m_QuantityMax": 1,
            "m_Attachments": []
        },
        {
            "m_Class": "FAL",
            "m_Chance": 20,
            "m_StackMin": 0,
            "m_StackMax": 100,
            "m_QuantityMax": 1,
            "m_Attachments": []
        }
    ],
    "m_Messages": {
        "m_PackDelivered": "The package has been delivered.",
        "m_AlreadyReceived": "You already purchased the package.",
        "m_WebhookInformation": "Player %PlayerName% received the welcome pack."
    },
    "m_NotificationTime": 10,
    "m_NotificationInChat": 0,
    "m_Webhook": ""
}

Options ​

OptionTypeDescription
m_EnableboolWith 1, enables the module. With 0, disables it.
m_LoggingboolWith 1, logs delivery and repeated-claim messages. With 0, skips those records.
m_ContainerstringExact class of the chest that receives the items.
m_NotificationInChatboolWith 1, sends messages through Chat. With 0, sends notifications.
m_NotificationTimeintNotification duration in seconds when messages are shown outside Chat.
m_QuantityMaxintLimit on item instances per pack.
m_Itemsarray<object>Reward entries for the chest.
m_MessagesobjectClaim and Discord messages.
m_WebhookstringDiscord webhook URL. Leave empty to omit the Discord announcement.

m_Messages ​

OptionTypeDescription
m_AlreadyReceivedstringMessage for players who already claimed a pack.
m_PackDeliveredstringMessage sent when the request reaches the delivery branch.
m_WebhookInformationstringDiscord message. %PlayerName% is replaced by the player name.

m_Items[] ​

OptionTypeDescription
m_ClassstringExact reward item class.
m_ChanceintChance per roll as a percentage.
m_QuantityMaxintMaximum number of instances of this entry per reward draw.
m_StackMinintMinimum percentage of the item’s maximum quantity.
m_StackMaxintMaximum percentage of the item’s maximum quantity.
m_Attachmentsarray<string>Item attachment classes.

Types ​

types.xml
xml
<type name="AC_WelcomePack_SeaChest">
    <lifetime>3888000</lifetime>
    <flags count_in_cargo="0" count_in_hoarder="0" count_in_map="1" count_in_player="0" crafted="0" deloot="0" />
</type>

Commands ​

/welcomepack ​

Use /welcomepack with Chat enabled and the command.welcomepack permission. The command takes no arguments. Example: /welcomepack. Set m_Container to a valid container class before offering the command. The server sends the delivery message even if creation of an invalid container fails.

Permissions ​

Grant command.welcomepack through Permissions to authorize the Chat command. root also grants command access.

Released under the MIT License.