@takaro/modules 0.0.14 → 0.0.18

package/src/modules/economyUtils/index.ts

@@ -1,188 +1,191 @@
-import { BuiltinModule, ICommand, ICronJob, IPermission } from '../../BuiltinModule.js';
+import { ModuleTransferDTO, ICommand, ICronJob, IPermission, ModuleTransferVersionDTO } from '../../BuiltinModule.js';
 
-export class EconomyUtils extends BuiltinModule<EconomyUtils> {
+export class EconomyUtils extends ModuleTransferDTO<EconomyUtils> {
   constructor() {
-    super(
-      'economyUtils',
-      'A set of commands to allow players to manage their currency.',
-      JSON.stringify({
-        $schema: 'http://json-schema.org/draft-07/schema#',
-        type: 'object',
-        properties: {
-          pendingAmount: {
-            title: 'Pending amount',
-            type: 'number',
-            description:
-              'When a player transfers money, they must confirm the transfer when the amount is equal or above this value. Set to 0 to disable.',
-            default: 0,
-          },
-          zombieKillReward: {
-            title: 'Zombie kill reward',
-            type: 'number',
-            description:
-              'The default amount of currency a player receives for killing a zombie. This can be overridden by roles.',
-            default: 1,
-          },
-        },
-        required: [],
-        additionalProperties: false,
-      }),
-    );
-
-    this.permissions = [
-      new IPermission({
-        permission: 'ECONOMY_UTILS_MANAGE_CURRENCY',
-        friendlyName: 'Manage currency',
-        description:
-          'Allows players to manage currency of other players. This includes granting and revoking currency.',
-        canHaveCount: false,
-      }),
-      new IPermission({
-        permission: 'ZOMBIE_KILL_REWARD_OVERRIDE',
-        friendlyName: 'Zombie kill reward override',
-        description: 'Allows a role to override the amount of currency a player receives for killing a entity.',
-        canHaveCount: true,
-      }),
-    ];
-
-    this.cronJobs = [
-      new ICronJob({
-        function: this.loadFn('cronJobs', 'zombieKillReward'),
-        name: 'zombieKillReward',
-        temporalValue: '*/5 * * * *',
-      }),
-    ];
+    super();
 
-    this.commands = [
-      new ICommand({
-        function: this.loadFn('commands', 'balance'),
-        name: 'balance',
-        trigger: 'balance',
-        helpText: 'Check your balance.',
-        arguments: [],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'topCurrency'),
-        name: 'topCurrency',
-        trigger: 'topcurrency',
-        helpText: 'List of the 10 players with the highest balance.',
-        arguments: [],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'grantCurrency'),
-        name: 'grantCurrency',
-        trigger: 'grantcurrency',
-        helpText: 'Grant money to a player. The money is not taken from your own balance but is new currency.',
-        arguments: [
-          {
-            name: 'receiver',
-            type: 'player',
-            helpText: 'The player to grant currency to.',
-            position: 0,
-            defaultValue: null,
-          },
-          {
-            name: 'amount',
-            type: 'number',
-            helpText: 'The amount of money.',
-            position: 1,
-            defaultValue: null,
-          },
-        ],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'revokeCurrency'),
-        name: 'revokeCurrency',
-        trigger: 'revokecurrency',
-        helpText: 'Revokes money from a player. The money disappears.',
-        arguments: [
-          {
-            name: 'receiver',
-            type: 'player',
-            helpText: 'The player to revoke currency from.',
-            position: 0,
-            defaultValue: null,
-          },
-          {
-            name: 'amount',
-            type: 'number',
-            helpText: 'The amount of money.',
-            position: 1,
-            defaultValue: null,
-          },
-        ],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'confirmTransfer'),
-        name: 'confirmTransfer',
-        trigger: 'confirmtransfer',
-        helpText: 'Confirms a pending transfer.',
-        arguments: [],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'transfer'),
-        name: 'transfer',
-        trigger: 'transfer',
-        helpText: 'Transfer money to another player.',
-        arguments: [
-          {
-            name: 'receiver',
-            type: 'player',
-            helpText: 'The player to transfer money to.',
-            position: 0,
-            defaultValue: null,
-          },
-          {
-            name: 'amount',
-            type: 'number',
-            helpText: 'The amount of money to transfer.',
-            position: 1,
-            defaultValue: null,
+    this.name = 'economyUtils';
+    this.versions = [
+      new ModuleTransferVersionDTO({
+        tag: '0.0.1',
+        description: 'A set of commands to allow players to manage their currency.',
+        configSchema: JSON.stringify({
+          $schema: 'http://json-schema.org/draft-07/schema#',
+          type: 'object',
+          properties: {
+            pendingAmount: {
+              title: 'Pending amount',
+              type: 'number',
+              description:
+                'When a player transfers money, they must confirm the transfer when the amount is equal or above this value. Set to 0 to disable.',
+              default: 0,
+            },
+            zombieKillReward: {
+              title: 'Zombie kill reward',
+              type: 'number',
+              description:
+                'The default amount of currency a player receives for killing a zombie. This can be overridden by roles.',
+              default: 1,
+            },
           },
+          required: [],
+          additionalProperties: false,
+        }),
+        permissions: [
+          new IPermission({
+            permission: 'ECONOMY_UTILS_MANAGE_CURRENCY',
+            friendlyName: 'Manage currency',
+            description:
+              'Allows players to manage currency of other players. This includes granting and revoking currency.',
+            canHaveCount: false,
+          }),
+          new IPermission({
+            permission: 'ZOMBIE_KILL_REWARD_OVERRIDE',
+            friendlyName: 'Zombie kill reward override',
+            description: 'Allows a role to override the amount of currency a player receives for killing a entity.',
+            canHaveCount: true,
+          }),
         ],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'claim'),
-        name: 'claim',
-        trigger: 'claim',
-        helpText: 'Claim your pending shop orders.',
-        arguments: [
-          {
-            name: 'all',
-            type: 'boolean',
-            helpText: 'If true, claim ALL pending orders. If false, claim only the first one.',
-            position: 0,
-            defaultValue: 'false',
-          },
+        cronJobs: [
+          new ICronJob({
+            function: this.loadFn('cronJobs', 'zombieKillReward'),
+            name: 'zombieKillReward',
+            temporalValue: '*/5 * * * *',
+          }),
         ],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'shop'),
-        name: 'shop',
-        trigger: 'shop',
-        helpText: 'Browse the shop and view available items.',
-        arguments: [
-          {
-            name: 'page',
-            type: 'number',
-            helpText: 'Display more items from the shop by specifying a page number.',
-            position: 0,
-            defaultValue: '1',
-          },
-          {
-            name: 'item',
-            type: 'number',
-            helpText: 'Select a specific item to view more details.',
-            position: 1,
-            defaultValue: '0',
-          },
-          {
-            name: 'action',
-            type: 'string',
-            helpText: 'Perform an action on the selected item. Currently only "buy" is supported.',
-            position: 2,
-            defaultValue: 'none',
-          },
+
+        commands: [
+          new ICommand({
+            function: this.loadFn('commands', 'balance'),
+            name: 'balance',
+            trigger: 'balance',
+            helpText: 'Check your balance.',
+            arguments: [],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'topCurrency'),
+            name: 'topCurrency',
+            trigger: 'topcurrency',
+            helpText: 'List of the 10 players with the highest balance.',
+            arguments: [],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'grantCurrency'),
+            name: 'grantCurrency',
+            trigger: 'grantcurrency',
+            helpText: 'Grant money to a player. The money is not taken from your own balance but is new currency.',
+            arguments: [
+              {
+                name: 'receiver',
+                type: 'player',
+                helpText: 'The player to grant currency to.',
+                position: 0,
+                defaultValue: null,
+              },
+              {
+                name: 'amount',
+                type: 'number',
+                helpText: 'The amount of money.',
+                position: 1,
+                defaultValue: null,
+              },
+            ],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'revokeCurrency'),
+            name: 'revokeCurrency',
+            trigger: 'revokecurrency',
+            helpText: 'Revokes money from a player. The money disappears.',
+            arguments: [
+              {
+                name: 'receiver',
+                type: 'player',
+                helpText: 'The player to revoke currency from.',
+                position: 0,
+                defaultValue: null,
+              },
+              {
+                name: 'amount',
+                type: 'number',
+                helpText: 'The amount of money.',
+                position: 1,
+                defaultValue: null,
+              },
+            ],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'confirmTransfer'),
+            name: 'confirmTransfer',
+            trigger: 'confirmtransfer',
+            helpText: 'Confirms a pending transfer.',
+            arguments: [],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'transfer'),
+            name: 'transfer',
+            trigger: 'transfer',
+            helpText: 'Transfer money to another player.',
+            arguments: [
+              {
+                name: 'receiver',
+                type: 'player',
+                helpText: 'The player to transfer money to.',
+                position: 0,
+                defaultValue: null,
+              },
+              {
+                name: 'amount',
+                type: 'number',
+                helpText: 'The amount of money to transfer.',
+                position: 1,
+                defaultValue: null,
+              },
+            ],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'claim'),
+            name: 'claim',
+            trigger: 'claim',
+            helpText: 'Claim your pending shop orders.',
+            arguments: [
+              {
+                name: 'all',
+                type: 'boolean',
+                helpText: 'If true, claim ALL pending orders. If false, claim only the first one.',
+                position: 0,
+                defaultValue: 'false',
+              },
+            ],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'shop'),
+            name: 'shop',
+            trigger: 'shop',
+            helpText: 'Browse the shop and view available items.',
+            arguments: [
+              {
+                name: 'page',
+                type: 'number',
+                helpText: 'Display more items from the shop by specifying a page number.',
+                position: 0,
+                defaultValue: '1',
+              },
+              {
+                name: 'item',
+                type: 'number',
+                helpText: 'Select a specific item to view more details.',
+                position: 1,
+                defaultValue: '0',
+              },
+              {
+                name: 'action',
+                type: 'string',
+                helpText: 'Perform an action on the selected item. Currently only "buy" is supported.',
+                position: 2,
+                defaultValue: 'none',
+              },
+            ],
+          }),
         ],
       }),
     ];

