@m3rcena/weky

v14.27.0-1

Published

6 days ago

The ultimate Discord minigames engine with blazingly fast @napi-rs/canvas graphics, hybrid Slash/Message support, and zero external dependencies.

0High
0Medium
0Low

d4rk.s0ul

weky m3rcena discord-games discord-minigames discord.js discord.js-v14 canvas napi-rs-canvas game-engine slash-commands discord-bot

⚡ What's New in v14.27.0?

Versioning Notice: @m3rcena/weky strictly mirrors the version numbering of discord.js (currently 14.27.0). Whenever Discord.js releases updates, @m3rcena/weky releases an identical version to ensure 100% API parity, zero peer-dependency conflicts, and instantaneous support for Discord's newest features like Components V2.

The original weky relied on external backend servers and database round-trips for rendering canvas images and managing states. Version 14.27.0 is a complete, ground-up rewrite designed for maximum speed, security, and developer ergonomics.

📚 Complete Documentation & Changelog

Looking for exhaustive options, callback signatures, headless engine hooks, or canvas rendering methods for all 17 minigames?

📖 Read the Full Documentation (DOCUMENTATION.md)
📋 View Version History & Changelog (CHANGELOG.md)

📦 Installation

npm install @m3rcena/weky @napi-rs/canvas discord.js
# or
yarn add @m3rcena/weky @napi-rs/canvas discord.js
# or
pnpm add @m3rcena/weky @napi-rs/canvas discord.js

🚀 Quick Start

1. Initialize the Weky Manager

import { Client, GatewayIntentBits } from "discord.js";
import { WekyManager } from "@m3rcena/weky";

const client = new Client({
  intents: [GatewayIntentBits.Guilds, GatewayIntentBits.GuildMessages, GatewayIntentBits.MessageContent, GatewayIntentBits.GuildMessageTyping],
});

let weky: WekyManager;

client.once("ready", (c) => {
  console.log(`✅ ${c.user.tag} is online!`);
  // Initialize Weky with custom brand color, timeout, and update notifier
  weky = new WekyManager(c, {
    embedColor: "#5865F2", // Default brand color for all games
    defaultTimeout: 60_000, // Default timeout (ms)
    notifyUpdates: true, // Alerts in console when a new package version is on npm
  });
});

client.login("YOUR_BOT_TOKEN");

2. Run Games (Works with Slash Commands & Messages)

Our universal ContextAdapter works automatically with ChatInputCommandInteraction, ButtonInteraction, or standard Message!

// Inside your Slash Command or Message event:
await weky.create2048({
  context: interaction, // or message
  embed: {
    title: "2048 Challenge",
    color: "#5865F2", // Accepts Hex, Number (0x5865F2), or Discord color names
  },
});

3. Terminal Update Notifier Box

When notifyUpdates is enabled (default), Weky automatically checks the npm registry in the background and alerts you in your console if an update is available:

┌─────────────────────────────────────────────────────────────┐
│                                                             │
│         New version of @m3rcena/weky is available!          │
│                     14.27.0 -> 14.28.0                      │
│    Registry: https://www.npmjs.com/package/@m3rcena/weky    │
│         Run npm i @m3rcena/[email protected] to update!          │
│                                                             │
└─────────────────────────────────────────────────────────────┘

🎮 Available Minigames (17 Games)

📖 Detailed Game Examples

🟢 1. 2048

Slide numbered tiles on a 4x4 grid using directional buttons. Built-in high performance canvas rendering.

await weky.create2048({
  context: interaction,
  embed: { title: "2048 Arcade", color: "Blurple" },
  time: 120_000,
});

🐍 2. Snake

Play the classic snake arcade game directly inside Discord. Features directional movement, glowing apple generation, collision detection, and score tracking.

await weky.createSnake({
  context: interaction,
  gridSize: 15,
  embed: { title: "Retro Snake", color: "Green" },
});

⚔️ 3. Turn-Based RPG Fight

Challenge an opponent to a duel! Includes HP bars, coin collection, regular and heavy attacks, heals, shield power-ups, double damage buffs, and surrender options.

