@takaro/modules 0.0.0-next.0da151e

package/src/community-modules/README.md

@@ -0,0 +1,5 @@
+# Community modules
+
+This directory contains modules that are not part of the core suite of built in modules, but are contributed by the community. They are not officially supported, but are provided as-is for the community to use and improve.
+
+We welcome contributions to this directory. If you have a module that you would like to contribute, please open a pull request.

package/src/community-modules/modules/vote.json

@@ -0,0 +1,19 @@
+{
+  "commands": [
+    {
+      "function": "\nimport { takaro, data, axios } from '@takaro/helpers';\nasync function main() {\n  const { pog } = data;\n  const playerRes = await takaro.player.playerControllerGetOne(data.player.id);\n  const steamId = playerRes.data.data.steamId;\n  const xboxLiveId = playerRes.data.data.xboxLiveId;\n  const name = playerRes.data.data.name;\n  const key = data.module.userConfig.votekey;\n\n  let voteId = `username=${name}`;\n  if (steamId.startsWith(\"7656\")) { voteId = `steamid=${steamId}`; }\n\n\n  const res = await axios.get(`https://7daystodie-servers.com/api/?object=votes&element=claim&key=${key}&${voteId}`);\n  if (res.data == 0) { data.player.pm(data.module.userConfig.didntvote); }\n  if (res.data == 2) { data.player.pm(data.module.userConfig.alreadyvoted); }\n  if (res.data == 1) {\n\n    const claimresponse = await axios.post(`https://7daystodie-servers.com/api/?action=post&object=votes&element=claim&key=${key}&${voteId}`);\n    if (claimresponse.data == 1) {\n      if (data.module.userConfig.votednow.toLowerCase() !== 'none' && data.module.userConfig.votednow.toLowerCase() !== '\"none\"') { data.player.pm(data.module.userConfig.votednow); }\n      if (data.module.userConfig.publicMessage.toLowerCase() !== 'none' && data.module.userConfig.publicMessage.toLowerCase() !== '\"none\"') {\n        const originalMessage = data.module.userConfig.publicMessage;\n        const modifiedMessage = originalMessage.replace(/\\{name\\}/g, name);\n        await takaro.gameserver.gameServerControllerExecuteCommand(data.gameServerId, { command: `say \"${modifiedMessage}\"` });\n      }\n      await takaro.playerOnGameserver.playerOnGameServerControllerAddCurrency(data.gameServerId, pog.playerId, { currency: data.module.userConfig.currency });\n      for (const stuff of data.module.userConfig.giveStuff) {\n        if (voteId.startsWith(`steamid`)) {\n          await takaro.gameserver.gameServerControllerExecuteCommand(data.gameServerId, { command: `giveplus Steam_${steamId} ${stuff}` });\n        } else {\n          await takaro.gameserver.gameServerControllerExecuteCommand(data.gameServerId, { command: `giveplus ${xboxLiveId} ${stuff}` });\n        }\n      }\n    }\n  }\n}\n\n\n\nawait main();",
+      "name": "vote",
+      "trigger": "vote",
+      "helpText": "Vote for the server and give players rewards.",
+      "arguments": []
+    }
+  ],
+  "hooks": [],
+  "cronJobs": [],
+  "functions": [],
+  "permissions": [],
+  "name": "Vote",
+  "description": "Takaro Vote Module",
+  "configSchema": "{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"type\":\"object\",\"required\":[\"votekey\",\"didntvote\",\"alreadyvoted\"],\"additionalProperties\":false,\"properties\":{\"votekey\":{\"title\":\"votekey\",\"description\":\"Votekey from website\",\"default\":\"\",\"type\":\"string\"},\"didntvote\":{\"title\":\"didntvote\",\"description\":\"Message to send to the player when voting site reports no vote was cast.\",\"default\":\"You haven't voted yet.\",\"type\":\"string\"},\"alreadyvoted\":{\"title\":\"alreadyvoted\",\"description\":\"Message to send to the player when voting site reports the vote was already claimed.\",\"default\":\"You have already claimed your last vote.\",\"type\":\"string\"},\"votednow\":{\"title\":\"votednow\",\"description\":\"Optional message to send to the player when vote is successful. \\nUse \\\"none\\\" as the message if you want nothing to be sent instead.\",\"default\":\"Thanks for voting.\",\"type\":\"string\"},\"publicMessage\":{\"title\":\"publicMessage\",\"description\":\"Optional message to broadcast to all players online when vote is successful. Use {name} in the message to refer to the player name.\\nUse \\\"none\\\" as the message if you want nothing to be sent instead.\",\"default\":\"[FF0000]{name}[-] voted at 7daystodie-servers.com and was rewarded Takaro Coins!\",\"type\":\"string\"},\"giveStuff\":{\"title\":\"giveStuff\",\"description\":\"Items to give to the player thru giveplus command. Must indicate quantities and, if applies, quality:\\n<item name> <amount> [<quality> <usedTimes>]\\n\\nItem name has to be the exact name of an item as listed by \\\"listitems\\\".\\n\\nQuality is the quality of the dropped items for items that have a quality.\\n\\nusedTimes is the % that the item was used.\\n\\nThe default value is giving 2 waters and a tier 6 stone axe with no use. If you are going to copy/paste, include the arguments. \",\"default\":[\"drinkJarBoiledWater 2\",\"meleeToolRepairT0StoneAxe 1 6 0\"],\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"currency\":{\"title\":\"currency\",\"description\":\"How much currency to add to the player in Takaro\",\"default\":0,\"type\":\"number\"}}}",
+  "uiSchema": "{}"
+}

