Deploying to gh-pages from @ caf28ae 🚀

package.json

@@ -1,6 +1,6 @@
 {
   "name": "eco.js",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "type": "module",
   "main": "./lib/index.js",
   "module": "./lib/index.js",
@@ -9,7 +9,8 @@
   "scripts": {
     "build": "tsc",
     "lint": "npx eslint ./src/ --fix && prettier ./src --write",
-    "document": "npx typedoc ./src/index.ts --includeVersion"
+    "document": "npx typedoc ./src/index.ts --includeVersion",
+    "test": "vitest"
   },
   "keywords": [
     "RCON",

src/Core/Utils/ColorUtils.ts

@@ -0,0 +1 @@
+export class TextColor {}

src/Core/Utils/TextUtils.ts

@@ -0,0 +1,149 @@
+import { ControlInput } from '../../Definitions/ControlInput';
+
+export const alpha = (text: string, opacity: number) =>
+  `<alpha=${
+    typeof opacity === 'number' ? `#${opacity.toString(16)}` : opacity
+  }>${text}</alpha>`;
+/**
+ * Make the given text Bold
+ */
+export const bold = (text: string) => `<b>${text}</b>`;
+/**
+ * Color the given text
+ * @param text Text to color
+ * @param color Hex code or defined color
+ * @returns
+ */
+export const color = (
+  text: string,
+  color:
+    | `#${string}`
+    | (
+        | 'black'
+        | 'blue'
+        | 'green'
+        | 'orange'
+        | 'purple'
+        | 'red'
+        | 'white'
+        | 'yellow'
+      ),
+) => `<color=${color}>${text}</color>`;
+/**
+ * cspace allows you to adjust character spacing, either absolute or relative to the original font Asset. You can use pixels or font units.
+ */
+export const cspace = (text: string, spacing: `${number}${'px' | 'em'}`) =>
+  `<cspace=${spacing}>${text}</cspace>`;
+/**
+ * Make the given text Italic
+ */
+export const italic = (text: string) => `<i>${text}</i>`;
+export const uppercase = (text: string) => `<uppercase>${text}</uppercase>`;
+export const lowercase = (text: string) => `<lowercase>${text}</lowercase>`;
+export const smallcaps = (text: string) => `<smallcaps>${text}</smallcaps>`;
+export const mark = (text: string, color: string, opacity: number = 0xaa) =>
+  `<mark=${color}${opacity.toString(16)}>${text}</mark>`;
+export const mspace = (text: string, spacing: `${number}${'px' | 'em'}`) =>
+  `<mspace=${spacing}>${text}</mspace>`;
+export const size = (
+  text: string,
+  size:
+    | `${number}%`
+    | `${'+' | '-'}${number}`
+    | `${number}${'px' | 'em'}`
+    | number,
+) => `<size=${size}>${text}</size>`;
+/**
+ * Use the <voffset> tag to offset the text baseline vertically. This adjusts the line height accordingly to accommodate the text's offset position. You can compensate for that adjustment by manually adjusting the line height.
+ */
+export const voffset = (
+  text: string,
+  spacing: `${'' | '-'}${number}${'px' | 'em'}`,
+) => `<voffset=${spacing}>${text}</voffset>`;
+/**
+ * Make the given text Underlined
+ */
+export const underline = (text: string) => `<u>${text}</u>`;
+/**
+ * Make the given text Strikethrough
+ */
+export const strikethrough = (text: string) => `<s>${text}</s>`;
+/**
+ * Make the given text Subscript
+ */
+export const subscript = (text: string) => `<sub>${text}</sub>`;
+/**
+ * Make the given text Superscript
+ */
+export const superscript = (text: string) => `<sup>${text}</sup>`;
+/**
+ * Make a Linebreak
+ */
+export const linebreak = () => `<br>`;
+/**
+ * Align the given text. Does not work in chat.
+ */
+export const align = (
+  alignment: 'left' | 'right' | 'center' = 'left',
+  text: string,
+) => `<align=${alignment}>${text}</align>`;
+/**
+ * Force the text on a single line without line breaks
+ */
+export const nobreak = (text: string) => `<nobr>${text}</nobr>`;
+/**
+ * Any text given will NOT be parsed.
+ */
+export const noparse = (text: string) => `<noparse>${text}</noparse>`;
+/**
+ * Create a Hover menu
+ * @param linktext Text to hover the mouse on
+ * @param title Title of the window
+ * @param body Contents of the Window
+ */
+export const foldout = (linktext: string, title: string, body: string) =>
+  `<foldout><linktext>${linktext}</linktext><title>${title}</title>${body}</foldout>`;
+
+export const hotkey = (control: ControlInput) => `<hotkey name="${control}">`;
+
+//? Shorthands
+/**
+ * Make the given text Bold
+ * Shorthand of `bold`
+ */
+export const b = bold;
+/**
+ * Make the given text Italic
+ * Shorthand of `italic`
+ */
+export const i = italic;
+/**
+ * Make the given text Underlined
+ * Shorthand of `underline`
+ */
+export const u = underline;
+/**
+ * Make the given text Strikethrough
+ * Shorthand of `strikethrough`
+ */
+export const s = strikethrough;
+/**
+ * Make the given text Subscript
+ * Shorthand of `subscript`
+ */
+export const sub = subscript;
+/**
+ * Make the given text Superscript
+ * Shorthand of `superscript`
+ */
+export const sup = superscript;
+/**
+ * Make a Linebreak
+ * Shorthand of `linebreak`
+ */
+export const lb = linebreak;
+/**
+ * Force the text on a single line without line breaks
+ * Shorthand of `nobreak`
+ */
+export const nobr = nobreak;

