@takaro/modules 0.0.1

package/src/modules/geoBlock/index.ts

@@ -0,0 +1,331 @@
+import { BuiltinModule, IHook, IPermission } from '../../BuiltinModule.js';
+import { HookEvents } from '../../dto/index.js';
+import { Duration } from 'luxon';
+
+// temporary solution
+export const countryCodes = [
+  { code: 'AF', name: 'Afghanistan' },
+  { code: 'AX', name: 'Aland Islands' },
+  { code: 'AL', name: 'Albania' },
+  { code: 'DZ', name: 'Algeria' },
+  { code: 'AS', name: 'American Samoa' },
+  { code: 'AD', name: 'Andorra' },
+  { code: 'AO', name: 'Angola' },
+  { code: 'AI', name: 'Anguilla' },
+  { code: 'AQ', name: 'Antarctica' },
+  { code: 'AG', name: 'Antigua And Barbuda' },
+  { code: 'AR', name: 'Argentina' },
+  { code: 'AM', name: 'Armenia' },
+  { code: 'AW', name: 'Aruba' },
+  { code: 'AU', name: 'Australia' },
+  { code: 'AT', name: 'Austria' },
+  { code: 'AZ', name: 'Azerbaijan' },
+  { code: 'BS', name: 'Bahamas' },
+  { code: 'BH', name: 'Bahrain' },
+  { code: 'BD', name: 'Bangladesh' },
+  { code: 'BB', name: 'Barbados' },
+  { code: 'BY', name: 'Belarus' },
+  { code: 'BE', name: 'Belgium' },
+  { code: 'BZ', name: 'Belize' },
+  { code: 'BJ', name: 'Benin' },
+  { code: 'BM', name: 'Bermuda' },
+  { code: 'BT', name: 'Bhutan' },
+  { code: 'BO', name: 'Bolivia' },
+  { code: 'BA', name: 'Bosnia And Herzegovina' },
+  { code: 'BW', name: 'Botswana' },
+  { code: 'BV', name: 'Bouvet Island' },
+  { code: 'BR', name: 'Brazil' },
+  { code: 'IO', name: 'British Indian Ocean Territory' },
+  { code: 'BN', name: 'Brunei Darussalam' },
+  { code: 'BG', name: 'Bulgaria' },
+  { code: 'BF', name: 'Burkina Faso' },
+  { code: 'BI', name: 'Burundi' },
+  { code: 'KH', name: 'Cambodia' },
+  { code: 'CM', name: 'Cameroon' },
+  { code: 'CA', name: 'Canada' },
+  { code: 'CV', name: 'Cape Verde' },
+  { code: 'KY', name: 'Cayman Islands' },
+  { code: 'CF', name: 'Central African Republic' },
+  { code: 'TD', name: 'Chad' },
+  { code: 'CL', name: 'Chile' },
+  { code: 'CN', name: 'China' },
+  { code: 'CX', name: 'Christmas Island' },
+  { code: 'CC', name: 'Cocos (Keeling) Islands' },
+  { code: 'CO', name: 'Colombia' },
+  { code: 'KM', name: 'Comoros' },
+  { code: 'CG', name: 'Congo' },
+  { code: 'CD', name: 'Congo, Democratic Republic' },
+  { code: 'CK', name: 'Cook Islands' },
+  { code: 'CR', name: 'Costa Rica' },
+  // eslint-disable-next-line quotes
+  { code: 'CI', name: "Cote D'Ivoire" },
+  { code: 'HR', name: 'Croatia' },
+  { code: 'CU', name: 'Cuba' },
+  { code: 'CY', name: 'Cyprus' },
+  { code: 'CZ', name: 'Czech Republic' },
+  { code: 'DK', name: 'Denmark' },
+  { code: 'DJ', name: 'Djibouti' },
+  { code: 'DM', name: 'Dominica' },
+  { code: 'DO', name: 'Dominican Republic' },
+  { code: 'EC', name: 'Ecuador' },
+  { code: 'EG', name: 'Egypt' },
+  { code: 'SV', name: 'El Salvador' },
+  { code: 'GQ', name: 'Equatorial Guinea' },
+  { code: 'ER', name: 'Eritrea' },
+  { code: 'EE', name: 'Estonia' },
+  { code: 'ET', name: 'Ethiopia' },
+  { code: 'FK', name: 'Falkland Islands (Malvinas)' },
+  { code: 'FO', name: 'Faroe Islands' },
+  { code: 'FJ', name: 'Fiji' },
+  { code: 'FI', name: 'Finland' },
+  { code: 'FR', name: 'France' },
+  { code: 'GF', name: 'French Guiana' },
+  { code: 'PF', name: 'French Polynesia' },
+  { code: 'TF', name: 'French Southern Territories' },
+  { code: 'GA', name: 'Gabon' },
+  { code: 'GM', name: 'Gambia' },
+  { code: 'GE', name: 'Georgia' },
+  { code: 'DE', name: 'Germany' },
+  { code: 'GH', name: 'Ghana' },
+  { code: 'GI', name: 'Gibraltar' },
+  { code: 'GR', name: 'Greece' },
+  { code: 'GL', name: 'Greenland' },
+  { code: 'GD', name: 'Grenada' },
+  { code: 'GP', name: 'Guadeloupe' },
+  { code: 'GU', name: 'Guam' },
+  { code: 'GT', name: 'Guatemala' },
+  { code: 'GG', name: 'Guernsey' },
+  { code: 'GN', name: 'Guinea' },
+  { code: 'GW', name: 'Guinea-Bissau' },
+  { code: 'GY', name: 'Guyana' },
+  { code: 'HT', name: 'Haiti' },
+  //   { code: 'HM', name: 'Heard Island & Mcdonald Islands' },
+  { code: 'VA', name: 'Holy See (Vatican City State)' },
+  { code: 'HN', name: 'Honduras' },
+  { code: 'HK', name: 'Hong Kong' },
+  { code: 'HU', name: 'Hungary' },
+  { code: 'IS', name: 'Iceland' },
+  { code: 'IN', name: 'India' },
+  { code: 'ID', name: 'Indonesia' },
+  { code: 'IR', name: 'Iran, Islamic Republic Of' },
+  { code: 'IQ', name: 'Iraq' },
+  { code: 'IE', name: 'Ireland' },
+  { code: 'IM', name: 'Isle Of Man' },
+  { code: 'IL', name: 'Israel' },
+  { code: 'IT', name: 'Italy' },
+  { code: 'JM', name: 'Jamaica' },
+  { code: 'JP', name: 'Japan' },
+  { code: 'JE', name: 'Jersey' },
+  { code: 'JO', name: 'Jordan' },
+  { code: 'KZ', name: 'Kazakhstan' },
+  { code: 'KE', name: 'Kenya' },
+  { code: 'KI', name: 'Kiribati' },
+  { code: 'KR', name: 'Korea' },
+  { code: 'KW', name: 'Kuwait' },
+  { code: 'KG', name: 'Kyrgyzstan' },
+  // eslint-disable-next-line quotes
+  { code: 'LA', name: "Lao People's Democratic Republic" },
+  { code: 'LV', name: 'Latvia' },
+  { code: 'LB', name: 'Lebanon' },
+  { code: 'LS', name: 'Lesotho' },
+  { code: 'LR', name: 'Liberia' },
+  { code: 'LY', name: 'Libyan Arab Jamahiriya' },
+  { code: 'LI', name: 'Liechtenstein' },
+  { code: 'LT', name: 'Lithuania' },
+  { code: 'LU', name: 'Luxembourg' },
+  { code: 'MO', name: 'Macao' },
+  { code: 'MK', name: 'Macedonia' },
+  { code: 'MG', name: 'Madagascar' },
+  { code: 'MW', name: 'Malawi' },
+  { code: 'MY', name: 'Malaysia' },
+  { code: 'MV', name: 'Maldives' },
+  { code: 'ML', name: 'Mali' },
+  { code: 'MT', name: 'Malta' },
+  { code: 'MH', name: 'Marshall Islands' },
+  { code: 'MQ', name: 'Martinique' },
+  { code: 'MR', name: 'Mauritania' },
+  { code: 'MU', name: 'Mauritius' },
+  { code: 'YT', name: 'Mayotte' },
+  { code: 'MX', name: 'Mexico' },
+  { code: 'FM', name: 'Micronesia, Federated States Of' },
+  { code: 'MD', name: 'Moldova' },
+  { code: 'MC', name: 'Monaco' },
+  { code: 'MN', name: 'Mongolia' },
+  { code: 'ME', name: 'Montenegro' },
+  { code: 'MS', name: 'Montserrat' },
+  { code: 'MA', name: 'Morocco' },
+  { code: 'MZ', name: 'Mozambique' },
+  { code: 'MM', name: 'Myanmar' },
+  { code: 'NA', name: 'Namibia' },
+  { code: 'NR', name: 'Nauru' },
+  { code: 'NP', name: 'Nepal' },
+  { code: 'NL', name: 'Netherlands' },
+  { code: 'NC', name: 'New Caledonia' },
+  { code: 'NZ', name: 'New Zealand' },
+  { code: 'NI', name: 'Nicaragua' },
+  { code: 'NE', name: 'Niger' },
+  { code: 'NG', name: 'Nigeria' },
+  { code: 'NU', name: 'Niue' },
+  { code: 'NF', name: 'Norfolk Island' },
+  { code: 'MP', name: 'Northern Mariana Islands' },
+  { code: 'NO', name: 'Norway' },
+  { code: 'OM', name: 'Oman' },
+  { code: 'PK', name: 'Pakistan' },
+  { code: 'PW', name: 'Palau' },
+  { code: 'PS', name: 'Palestinian Territory, Occupied' },
+  { code: 'PA', name: 'Panama' },
+  { code: 'PG', name: 'Papua New Guinea' },
+  { code: 'PY', name: 'Paraguay' },
+  { code: 'PE', name: 'Peru' },
+  { code: 'PH', name: 'Philippines' },
+  { code: 'PN', name: 'Pitcairn' },
+  { code: 'PL', name: 'Poland' },
+  { code: 'PT', name: 'Portugal' },
+  { code: 'PR', name: 'Puerto Rico' },
+  { code: 'QA', name: 'Qatar' },
+  { code: 'RE', name: 'Reunion' },
+  { code: 'RO', name: 'Romania' },
+  { code: 'RU', name: 'Russian Federation' },
+  { code: 'RW', name: 'Rwanda' },
+  { code: 'BL', name: 'Saint Barthelemy' },
+  { code: 'SH', name: 'Saint Helena' },
+  { code: 'KN', name: 'Saint Kitts And Nevis' },
+  { code: 'LC', name: 'Saint Lucia' },
+  { code: 'MF', name: 'Saint Martin' },
+  { code: 'PM', name: 'Saint Pierre And Miquelon' },
+  { code: 'VC', name: 'Saint Vincent And Grenadines' },
+  { code: 'WS', name: 'Samoa' },
+  { code: 'SM', name: 'San Marino' },
+  { code: 'ST', name: 'Sao Tome And Principe' },
+  { code: 'SA', name: 'Saudi Arabia' },
+  { code: 'SN', name: 'Senegal' },
+  { code: 'RS', name: 'Serbia' },
+  { code: 'SC', name: 'Seychelles' },
+  { code: 'SL', name: 'Sierra Leone' },
+  { code: 'SG', name: 'Singapore' },
+  { code: 'SK', name: 'Slovakia' },
+  { code: 'SI', name: 'Slovenia' },
+  { code: 'SB', name: 'Solomon Islands' },
+  { code: 'SO', name: 'Somalia' },
+  { code: 'ZA', name: 'South Africa' },
+  // { code: 'GS', name: 'South Georgia And Sandwich Isl.' },
+  { code: 'ES', name: 'Spain' },
+  { code: 'LK', name: 'Sri Lanka' },
+  { code: 'SD', name: 'Sudan' },
+  { code: 'SR', name: 'Suriname' },
+  // { code: 'SJ', name: 'Svalbard And Jan Mayen' },
+  { code: 'SZ', name: 'Swaziland' },
+  { code: 'SE', name: 'Sweden' },
+  { code: 'CH', name: 'Switzerland' },
+  { code: 'SY', name: 'Syrian Arab Republic' },
+  { code: 'TW', name: 'Taiwan' },
+  { code: 'TJ', name: 'Tajikistan' },
+  { code: 'TZ', name: 'Tanzania' },
+  { code: 'TH', name: 'Thailand' },
+  { code: 'TL', name: 'Timor-Leste' },
+  { code: 'TG', name: 'Togo' },
+  { code: 'TK', name: 'Tokelau' },
+  { code: 'TO', name: 'Tonga' },
+  { code: 'TT', name: 'Trinidad And Tobago' },
+  { code: 'TN', name: 'Tunisia' },
+  { code: 'TR', name: 'Turkey' },
+  { code: 'TM', name: 'Turkmenistan' },
+  // { code: 'TC', name: 'Turks And Caicos Islands' },
+  { code: 'TV', name: 'Tuvalu' },
+  { code: 'UG', name: 'Uganda' },
+  { code: 'UA', name: 'Ukraine' },
+  { code: 'AE', name: 'United Arab Emirates' },
+  { code: 'GB', name: 'United Kingdom' },
+  { code: 'US', name: 'United States' },
+  // { code: 'UM', name: 'United States Outlying Islands' },
+  { code: 'UY', name: 'Uruguay' },
+  { code: 'UZ', name: 'Uzbekistan' },
+  { code: 'VU', name: 'Vanuatu' },
+  { code: 'VE', name: 'Venezuela' },
+  { code: 'VN', name: 'Vietnam' },
+  // { code: 'VG', name: 'Virgin Islands, British' },
+  // { code: 'VI', name: 'Virgin Islands, U.S.' },
+  // { code: 'WF', name: 'Wallis And Futuna' },
+  { code: 'EH', name: 'Western Sahara' },
+  { code: 'YE', name: 'Yemen' },
+  { code: 'ZM', name: 'Zambia' },
+  { code: 'ZW', name: 'Zimbabwe' },
+];
+
+export class GeoBlock extends BuiltinModule<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 country',
+            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.',
+          },
+        },
+        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'),
+      }),
+    ];
+  }
+}

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