package/src/dto/base.ts

@@ -0,0 +1,13 @@
+import { TakaroDTO } from '@takaro/util';
+import { IsISO8601, IsString } from 'class-validator';
+import { EventTypes } from './index.js';
+import { Exclude } from 'class-transformer';
+
+export class BaseEvent<T> extends TakaroDTO<T> {
+  @IsISO8601()
+  timestamp: string = new Date().toISOString();
+
+  @IsString()
+  @Exclude({ toPlainOnly: true })
+  type: EventTypes;
+}

package/src/dto/discordEvents.ts

@@ -0,0 +1,69 @@
+import { IsBoolean, IsEnum, IsString, ValidateNested } from 'class-validator';
+import { Type } from 'class-transformer';
+import { TakaroDTO } from '@takaro/util';
+import { ValueOf } from 'type-fest';
+import { BaseEvent } from './base.js';
+
+export const DiscordEvents = {
+  DISCORD_MESSAGE: 'discord-message',
+} as const;
+
+export class BaseDiscordEvent<T> extends BaseEvent<T> {
+  @IsEnum(DiscordEvents)
+  declare type: ValueOf<typeof DiscordEvents>;
+
+  @IsString()
+  msg: string;
+}
+
+export class EventDiscordUser extends TakaroDTO<EventDiscordUser> {
+  @IsString()
+  id: string;
+
+  @IsString()
+  username: string;
+
+  @IsString()
+  displayName: string;
+
+  @IsBoolean()
+  isBot: boolean;
+
+  @IsBoolean()
+  isTakaroBot: boolean;
+}
+
+export class EventDiscordChannel extends TakaroDTO<EventDiscordChannel> {
+  @IsString()
+  id: string;
+
+  @IsString()
+  name: string;
+}
+
+export class HookEventDiscordMessage extends BaseEvent<HookEventDiscordMessage> {
+  @IsString()
+  type = DiscordEvents.DISCORD_MESSAGE;
+
+  @IsString()
+  msg: string;
+
+  @ValidateNested()
+  @Type(() => EventDiscordUser)
+  author: EventDiscordUser;
+
+  @ValidateNested()
+  @Type(() => EventDiscordChannel)
+  channel: EventDiscordChannel;
+}
+
+export function isDiscordMessageEvent(a: unknown): a is HookEventDiscordMessage {
+  if (typeof a === 'object' && a !== null) {
+    return 'type' in a && a.type === DiscordEvents.DISCORD_MESSAGE;
+  }
+  return false;
+}
+
+export const DiscordEventsMapping = {
+  [DiscordEvents.DISCORD_MESSAGE]: HookEventDiscordMessage,
+} as const;

package/src/dto/gameEvents.ts

