Add: freebies module / task encompasses running BattlePass, DataKey, Mail, and SupplyPack together

Upd: BattlePass, DataKey, and SupplyPack modified to run as sub-tasks under Freebies
2026-03-19 23:33:33 +08:00 · 2022-10-16 02:11:21 -04:00
parent 50e831fa3a
commit d14f0018fa
19 changed files with 268 additions and 338 deletions
--- a/module/config/argument/args.json
+++ b/module/config/argument/args.json
@@ -5846,18 +5846,6 @@
      "CollectWeeklyMission": {
        "type": "checkbox",
        "value": true
-      },
-      "CollectMail": {
-        "type": "checkbox",
-        "value": false
-      },
-      "MailFilter": {
-        "type": "textarea",
-        "value": "Merit"
-      },
-      "DeleteMail": {
-        "type": "checkbox",
-        "value": false
      }
    }
  },
@@ -6280,7 +6268,7 @@
      }
    }
  },
-  "DataKey": {
+  "Freebies": {
    "Scheduler": {
      "Enable": {
        "type": "checkbox",
@@ -6293,85 +6281,7 @@
      },
      "Command": {
        "type": "input",
-        "value": "DataKey",
-        "display": "hide"
-      },
-      "SuccessInterval": {
-        "type": "input",
-        "value": 30,
-        "display": "hide"
-      },
-      "FailureInterval": {
-        "type": "input",
-        "value": 30,
-        "display": "hide"
-      },
-      "ServerUpdate": {
-        "type": "input",
-        "value": "00:00",
-        "display": "hide"
-      }
-    },
-    "DataKey": {
-      "ForceGet": {
-        "type": "checkbox",
-        "value": false
-      }
-    }
-  },
-  "SupplyPack": {
-    "Scheduler": {
-      "Enable": {
-        "type": "checkbox",
-        "value": true
-      },
-      "NextRun": {
-        "type": "datetime",
-        "value": "2020-01-01 00:00:00",
-        "validate": "datetime"
-      },
-      "Command": {
-        "type": "input",
-        "value": "SupplyPack",
-        "display": "hide"
-      },
-      "SuccessInterval": {
-        "type": "input",
-        "value": 30,
-        "display": "hide"
-      },
-      "FailureInterval": {
-        "type": "input",
-        "value": 30,
-        "display": "hide"
-      },
-      "ServerUpdate": {
-        "type": "input",
-        "value": "00:00",
-        "display": "hide"
-      }
-    },
-    "SupplyPack": {
-      "WeeklyFreeSupplyPack": {
-        "type": "checkbox",
-        "value": true
-      }
-    }
-  },
-  "BattlePass": {
-    "Scheduler": {
-      "Enable": {
-        "type": "checkbox",
-        "value": true
-      },
-      "NextRun": {
-        "type": "datetime",
-        "value": "2020-01-01 00:00:00",
-        "validate": "datetime"
-      },
-      "Command": {
-        "type": "input",
-        "value": "BattlePass",
+        "value": "Freebies",
        "display": "hide"
      },
      "SuccessInterval": {
@@ -6395,6 +6305,36 @@
        "type": "checkbox",
        "value": true
      }
+    },
+    "DataKey": {
+      "Get": {
+        "type": "checkbox",
+        "value": true
+      },
+      "ForceGet": {
+        "type": "checkbox",
+        "value": false
+      }
+    },
+    "Mail": {
+      "Collect": {
+        "type": "checkbox",
+        "value": true
+      },
+      "Filter": {
+        "type": "textarea",
+        "value": "Merit"
+      },
+      "Delete": {
+        "type": "checkbox",
+        "value": false
+      }
+    },
+    "SupplyPack": {
+      "WeeklyFreeSupplyPack": {
+        "type": "checkbox",
+        "value": true
+      }
    }
  },
  "MetaReward": {
--- a/module/config/argument/argument.yaml
+++ b/module/config/argument/argument.yaml
@@ -360,10 +360,6 @@ Reward:
  CollectExp: true
  CollectMission: true
  CollectWeeklyMission: true
-  CollectMail: false
-  MailFilter: |-
-    Merit
-  DeleteMail: false
 GeneralShop:
  UseGems: false
  Refresh: false
@@ -458,12 +454,18 @@ Gacha:
    option: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
  UseTicket: true
  UseDrill: false
-DataKey:
-  ForceGet: false
-SupplyPack:
-  WeeklyFreeSupplyPack: true
 BattlePass:
  BattlePassReward: true
+DataKey:
+  Get: true
+  ForceGet: false
+Mail:
+  Collect: true
+  Filter: |-
+    Merit
+  Delete: false
+SupplyPack:
+  WeeklyFreeSupplyPack: true
 MetaReward:
  MetaReward: true

--- a/module/config/argument/default.yaml
+++ b/module/config/argument/default.yaml
@@ -51,13 +51,7 @@ Reward:

 # ==================== DailyReward ====================

-DataKey:
-  Scheduler:
-    Enable: true
-SupplyPack:
-  Scheduler:
-    Enable: true
-BattlePass:
+Freebies:
  Scheduler:
    Enable: true
 MetaReward:
--- a/module/config/argument/menu.json
+++ b/module/config/argument/menu.json
@@ -38,9 +38,7 @@
      "ShopOnce",
      "Shipyard",
      "Gacha",
-      "DataKey",
-      "SupplyPack",
-      "BattlePass",
+      "Freebies",
      "MetaReward"
    ],
    "DailyMission": [
--- a/module/config/argument/override.yaml
+++ b/module/config/argument/override.yaml
@@ -260,17 +260,7 @@ Gacha:
    SuccessInterval: 30
    FailureInterval: 30
    ServerUpdate: 00:00
-DataKey:
-  Scheduler:
-    SuccessInterval: 30
-    FailureInterval: 30
-    ServerUpdate: 00:00
-SupplyPack:
-  Scheduler:
-    SuccessInterval: 30
-    FailureInterval: 30
-    ServerUpdate: 00:00
-BattlePass:
+Freebies:
  Scheduler:
    SuccessInterval: 30
    FailureInterval: 30
--- a/module/config/argument/task.yaml
+++ b/module/config/argument/task.yaml
@@ -187,15 +187,12 @@ Shipyard:
 Gacha:
  - Scheduler
  - Gacha
-DataKey:
-  - Scheduler
-  - DataKey
-SupplyPack:
-  - Scheduler
-  - SupplyPack
-BattlePass:
+Freebies:
  - Scheduler
  - BattlePass
+  - DataKey
+  - Mail
+  - SupplyPack
 MetaReward:
  - Scheduler
  - MetaReward
--- a/module/config/config_generated.py
+++ b/module/config/config_generated.py
@@ -235,9 +235,6 @@ class GeneratedConfig:
    Reward_CollectExp = True
    Reward_CollectMission = True
    Reward_CollectWeeklyMission = True
-    Reward_CollectMail = False
-    Reward_MailFilter = 'Merit'
-    Reward_DeleteMail = False

    # Group `GeneralShop`
    GeneralShop_UseGems = False
@@ -288,15 +285,21 @@ class GeneratedConfig:
    Gacha_UseTicket = True
    Gacha_UseDrill = False

+    # Group `BattlePass`
+    BattlePass_BattlePassReward = True
+
    # Group `DataKey`
+    DataKey_Get = True
    DataKey_ForceGet = False

+    # Group `Mail`
+    Mail_Collect = True
+    Mail_Filter = 'Merit'
+    Mail_Delete = False
+
    # Group `SupplyPack`
    SupplyPack_WeeklyFreeSupplyPack = True

-    # Group `BattlePass`
-    BattlePass_BattlePassReward = True
-
    # Group `MetaReward`
    MetaReward_MetaReward = True

--- a/module/config/config_manual.py
+++ b/module/config/config_manual.py
@@ -12,9 +12,9 @@ class ManualConfig:
    Restart
    > Commission > Tactical > Research
    > Exercise
-    > Dorm > Meowfficer > Guild > Gacha > SupplyPack
-    > Reward > MetaReward > BattlePass
-    > ShopFrequent > ShopOnce > Shipyard > DataKey
+    > Dorm > Meowfficer > Guild > Gacha
+    > Reward > MetaReward
+    > ShopFrequent > ShopOnce > Shipyard > Freebies
    > OpsiExplore
    > OpsiAshBeacon
    > OpsiDaily > OpsiShop
--- a/module/config/i18n/en-US.json
+++ b/module/config/i18n/en-US.json
@@ -154,16 +154,8 @@
      "name": "Gacha",
      "help": ""
    },
-    "DataKey": {
-      "name": "Data Key",
-      "help": ""
-    },
-    "SupplyPack": {
-      "name": "Supply Pack",
-      "help": ""
-    },
-    "BattlePass": {
-      "name": "Battle Pass",
+    "Freebies": {
+      "name": "Freebies",
      "help": ""
    },
    "MetaReward": {
@@ -1414,18 +1406,6 @@
    "CollectWeeklyMission": {
      "name": "Collect Weekly Mission Rewards",
      "help": ""
-    },
-    "CollectMail": {
-      "name": "Collect Mail Rewards",
-      "help": "Only collects the top 3 mail entries"
-    },
-    "MailFilter": {
-      "name": "Mail Filter",
-      "help": "Filter as to which mail types should be collected\nSupports Merit, Coin, Cube, Oil, and/or Gem"
-    },
-    "DeleteMail": {
-      "name": "Delete Collected Mail Rewards",
-      "help": "Delete the already collected mail entries\nMark any entries \"important\" in-game to avoid accidental deletion"
    }
  },
  "GeneralShop": {
@@ -1703,16 +1683,48 @@
      "help": "Expedite the recently submitted orders"
    }
  },
+  "BattlePass": {
+    "_info": {
+      "name": "Battle Pass Settings",
+      "help": ""
+    },
+    "BattlePassReward": {
+      "name": "Receive Cruise Missions Rewards",
+      "help": ""
+    }
+  },
  "DataKey": {
    "_info": {
      "name": "Data Key Settings",
      "help": ""
    },
+    "Get": {
+      "name": "Collect Data Key",
+      "help": ""
+    },
    "ForceGet": {
      "name": "Force Collect Data Key",
      "help": "Force collect data key when data key is full to eliminate red dots"
    }
  },
+  "Mail": {
+    "_info": {
+      "name": "Mail Settings",
+      "help": ""
+    },
+    "Collect": {
+      "name": "Collect Mail Rewards",
+      "help": "Only collects the top 3 mail entries"
+    },
+    "Filter": {
+      "name": "Mail Filter",
+      "help": "Filter as to which mail types should be collected\nSupports Merit, Coin, Cube, Oil, and/or Gem"
+    },
+    "Delete": {
+      "name": "Delete Collected Mail Rewards",
+      "help": "Delete the already collected mail entries\nMark any entries \"important\" in-game to avoid accidental deletion"
+    }
+  },
  "SupplyPack": {
    "_info": {
      "name": "Supply Pack Settings",
@@ -1723,16 +1735,6 @@
      "help": ""
    }
  },
-  "BattlePass": {
-    "_info": {
-      "name": "Battle Pass Settings",
-      "help": ""
-    },
-    "BattlePassReward": {
-      "name": "Receive Cruise Missions Rewards",
-      "help": ""
-    }
-  },
  "MetaReward": {
    "_info": {
      "name": "Meta Reward Settings",
--- a/module/config/i18n/ja-JP.json
+++ b/module/config/i18n/ja-JP.json
@@ -154,17 +154,9 @@
      "name": "Task.Gacha.name",
      "help": "Task.Gacha.help"
    },
-    "DataKey": {
-      "name": "Task.DataKey.name",
-      "help": "Task.DataKey.help"
-    },
-    "SupplyPack": {
-      "name": "Task.SupplyPack.name",
-      "help": "Task.SupplyPack.help"
-    },
-    "BattlePass": {
-      "name": "Task.BattlePass.name",
-      "help": "Task.BattlePass.help"
+    "Freebies": {
+      "name": "Task.Freebies.name",
+      "help": "Task.Freebies.help"
    },
    "MetaReward": {
      "name": "Task.MetaReward.name",
@@ -1414,18 +1406,6 @@
    "CollectWeeklyMission": {
      "name": "Reward.CollectWeeklyMission.name",
      "help": "Reward.CollectWeeklyMission.help"
-    },
-    "CollectMail": {
-      "name": "Reward.CollectMail.name",
-      "help": "Reward.CollectMail.help"
-    },
-    "MailFilter": {
-      "name": "Reward.MailFilter.name",
-      "help": "Reward.MailFilter.help"
-    },
-    "DeleteMail": {
-      "name": "Reward.DeleteMail.name",
-      "help": "Reward.DeleteMail.help"
    }
  },
  "GeneralShop": {
@@ -1703,16 +1683,48 @@
      "help": "Gacha.UseDrill.help"
    }
  },
+  "BattlePass": {
+    "_info": {
+      "name": "BattlePass._info.name",
+      "help": "BattlePass._info.help"
+    },
+    "BattlePassReward": {
+      "name": "BattlePass.BattlePassReward.name",
+      "help": "BattlePass.BattlePassReward.help"
+    }
+  },
  "DataKey": {
    "_info": {
      "name": "DataKey._info.name",
      "help": "DataKey._info.help"
    },
+    "Get": {
+      "name": "DataKey.Get.name",
+      "help": "DataKey.Get.help"
+    },
    "ForceGet": {
      "name": "DataKey.ForceGet.name",
      "help": "DataKey.ForceGet.help"
    }
  },
+  "Mail": {
+    "_info": {
+      "name": "Mail._info.name",
+      "help": "Mail._info.help"
+    },
+    "Collect": {
+      "name": "Mail.Collect.name",
+      "help": "Mail.Collect.help"
+    },
+    "Filter": {
+      "name": "Mail.Filter.name",
+      "help": "Mail.Filter.help"
+    },
+    "Delete": {
+      "name": "Mail.Delete.name",
+      "help": "Mail.Delete.help"
+    }
+  },
  "SupplyPack": {
    "_info": {
      "name": "SupplyPack._info.name",
@@ -1723,16 +1735,6 @@
      "help": "SupplyPack.WeeklyFreeSupplyPack.help"
    }
  },
-  "BattlePass": {
-    "_info": {
-      "name": "BattlePass._info.name",
-      "help": "BattlePass._info.help"
-    },
-    "BattlePassReward": {
-      "name": "BattlePass.BattlePassReward.name",
-      "help": "BattlePass.BattlePassReward.help"
-    }
-  },
  "MetaReward": {
    "_info": {
      "name": "MetaReward._info.name",
--- a/module/config/i18n/zh-CN.json
+++ b/module/config/i18n/zh-CN.json
@@ -154,17 +154,9 @@
      "name": "每日抽卡",
      "help": ""
    },
-    "DataKey": {
-      "name": "档案密钥",
-      "help": ""
-    },
-    "SupplyPack": {
-      "name": "优惠礼包",
-      "help": ""
-    },
-    "BattlePass": {
-      "name": "大月卡",
-      "help": ""
+    "Freebies": {
+      "name": "Task.Freebies.name",
+      "help": "Task.Freebies.help"
    },
    "MetaReward": {
      "name": "Meta奖励",
@@ -1414,18 +1406,6 @@
    "CollectWeeklyMission": {
      "name": "领取周任务奖励",
      "help": ""
-    },
-    "CollectMail": {
-      "name": "Reward.CollectMail.name",
-      "help": "Reward.CollectMail.help"
-    },
-    "MailFilter": {
-      "name": "Reward.MailFilter.name",
-      "help": "Reward.MailFilter.help"
-    },
-    "DeleteMail": {
-      "name": "Reward.DeleteMail.name",
-      "help": "Reward.DeleteMail.help"
    }
  },
  "GeneralShop": {
@@ -1703,16 +1683,48 @@
      "help": "选否会等到明天再下水，能贪一个钻头"
    }
  },
+  "BattlePass": {
+    "_info": {
+      "name": "大月卡",
+      "help": ""
+    },
+    "BattlePassReward": {
+      "name": "领取大月卡奖励",
+      "help": ""
+    }
+  },
  "DataKey": {
    "_info": {
      "name": "档案秘钥",
      "help": ""
    },
+    "Get": {
+      "name": "DataKey.Get.name",
+      "help": "DataKey.Get.help"
+    },
    "ForceGet": {
      "name": "强制领取档案秘钥",
      "help": "档案秘钥已满时，强制领取（消除红点）"
    }
  },
+  "Mail": {
+    "_info": {
+      "name": "Mail._info.name",
+      "help": "Mail._info.help"
+    },
+    "Collect": {
+      "name": "Mail.Collect.name",
+      "help": "Mail.Collect.help"
+    },
+    "Filter": {
+      "name": "Mail.Filter.name",
+      "help": "Mail.Filter.help"
+    },
+    "Delete": {
+      "name": "Mail.Delete.name",
+      "help": "Mail.Delete.help"
+    }
+  },
  "SupplyPack": {
    "_info": {
      "name": "优惠礼包",
@@ -1723,16 +1735,6 @@
      "help": ""
    }
  },
-  "BattlePass": {
-    "_info": {
-      "name": "大月卡",
-      "help": ""
-    },
-    "BattlePassReward": {
-      "name": "领取大月卡奖励",
-      "help": ""
-    }
-  },
  "MetaReward": {
    "_info": {
      "name": "Meta 奖励",
--- a/module/config/i18n/zh-TW.json
+++ b/module/config/i18n/zh-TW.json
@@ -154,17 +154,9 @@
      "name": "每日建造",
      "help": ""
    },
-    "DataKey": {
-      "name": "檔案密鑰",
-      "help": ""
-    },
-    "SupplyPack": {
-      "name": "優惠禮包",
-      "help": ""
-    },
-    "BattlePass": {
-      "name": "大月卡",
-      "help": ""
+    "Freebies": {
+      "name": "Task.Freebies.name",
+      "help": "Task.Freebies.help"
    },
    "MetaReward": {
      "name": "Meta獎勵",
@@ -1414,18 +1406,6 @@
    "CollectWeeklyMission": {
      "name": "領取周任務獎勵",
      "help": ""
-    },
-    "CollectMail": {
-      "name": "Reward.CollectMail.name",
-      "help": "Reward.CollectMail.help"
-    },
-    "MailFilter": {
-      "name": "Reward.MailFilter.name",
-      "help": "Reward.MailFilter.help"
-    },
-    "DeleteMail": {
-      "name": "Reward.DeleteMail.name",
-      "help": "Reward.DeleteMail.help"
    }
  },
  "GeneralShop": {
@@ -1703,16 +1683,48 @@
      "help": ""
    }
  },
+  "BattlePass": {
+    "_info": {
+      "name": "大月卡",
+      "help": ""
+    },
+    "BattlePassReward": {
+      "name": "領取大月卡獎勵",
+      "help": ""
+    }
+  },
  "DataKey": {
    "_info": {
      "name": "檔案密鑰",
      "help": ""
    },
+    "Get": {
+      "name": "DataKey.Get.name",
+      "help": "DataKey.Get.help"
+    },
    "ForceGet": {
      "name": "强制領取",
      "help": "檔案密鑰已滿時，强制領取（消除紅點）"
    }
  },
+  "Mail": {
+    "_info": {
+      "name": "Mail._info.name",
+      "help": "Mail._info.help"
+    },
+    "Collect": {
+      "name": "Mail.Collect.name",
+      "help": "Mail.Collect.help"
+    },
+    "Filter": {
+      "name": "Mail.Filter.name",
+      "help": "Mail.Filter.help"
+    },
+    "Delete": {
+      "name": "Mail.Delete.name",
+      "help": "Mail.Delete.help"
+    }
+  },
  "SupplyPack": {
    "_info": {
      "name": "優惠禮包",
@@ -1723,16 +1735,6 @@
      "help": ""
    }
  },
-  "BattlePass": {
-    "_info": {
-      "name": "大月卡",
-      "help": ""
-    },
-    "BattlePassReward": {
-      "name": "領取大月卡獎勵",
-      "help": ""
-    }
-  },
  "MetaReward": {
    "_info": {
      "name": "META 獎勵",