@@ -0,0 +1,28 @@
+import { takaro, data, TakaroUserError } from '@takaro/helpers';
+
+async function main() {
+  const items = data.module.userConfig.items;
+  const commands = data.module.userConfig.commands;
+
+  if (items.length + commands.length === 0) {
+    throw new TakaroUserError(
+      'No items or commands configured, please ask your server administrator to configure this module.'
+    );
+  }
+
+  // pick a random item between 0 and the length of both the items and commands arrays
+  const randomIndex = Math.floor(Math.random() * (items.length + commands.length));
+  const randomOption = items.concat(commands)[randomIndex];
+
+  if (randomIndex < items.length) {
+    await takaro.gameserver.gameServerControllerGiveItem(data.gameServerId, data.player.id, {
+      name: randomOption,
+      amount: 1,
+    });
+    await data.player.pm(`You received ${randomOption}!`);
+  } else {
+    await takaro.gameserver.gameServerControllerExecuteCommand(data.gameServerId, { command: randomOption });
+  }
+}
+
+await main();

package/src/modules/gimme/index.ts

@@ -0,0 +1,49 @@
+import { BuiltinModule, ICommand } from '../../BuiltinModule.js';
+
+export class Gimme extends BuiltinModule<Gimme> {
+  constructor() {
+    super(
+      'gimme',
+      'Randomly selects an item from a list of items.',
+      JSON.stringify({
+        $schema: 'http://json-schema.org/draft-07/schema#',
+        type: 'object',
+        properties: {
+          items: {
+            'x-component': 'item',
+            type: 'array',
+            title: 'Items',
+            description: 'List of items that a player can receive.',
+            uniqueItems: true,
+            items: {
+              type: 'string',
+            },
+          },
+          commands: {
+            title: 'Commands',
+            type: 'array',
+            default: ['say hello from gimme'],
+            items: {
+              type: 'string',
+            },
+          },
+        },
+        required: ['items'],
+        additionalProperties: false,
+      }),
+      JSON.stringify({
+        items: { 'ui:widget': 'item' },
+      })
+    );
+
+    this.commands = [
+      new ICommand({
+        function: this.loadFn('commands', 'gimme'),
+        name: 'gimme',
+        trigger: 'gimme',
+        helpText: 'Randomly selects item from a list of items and entities.',
+        arguments: [],
+      }),
+    ];
+  }
+}