src/Definitions/ControlInput.ts

@@ -0,0 +1,116 @@
+export enum ControlInput {
+  Vertical = 'Vertical',
+  Horizontal = 'Horizontal',
+  Alt = 'Alt',
+  Ctrl = 'Ctrl',
+  MouseX = 'MouseX',
+  MouseY = 'MouseY',
+  MouseWheel = 'MouseWheel',
+  /** Look Left/Right */
+  LookLeftRight = 'LookLeftRight',
+  /** Look Down/Up */
+  LookDownUp = 'LookDownUp',
+  Jump = 'Jump',
+  Sprint = 'Sprint',
+  /** Auto Moving */
+  AutoMoving = 'AutoMoving',
+  /** Dive/Sneak */
+  Crouch = 'Crouch',
+  ToggleCursor = 'ToggleCursor',
+  Interact = 'Interact',
+  /** Use Tool */
+  InteractLeft = 'InteractLeft',
+  /** Place Block */
+  InteractRight = 'InteractRight',
+  /** Rotate Right */
+  RotateClockwise = 'RotateClockwise',
+  /** Rotate Left */
+  RotateCounterClockwise = 'RotateCounterClockwise',
+  /** Select Construct */
+  SelectConstruct = 'SelectConstruct',
+  /** Third Person View Toggle */
+  ThirdPerson = 'ThirdPerson',
+  /** Avatar Observation Toggle */
+  CameraPositionSwitch = 'CameraPositionSwitch',
+  /** Perspective Zoom */
+  Zoom = 'Zoom',
+  /** Push To Talk */
+  PushToTalk = 'PushToTalk',
+  /** Show/Hide Markers */
+  ShowHideMarkers = 'ShowHideMarkers',
+  /** Split Stack/Add Labor (100) */
+  ShiftInputModifier = 'ShiftInputModifier',
+  /** Add Labor (500) */
+  CtrlInputModifier = 'CtrlInputModifier',
+  /** Add Labor (3000) */
+  AltInputModifier = 'AltInputModifier',
+  /** Slot 0 */
+  ToolSlot0 = 'ToolSlot0',
+  /** Slot 1 */
+  ToolSlot1 = 'ToolSlot1',
+  /** Slot 2 */
+  ToolSlot2 = 'ToolSlot2',
+  /** Slot 3 */
+  ToolSlot3 = 'ToolSlot3',
+  /** Slot 4 */
+  ToolSlot4 = 'ToolSlot4',
+  /** Slot 5 */
+  ToolSlot5 = 'ToolSlot5',
+  /** Slot 6 */
+  ToolSlot6 = 'ToolSlot6',
+  /** Slot 7 */
+  ToolSlot7 = 'ToolSlot7',
+  /** Slot 8 */
+  ToolSlot8 = 'ToolSlot8',
+  /** Slot 9 */
+  ToolSlot9 = 'ToolSlot9',
+  ActionbarSkills = 'ActionbarSkills',
+  /** Backpack */
+  ActionbarBackpack = 'ActionbarBackpack',
+  /** Chat Log */
+  ActionbarChatLog = 'ActionbarChatLog',
+  /** Switch Chat tabs */
+  SwitchChatTabs = 'SwitchChatTabs',
+  /** Map */
+  ActionbarMap = 'ActionbarMap',
+  /** Toggle Notification Panel */
+  Notification = 'Notification',
+  /** Objectives */
+  ActionbarObjectives = 'ActionbarObjectives',
+  /** Economy Viewer */
+  ActionbarEconomyViewer = 'ActionbarEconomyViewer',
+  /** Graphs */
+  ActionbarGraphs = 'ActionbarGraphs',
+  /** Government */
+  ActionbarGovernment = 'ActionbarGovernment',
+  /** Tech Tree Visualizer */
+  ActionbarTechTreeVisualizer = 'ActionbarTechTreeVisualizer',
+  /** Perform Store Trade */
+  PerformStoreTrade = 'PerformStoreTrade',
+  /** Ecopedia */
+  Ecopedia = 'Ecopedia',
+  VehicleTool = 'VehicleTool',
+  /** Vehicle Alternative Controls */
+  VehicleAltControl = 'VehicleAltControl',
+  /** Vehicle Boom Down/Up */
+  VehicleBoomDownUp = 'VehicleBoomDownUp',
+  /** Vehicle Boom Pull/Push */
+  VehicleBoomPoolPush = 'VehicleBoomPoolPush',
+  VehicleScoopRotate = 'VehicleScoopRotate',
+  /** Vehicle Swing Arm Down/Up */
+  VehicleSwingArmDownUp = 'VehicleSwingArmDownUp',
+  /** Vehicle Ramps Down/Up */
+  VehicleRampsDownUp = 'VehicleRampsDownUp',
+  /** Vehicle Fishing */
+  VehicleFishing = 'VehicleFishing',
+  SkidSteerScoopRotate = 'SkidSteerScoopRotate',
+  CraneRopeLength = 'CraneRopeLength',
+  /** Vehicle Honk */
+  VehicleHonk = 'VehicleHonk',
+  /** Toggle Lights */
+  ToggleLights = 'ToggleLights',
+  /** Boat Fishnet Down/Up */
+  BoatNetDownUp = 'BoatNetDownUp',
+  /** Chat Log */
+  ChatZenMode = 'ChatZenMode',
+}

src/index.ts

@@ -2,3 +2,4 @@ export * as Plugins from './Plugins/index.js';
 export { default as ECO } from './Core/ECO.js';
 export * as Controllers from './Core/Controllers/index.js';
 export * as DTO from './Core/Shared/index.js';
+export * as TextUtils from './Core/Utils/TextUtils.js';

test/testing.test.ts

@@ -1,5 +1,5 @@
-import { describe, expect, it, vi } from 'vitest.js';
-import { ECO } from '../src/.js';
+import { describe, expect, it, vi } from 'vitest';
+import { ECO } from '../src/index.js';
 describe('Posts a message', () => {
   it('Posts a message', async () => {
     const server = new ECO();

vitest.config.ts

@@ -1,4 +1,4 @@
-import { defineConfig } from 'vitest/config.js';
+import { defineConfig } from 'vitest/config';
 import 'dotenv/config';
 export default defineConfig({
   test: {