@@ -0,0 +1,159 @@
+import { IsEnum, IsString, ValidateNested, IsOptional, IsNumber, Matches } from 'class-validator';
+import { TakaroDTO } from '@takaro/util';
+import { Type } from 'class-transformer';
+import { BaseEvent } from './base.js';
+import { ValueOf } from 'type-fest';
+
+export const GameEvents = {
+  LOG_LINE: 'log',
+  PLAYER_CONNECTED: 'player-connected',
+  PLAYER_DISCONNECTED: 'player-disconnected',
+  CHAT_MESSAGE: 'chat-message',
+  PLAYER_DEATH: 'player-death',
+  ENTITY_KILLED: 'entity-killed',
+} as const;
+
+export type GameEventTypes = ValueOf<typeof GameEvents>;
+
+export class IGamePlayer extends TakaroDTO<IGamePlayer> {
+  /**
+   * Unique identifier for this player, as used by the game
+   */
+  @IsString()
+  gameId!: string;
+  /**
+   * The players username
+   */
+  @IsString()
+  name!: string;
+
+  @IsString()
+  @IsOptional()
+  steamId?: string;
+
+  @IsString()
+  @IsOptional()
+  epicOnlineServicesId?: string;
+
+  @IsString()
+  @IsOptional()
+  xboxLiveId?: string;
+
+  @IsString()
+  @IsOptional()
+  @Matches(/^[a-zA-Z0-9_-]+:[a-zA-Z0-9_-]+$/, {
+    message: "Platform ID must be in format 'platform:id' (e.g., 'minecraft:player-uuid')",
+  })
+  platformId?: string;
+
+  @IsString()
+  @IsOptional()
+  ip?: string;
+
+  @IsNumber()
+  @IsOptional()
+  ping?: number;
+}
+
+export class BaseGameEvent<T> extends BaseEvent<T> {
+  @IsEnum(GameEvents)
+  declare type: ValueOf<typeof GameEvents>;
+
+  @IsString()
+  @IsOptional()
+  msg: string;
+}
+
+export class EventLogLine extends BaseGameEvent<EventLogLine> {
+  @IsString()
+  type = GameEvents.LOG_LINE;
+}
+
+export class EventPlayerConnected extends BaseGameEvent<EventPlayerConnected> {
+  type = GameEvents.PLAYER_CONNECTED;
+  @ValidateNested()
+  @Type(() => IGamePlayer)
+  player: IGamePlayer;
+}
+
+export class EventPlayerDisconnected extends BaseGameEvent<EventPlayerDisconnected> {
+  type = GameEvents.PLAYER_DISCONNECTED;
+  @ValidateNested()
+  @Type(() => IGamePlayer)
+  player: IGamePlayer;
+}
+
+export enum ChatChannel {
+  GLOBAL = 'global',
+  TEAM = 'team',
+  FRIENDS = 'friends',
+  WHISPER = 'whisper',
+}
+
+export class EventChatMessage extends BaseGameEvent<EventChatMessage> {
+  type = GameEvents.CHAT_MESSAGE;
+  @ValidateNested()
+  @Type(() => IGamePlayer)
+  player?: IGamePlayer;
+
+  @IsEnum(Object.values(ChatChannel))
+  channel: ChatChannel;
+
+  @ValidateNested()
+  @Type(() => IGamePlayer)
+  @IsOptional()
+  recipient?: IGamePlayer;
+
+  declare msg: string;
+}
+
+export class IPosition extends TakaroDTO<IPosition> {
+  @IsNumber()
+  x: number;
+  @IsNumber()
+  y: number;
+  @IsNumber()
+  z: number;
+  @IsString()
+  @IsOptional()
+  dimension?: string;
+}
+
+export class EventPlayerDeath extends BaseGameEvent<EventPlayerDeath> {
+  type = GameEvents.PLAYER_DEATH;
+  @ValidateNested()
+  @Type(() => IGamePlayer)
+  player: IGamePlayer;
+
+  @IsOptional()
+  @ValidateNested()
+  @Type(() => IGamePlayer)
+  attacker?: IGamePlayer;
+
+  @IsOptional()
+  @ValidateNested()
+  @Type(() => IPosition)
+  position: IPosition;
+}
+
+export class EventEntityKilled extends BaseGameEvent<EventEntityKilled> {
+  type = GameEvents.ENTITY_KILLED;
+  @ValidateNested()
+  @Type(() => IGamePlayer)
+  player: IGamePlayer;
+
+  @IsString()
+  entity: string;
+
+  @IsString()
+  weapon: string;
+}
+
+export const GameEventsMapping = {
+  [GameEvents.PLAYER_CONNECTED]: EventPlayerConnected,
+  [GameEvents.PLAYER_DISCONNECTED]: EventPlayerDisconnected,
+  [GameEvents.CHAT_MESSAGE]: EventChatMessage,
+  [GameEvents.PLAYER_DEATH]: EventPlayerDeath,
+  [GameEvents.ENTITY_KILLED]: EventEntityKilled,
+  [GameEvents.LOG_LINE]: EventLogLine,
+} as const;

package/src/dto/index.ts

@@ -0,0 +1,25 @@
+import { DiscordEvents, DiscordEventsMapping } from './discordEvents.js';
+import { GameEvents, GameEventsMapping } from './gameEvents.js';
+import { TakaroEvents, TakaroEventsMapping } from './takaroEvents.js';
+import { ValueOf } from 'type-fest';
+import { BaseEvent } from './base.js';
+
+export * from './discordEvents.js';
+export * from './gameEvents.js';
+export * from './takaroEvents.js';
+export * from './base.js';
+
+export const HookEvents = {
+  ...GameEvents,
+  ...DiscordEvents,
+  ...TakaroEvents,
+} as const;
+
+export const EventMapping: Record<EventTypes, typeof BaseEvent<any>> = {
+  ...GameEventsMapping,
+  ...DiscordEventsMapping,
+  ...TakaroEventsMapping,
+} as const;
+
+export type EventPayload = ValueOf<(typeof EventMapping)[ValueOf<typeof HookEvents>]>;
+export type EventTypes = ValueOf<typeof HookEvents>;