package/src/modules/highPingKicker/cronJobs/Ping check.js

@@ -0,0 +1,66 @@
+import { takaro, data } from '@takaro/helpers';
+
+const VARIABLE_KEY = 'highPingKicker:warnings';
+
+async function main() {
+  const currentPlayers = await takaro.gameserver.gameServerControllerGetPlayers(data.gameServerId);
+
+  await Promise.all(
+    currentPlayers.data.data.map(async (player) => {
+      if (player.ping > data.module.userConfig.pingThreshold) {
+        const takaroPlayerRes = await takaro.player.playerControllerSearch({
+          filters: {
+            steamId: player.steamId,
+          },
+        });
+
+        const takaroPlayer = takaroPlayerRes.data.data[0];
+
+        const currentWarningsRes = await takaro.variable.variableControllerFind({
+          filters: {
+            playerId: takaroPlayer.id,
+            key: VARIABLE_KEY,
+          },
+        });
+
+        const currentWarningsRecords = currentWarningsRes.data.data;
+
+        let currentWarnings = 1;
+        if (!currentWarningsRecords.length) {
+          await takaro.variable.variableControllerCreate({
+            playerId: takaroPlayer.id,
+            key: VARIABLE_KEY,
+            value: '1',
+          });
+        } else {
+          currentWarnings = parseInt(currentWarningsRecords[0].value, 10);
+        }
+
+        if (currentWarningsRecords.length === 1) {
+          await takaro.variable.variableControllerUpdate(currentWarningsRecords[0].id, {
+            value: (currentWarnings + 1).toString(),
+          });
+
+          await takaro.gameserver.gameServerControllerSendMessage(data.gameServerId, {
+            message: `Your ping (${player.ping}) is too high. Warning ${currentWarnings}/${data.module.userConfig.warningsBeforeKick}`,
+            opts: {
+              recipient: {
+                gameId: player.gameId,
+              },
+            },
+          });
+        }
+
+        if (currentWarnings >= data.module.userConfig.warningsBeforeKick) {
+          await takaro.gameserver.gameServerControllerKickPlayer(data.gameServerId, takaroPlayer.id, {
+            reason: `Your ping (${player.ping}) is too high, please try again later.`,
+          });
+
+          await takaro.variable.variableControllerDelete(currentWarningsRecords[0].id);
+        }
+      }
+    })
+  );
+}
+
+await main();