package/src/modules/geoBlock/hooks/IPDetected.js

@@ -9,9 +9,11 @@ async function main() {
     if (ban) {
       const now = new Date();
       const expiresAt = new Date(now.getTime() + banDuration * 1000);
-      await takaro.gameserver.gameServerControllerBanPlayer(gameServerId, player.id, {
+      await takaro.player.banControllerCreate({
+        gameServerId,
+        playerId: player.id,
+        until: expiresAt,
         reason: message,
-        expiresAt,
       });
     } else {
       await takaro.gameserver.gameServerControllerKickPlayer(gameServerId, player.id, {

package/src/modules/geoBlock/index.ts

@@ -1,4 +1,4 @@
-import { BuiltinModule, IHook, IPermission } from '../../BuiltinModule.js';
+import { ModuleTransferDTO, IHook, IPermission, ModuleTransferVersionDTO } from '../../BuiltinModule.js';
 import { HookEvents } from '../../dto/index.js';
 import { Duration } from 'luxon';
 
@@ -252,79 +252,81 @@ export const countryCodes = [
   { code: 'ZW', name: 'Zimbabwe' },
 ];
 
-export class GeoBlock extends BuiltinModule<GeoBlock> {
+export class GeoBlock extends ModuleTransferDTO<GeoBlock> {
   constructor() {
-    super(
-      'geoBlock',
-      'Block players from certain countries from joining the server.',
-      JSON.stringify({
-        $schema: 'http://json-schema.org/draft-07/schema#',
-        type: 'object',
-        properties: {
-          mode: {
-            title: 'Mode',
-            type: 'string',
-            description:
-              'If set to allow, only players from the specified countries will be allowed to join. If set to deny, players from the specified countries will be banned from the server.',
-            enum: ['allow', 'deny'],
-            default: 'deny',
-          },
-          countries: {
-            title: 'Countries',
-            description: 'List of countries',
-            type: 'array',
-            uniqueItems: true,
-            'x-component': 'country',
-            items: {
+    super();
+
+    this.name = 'geoBlock';
+    this.versions = [
+      new ModuleTransferVersionDTO({
+        tag: '0.0.1',
+        description: 'Block players from certain countries from joining the server.',
+        configSchema: JSON.stringify({
+          $schema: 'http://json-schema.org/draft-07/schema#',
+          type: 'object',
+          properties: {
+            mode: {
+              title: 'Mode',
               type: 'string',
-              anyOf: countryCodes.map(({ code, name }) => ({ const: code, title: name })),
+              description:
+                'If set to allow, only players from the specified countries will be allowed to join. If set to deny, players from the specified countries will be banned from the server.',
+              enum: ['allow', 'deny'],
+              default: 'deny',
+            },
+            countries: {
+              title: 'Countries',
+              description: 'List of countries',
+              type: 'array',
+              uniqueItems: true,
+              'x-component': 'country',
+              items: {
+                type: 'string',
+                anyOf: countryCodes.map(({ code, name }) => ({ const: code, title: name })),
+              },
+            },
+            ban: {
+              title: 'Ban',
+              description:
+                'Ban players from the server when they are detected. When false, players will be kicked instead.',
+              type: 'boolean',
+              default: true,
+            },
+            banDuration: {
+              title: 'Ban duration',
+              description: 'Duration of the ban.',
+              'x-component': 'duration',
+              type: 'number',
+              minimum: 0,
+              default: Duration.fromObject({ days: 1 }).as('milliseconds'),
+            },
+            message: {
+              title: 'Message',
+              type: 'string',
+              description: 'Message to send to the player when they are kicked or banned.',
+              default: 'Your IP address is banned.',
             },
           },
-          ban: {
-            title: 'Ban',
-            description:
-              'Ban players from the server when they are detected. When false, players will be kicked instead.',
-            type: 'boolean',
-            default: true,
-          },
-          banDuration: {
-            title: 'Ban duration',
-            description: 'Duration of the ban.',
-            'x-component': 'duration',
-            type: 'number',
-            minimum: 0,
-            default: Duration.fromObject({ days: 1 }).as('milliseconds'),
-          },
-          message: {
-            title: 'Message',
-            type: 'string',
-            description: 'Message to send to the player when they are kicked or banned.',
-            default: 'Your IP address is banned.',
-          },
-        },
-        required: ['countries'],
-        additionalProperties: false,
-      }),
-      JSON.stringify({
-        banDuration: { 'ui:widget': 'duration' },
-      }),
-    );
-
-    this.permissions = [
-      new IPermission({
-        permission: 'GEOBLOCK_IMMUNITY',
-        friendlyName: 'GeoBlock immunity',
-        description: 'Players with this permission will not be kicked or banned by GeoBlock.',
-        canHaveCount: false,
-      }),
-    ];
-
-    this.commands = [];
-    this.hooks = [
-      new IHook({
-        eventType: HookEvents.PLAYER_NEW_IP_DETECTED,
-        name: 'IPDetected',
-        function: this.loadFn('hooks', 'IPDetected'),
+          required: ['countries'],
+          additionalProperties: false,
+        }),
+        uiSchema: JSON.stringify({
+          banDuration: { 'ui:widget': 'duration' },
+        }),
+        permissions: [
+          new IPermission({
+            permission: 'GEOBLOCK_IMMUNITY',
+            friendlyName: 'GeoBlock immunity',
+            description: 'Players with this permission will not be kicked or banned by GeoBlock.',
+            canHaveCount: false,
+          }),
+        ],
+        hooks: [
+          new IHook({
+            eventType: HookEvents.PLAYER_NEW_IP_DETECTED,
+            name: 'IPDetected',
+            function: this.loadFn('hooks', 'IPDetected'),
+          }),
+        ],
       }),
     ];
   }

package/src/modules/gimme/commands/gimme.js

@@ -15,12 +15,22 @@ async function main() {
   const randomOption = items.concat(commands)[randomIndex];
 
   if (randomIndex < items.length) {
-    await takaro.gameserver.gameServerControllerGiveItem(data.gameServerId, data.player.id, {
-      name: randomOption,
-      amount: 1,
-      quality: '0',
-    });
-    await data.player.pm(`You received ${randomOption}!`);
+    if (typeof randomOption === 'string') {
+      await takaro.gameserver.gameServerControllerGiveItem(data.gameServerId, data.player.id, {
+        name: randomOption,
+        amount: 1,
+        quality: '0',
+      });
+      await data.player.pm(`You received ${randomOption}!`);
+    } else {
+      const item = (await takaro.item.itemControllerFindOne(randomOption.item)).data.data;
+      await takaro.gameserver.gameServerControllerGiveItem(data.gameServerId, data.player.id, {
+        name: item.code,
+        amount: randomOption.amount,
+        quality: randomOption.quality ?? '',
+      });
+      await data.player.pm(`You received ${randomOption.amount}x ${item.name}!`);
+    }
   } else {
     await takaro.gameserver.gameServerControllerExecuteCommand(data.gameServerId, { command: randomOption });
   }