Implementation of "Abjuration Dial" and "Adventurer Gratitude" Campaign Toggles

[eyes-and-brain]

I would like to propose adding two new campaign features inspired by the FFXI retail "Abjuration Dial" and "Adventurer Gratitude" campaigns.

Currently, server administrators often have to manually edit scripts to run specific login events. By adding these campaign logics to the core and providing toggles in main.lua, we can offer more flexibility for server management.

Features:

1. Abjuration Dial Campaign: Players receive a "Dial Key #Ab" once every 24 hours upon login.
2. Adventurer Gratitude Campaign: A weekly reward system with 4 distinct steps. If a player already owns the primary reward (e.g., Echad Ring), they automatically receive a fallback reward (e.g., Mog Pell (Red)).

Implementation Details:

• Added toggle flags in xi.settings.main.
• Implemented logic in player.lua using os.time() and CharVar to ensure rewards are persistent and time-gated correctly.
• Used npcUtil.giveItem to handle inventory checks and item distribution safely.

---------------------------------------------------------
-- Abjuration Dial Campaign
-- Rewards players with Dial Key #Ab once every 24 hours
---------------------------------------------------------
local function checkAbjurationDialCampaign(player)
    if xi.settings.main.ENABLE_ABJURATION_DIAL_CAMPAIGN then
        require('scripts/globals/npc_util')
        local VAR_NAME = "DailyDialKeyAb_Timestamp"
        local now = os.time()
        local lastTime = player:getCharVar(VAR_NAME)

        -- Check if 24 hours (86400s) have passed since the last successful distribution
        if now >= lastTime + 86400 then
            -- Dial Key #Ab
            if npcUtil.giveItem(player, xi.item.DIAL_KEY_AB) then
                player:setCharVar(VAR_NAME, now)
            end
        end
    end
end

---------------------------------------------------------
-- Adventurer Gratitude Campaign (Weekly Bonus)
-- 4-step rewards with logic to check for existing items/spells/KIs
---------------------------------------------------------
local function checkGratitudeCampaign(player)
    if xi.settings.main.ENABLE_GRATITUDE_CAMPAIGN then
        require('scripts/globals/npc_util')
        local now = os.time()
        local VAR_STEP = "GratitudeCampaign_Step"
        local VAR_TIME = "GratitudeCampaign_Timestamp"
        local lastTime = player:getCharVar(VAR_TIME)
        local step = player:getCharVar(VAR_STEP)

        -- Check if 1 week (604800s) has passed
        if lastTime == 0 or now >= lastTime + 604800 then
            local rewards = {}

            -- Step-based rewards with fallback logic
            if step == 0 then
                rewards = player:hasItem(xi.item.ECHAD_RING) and { {xi.item.RED_MOG_PELL, 1} } or { {xi.item.ECHAD_RING, 1} }
            elseif step == 1 then
                rewards = (player:hasItem(xi.item.MOUNT_RED_CRAB) or player:hasKeyItem(xi.ki.RED_CRAB_COMPANION)) and { {xi.item.COPPER_AMAN_VOUCHER, 12} } or { {xi.item.MOUNT_RED_CRAB, 1} }
            elseif step == 2 then
                rewards = (player:hasItem(xi.item.CIPHER_OF_KUPOFRIEDS_ALTER_EGO) or player:hasSpell(xi.magic.spell.KUPOFRIED)) and { {xi.item.SILVER_MOG_PELL, 1} } or { {xi.item.CIPHER_OF_KUPOFRIEDS_ALTER_EGO, 1} }
            elseif step == 3 then
                rewards = player:hasItem(xi.item.VANACLOCK) and { {xi.item.RED_MOG_PELL, 2} } or { {xi.item.VANACLOCK, 1} }
            else
                -- Reset cycle
                player:setCharVar(VAR_STEP, 0)
                return checkGratitudeCampaign(player)
            end

            if npcUtil.giveItem(player, rewards) then
                player:setCharVar(VAR_TIME, now)
                player:setCharVar(VAR_STEP, step + 1)
            end
        end
    end
end