package/src/modules/highPingKicker/index.ts

@@ -0,0 +1,39 @@
+import { BuiltinModule, ICronJob } from '../../BuiltinModule.js';
+
+export class HighPingKicker extends BuiltinModule<HighPingKicker> {
+  constructor() {
+    super(
+      'highPingKicker',
+      'Automatically kick players with high ping, with warnings and configurable thresholds.',
+      JSON.stringify({
+        $schema: 'http://json-schema.org/draft-07/schema#',
+        type: 'object',
+        properties: {
+          pingThreshold: {
+            type: 'number',
+            title: 'Ping threshold',
+            description: 'A ping value that is deemed too high and prompts a warning.',
+            default: 200,
+            minimum: 0,
+          },
+          warningsBeforeKick: {
+            type: 'number',
+            title: 'Kick warnings',
+            description: 'Number of warnings before a player is kicked.',
+            default: 3,
+            minimum: 0,
+          },
+        },
+        required: [],
+      })
+    );
+
+    this.cronJobs = [
+      new ICronJob({
+        name: 'Ping check',
+        temporalValue: '*/5 * * * *',
+        function: this.loadFn('cronJobs', 'Ping check'),
+      }),
+    ];
+  }
+}

package/src/modules/lottery/commands/buyTicket.js

@@ -0,0 +1,68 @@
+import { takaro, data, checkPermission, TakaroUserError } from '@takaro/helpers';
+
+async function main() {
+  const { pog, gameServerId, arguments: args, module: mod } = data;
+
+  const varKey = 'lottery_tickets_bought';
+
+  if (!checkPermission(pog, 'LOTTERY_BUY')) {
+    throw new TakaroUserError('You do not have permission to buy lottery tickets.');
+  }
+
+  if (args.amount < 1) {
+    throw new TakaroUserError('You must buy at least 1 ticket.');
+  }
+
+  const tickets = (
+    await takaro.variable.variableControllerSearch({
+      filters: {
+        gameServerId: [gameServerId],
+        key: [varKey],
+        moduleId: [mod.moduleId],
+        playerId: [pog.playerId],
+      },
+    })
+  ).data.data;
+
+  // Player already has some tickets bought
+  if (tickets.length > 0) {
+    const ticketsBought = tickets[0];
+
+    const ticketsBoughtAmount = parseInt(JSON.parse(ticketsBought.value).amount, 10);
+
+    await takaro.variable.variableControllerUpdate(ticketsBought.id, {
+      key: varKey,
+      playerId: pog.playerId,
+      moduleId: mod.moduleId,
+      gameServerId,
+      value: JSON.stringify({ amount: ticketsBoughtAmount + args.amount }),
+    });
+  }
+  // Player has no tickets bought
+  else {
+    await takaro.variable.variableControllerCreate({
+      key: varKey,
+      value: JSON.stringify({
+        amount: args.amount,
+      }),
+      gameServerId,
+      moduleId: mod.moduleId,
+      playerId: pog.playerId,
+    });
+  }
+
+  const ticketPrice = args.amount * mod.systemConfig.commands.buyTicket.cost;
+
+  // The price of the first ticket is deducted by the command execution itself.
+  if (args.amount > 1) {
+    await takaro.playerOnGameserver.playerOnGameServerControllerDeductCurrency(gameServerId, pog.playerId, {
+      currency: ticketPrice - 1,
+    });
+  }
+
+  const currencyName = (await takaro.settings.settingsControllerGetOne('currencyName', gameServerId)).data.data.value;
+
+  await pog.pm(`You have successfully bought ${args.amount} tickets for ${ticketPrice} ${currencyName}. Good luck!`);
+}
+
+await main();