const opponent = interaction.options.getUser("opponent");

await weky.createFight({
  context: interaction,
  opponent: opponent,
  embed: { title: "Battle Arena" },
});

🔎 4. Who's That Pokémon?

Generates a dark Pokémon silhouette on an authentic Pokédex card. Players guess via chat or modal, revealing the vibrant full-color Pokémon upon victory or timeout!

await weky.createGuessThePokemon({
  context: interaction,
  embed: { title: "Who's That Pokémon?" },
  time: 60_000,
});

🪢 5. Hangman

Features realistic wooden gallows and stickman drawing. Supports categories like Animals, Countries, Technology, Gaming, and Food, or custom words!

await weky.createHangman({
  context: interaction,
  category: "Technology", // or custom word: { word: "DISCORD" }
});

🔢 6. Scientific Calculator

A safe, full-featured Discord calculator with standard digits, brackets, power, sqrt, trigonometric functions (sin, cos, tan), log, and modal formula inputs.

await weky.createCalculator({
  context: interaction,
  embed: { title: "Scientific Calculator", color: "Blurple" },
});

⚡ 7. Fast Type

Calculate exact Words Per Minute (WPM) with easy, medium, or hard difficulty text.

await weky.createFastType({
  context: interaction,
  difficulty: "medium", // 'easy' | 'medium' | 'hard'
});

🌐 Web Dashboard & Headless Engines

@m3rcena/weky isn't just for Discord bots! You can power web dashboards, mobile apps, Electron desktop apps, and REST/WebSocket APIs with our headless game engines and standalone canvas hub—with zero Discord dependencies required.

🎮 Headless Engine Factory (`WekyEngine`)

Run game logic, handle moves, and extract framework-agnostic UI control schemas:

import { WekyEngine } from "@m3rcena/weky";

// 1. Initialize Headless 2048 Game
const game2048 = WekyEngine.game2048();

// Move tiles ("UP" | "DOWN" | "LEFT" | "RIGHT")
game2048.move("LEFT");

// Current game state
console.log(game2048.getState());
// -> { board: [[2, 4, ...], ...], score: 64, isGameOver: false, isWon: false }

// Universal UI Controls Schema (ideal for React, Vue, Svelte, or HTML buttons)
const controls = game2048.getControls();
// -> [{ components: [{ id: "UP", label: "▲", style: "primary", disabled: false }] }]

// Render high-res canvas directly to web-ready Data URL
const cardDataUrl = await game2048.renderDataURL();
// -> "data:image/png;base64,iVBORw0KGgoAAAANSUh..."

🎨 Direct Canvas Rendering (`WekyCanvas`)

Render any minigame card directly into PNG buffers, base64 strings, or data URLs:

import { WekyCanvas } from "@m3rcena/weky";

// Render Battle Card between two players
const buffer = await WekyCanvas.fight.battle({ id: "1", username: "Knight", avatarUrl: "https://...", health: 85, coins: 30 }, { id: "2", username: "Dragon", avatarUrl: "https://...", health: 40, coins: 15 }, "1", "Knight used Heavy Attack for 28 damage!");

// Convert to web-ready Data URL for <img src="..." />
const dataUrl = WekyCanvas.toDataURL(buffer);

💡 Pure JavaScript Type Safety & Autocomplete

Using vanilla JavaScript instead of TypeScript? You still get 100% strict autocomplete, inline hover docs, and IntelliSense in VS Code, WebStorm, and Cursor!

No type annotations needed in your code: Write standard CommonJS require or ESM import.
Zero build step required for JS consumers: Emitted .cjs and .js code is pure JavaScript.
Rich parameter suggestions: Full option types, emojis, and callback signatures autocomplete automatically via bundled .d.ts and .d.mts declaration maps.

🛠️ Testing & Development

Run the automated verification suite across all math parsers, canvas renderers, Components V2, and headless dashboard engines:

npm run test

Start the interactive testing bot:

npm run test:bot

Build dual ESM/CJS distribution:

npm run build

📄 License

Distributed under the Apache-2.0 License. See LICENSE for details.