package/src/modules/lottery/commands/nextDraw.js

@@ -0,0 +1,45 @@
+import { nextCronJobRun, data } from '@takaro/helpers';
+
+function formatTimeToReach(cronJob) {
+  const targetDate = nextCronJobRun(cronJob);
+
+  // Get the current date and time
+  const currentDate = new Date();
+
+  // Calculate the time difference in milliseconds
+  const delta = targetDate - currentDate;
+
+  // Calculate days, hours, minutes, and seconds
+  const days = Math.floor(delta / (1000 * 60 * 60 * 24));
+  const hours = Math.floor((delta % (1000 * 60 * 60 * 24)) / (1000 * 60 * 60));
+  const minutes = Math.floor((delta % (1000 * 60 * 60)) / (1000 * 60));
+  const seconds = Math.floor((delta % (1000 * 60)) / 1000);
+
+  // Build the formatted string
+  let formattedString = '';
+
+  if (days > 0) {
+    formattedString += `${days} day${days > 1 ? 's' : ''} `;
+  }
+
+  if (hours > 0) {
+    formattedString += `${hours} hour${hours > 1 ? 's' : ''} `;
+  }
+
+  if (minutes > 0) {
+    formattedString += `${minutes} minute${minutes > 1 ? 's' : ''} `;
+  }
+
+  if (seconds > 0) {
+    formattedString += `${seconds} second${seconds > 1 ? 's' : ''} `;
+  }
+
+  return formattedString.trim();
+}
+
+async function main() {
+  const { player, module: mod } = data;
+  await player.pm(`The next lottery draw is in about ${formatTimeToReach(mod.systemConfig.cronJobs.drawLottery)}`);
+}
+
+await main();

package/src/modules/lottery/commands/viewTickets.js

@@ -0,0 +1,32 @@
+import { takaro, data, checkPermission, TakaroUserError } from '@takaro/helpers';
+
+async function main() {
+  const { pog, gameServerId, module: mod } = data;
+
+  const varKey = 'lottery_tickets_bought';
+
+  if (!checkPermission(pog, 'LOTTERY_VIEW_TICKETS')) {
+    throw new TakaroUserError('You do not have permission to view lottery tickets.');
+  }
+
+  const tickets = (
+    await takaro.variable.variableControllerSearch({
+      filters: {
+        gameServerId,
+        key: varKey,
+        moduleId: mod.id,
+        playerId: pog.playerId,
+      },
+    })
+  ).data.data;
+
+  let ticketsBought = 0;
+
+  if (tickets.length === 1) {
+    ticketsBought = parseInt(JSON.parse(tickets[0].value).amount, 10);
+  }
+
+  await pog.pm(`You have bought ${ticketsBought} tickets.`);
+}
+
+await main();