@dimzxzzx07/mc-headless 1.0.0 → 1.2.0

package/README.md

@@ -0,0 +1,1186 @@
+@dimzxzzx07/mc-headless
+
+<div align="center">
+    <img src="https://i.imgur.com/LIQuuPL.jpeg" width="800" alt="Minecraft Headless Server">
+</div>
+
+<div align="center">
+    <img src="https://img.shields.io/badge/Version-1.0.0-2563eb?style=for-the-badge&logo=typescript" alt="Version">
+    <img src="https://img.shields.io/badge/License-UNLICENSED-dc2626?style=for-the-badge&logo=licenses" alt="License">
+    <img src="https://img.shields.io/badge/Node-18%2B-339933?style=for-the-badge&logo=nodedotjs" alt="Node">
+    <img src="https://img.shields.io/badge/Java-17%2B-007396?style=for-the-badge&logo=openjdk" alt="Java">
+    <img src="https://img.shields.io/badge/Termux-Friendly-00A98F?style=for-the-badge&logo=termux" alt="Termux">
+</div>
+
+<div align="center">
+    <a href="https://t.me/Dimzxzzx07">
+        <img src="https://img.shields.io/badge/Telegram-Dimzxzzx07-26A5E4?style=for-the-badge&logo=telegram&logoColor=white" alt="Telegram">
+    </a>
+    <a href="https://github.com/Dimzxzzz">
+        <img src="https://img.shields.io/badge/GitHub-Dimzxzzx07-181717?style=for-the-badge&logo=github&logoColor=white" alt="GitHub">
+    </a>
+    <a href="#">
+        <img src="https://img.shields.io/badge/Documentation-Read-8B5CF6?style=for-the-badge&logo=gitbook&logoColor=white" alt="Documentation">
+    </a>
+    <a href="#">
+        <img src="https://img.shields.io/badge/Download-NPM-CB3837?style=for-the-badge&logo=npm&logoColor=white" alt="NPM">
+    </a>
+</div>
+
+---
+
+ Table of Contents
+
+· Overview
+· Features
+· Why MC-Headless?
+· Installation
+· Quick Start
+· Configuration Guide
+· API Reference
+· Usage Examples
+· Server Types
+· Platform Options
+· Memory Management
+· Network Settings
+· World Configuration
+· Folder Structure
+· Backup System
+· Event System
+· Commands
+· Player Management
+· Cross-Play (Geyser)
+· Termux Setup
+· Troubleshooting
+· Contributing
+· License
+
+---
+
+Overview
+
+MC-Headless is a powerful Node.js library that simplifies running Minecraft servers (Java, Bedrock, or Cross-play) with a clean, promise-based API. No more dealing with complex Java commands, server.properties files, or manual downloads - just simple JavaScript methods.
+
+Built specifically for developers, sysadmins, and Minecraft enthusiasts who want to automate server management, run headless servers on VPS/Termux, or integrate Minecraft servers into their applications.
+
+---
+
+Features
+
+Category Features
+Server Types Paper, Purpur, Vanilla, Spigot, Forge, Fabric
+Platforms Java Edition, Bedrock Edition, Cross-play (Geyser)
+Auto Setup Automatic Java detection, EULA acceptance, server.properties generation
+Downloader Automatic download of server jars from official sources
+Memory Management Custom memory allocation, Aikar's flags optimization
+Backup System Automatic scheduled backups, manual backup triggers
+Monitoring Real-time CPU/memory usage, player tracking, server events
+Cross-play Built-in Geyser & Floodgate support for Bedrock clients
+Termux Friendly Optimized for Android/Termux environments
+Headless Ready No GUI required, perfect for servers and automation
+
+---
+
+Why MC-Headless?
+
+Before (Manual Setup)
+
+```bash
+# Download server jar
+wget https://api.papermc.io/v2/projects/paper/versions/1.20.1/builds/196/downloads/paper-1.20.1-196.jar
+
+# Accept EULA
+echo "eula=true" > eula.txt
+
+# Create server.properties
+echo "server-port=25565" > server.properties
+echo "max-players=20" >> server.properties
+
+# Run server with complex Java flags
+java -Xms1G -Xmx4G -XX:+UseG1GC -jar paper-1.20.1-196.jar nogui
+
+# Monitor manually
+tail -f logs/latest.log
+```
+
+After (MC-Headless)
+
+```typescript
+const server = new MinecraftServer({
+  version: '1.20.1',
+  type: 'paper',
+  memory: { init: '1G', max: '4G' },
+  network: { port: 25565 },
+  world: { maxPlayers: 20 }
+});
+
+server.on('ready', () => console.log('Server ready!'));
+server.on('player-join', (player) => console.log(`${player.name} joined`));
+
+await server.start();
+```
+
+---
+
+Installation
+
+From NPM
+
+```bash
+# Install as dependency
+npm install @dimzxzzx07/mc-headless
+
+# Install globally
+npm install -g @dimzxzzx07/mc-headless
+```
+
+Requirements
+
+Requirement Minimum Recommended
+Node.js 18.0.0 20.0.0 or higher
+Java 17 17 or 21
+RAM 2 GB 4 GB or more
+Storage 1 GB 5 GB
+OS Linux, macOS, Windows, Termux Linux (production)
+
+---
+
+Quick Start
+
+Basic Java Server
+
+```typescript
+import { MinecraftServer } from '@dimzxzzx07/mc-headless';
+
+const server = new MinecraftServer({
+  platform: 'java',
+  version: '1.20.1',
+  type: 'paper',
+  memory: {
+    init: '1G',
+    max: '4G'
+  }
+});
+
+server.on('ready', (info) => {
+  console.log(`
+MC Headless - Powered By Dimzxzzx07
+  Address: ${info.ip}:${info.port}
+  Version: ${info.version} ${info.type}
+  Players: 0/${info.maxPlayers}
+  `);
+});
+
+server.on('player-join', (player) => {
+  console.log(`Player joined: ${player.name}`);
+});
+
+server.on('player-leave', (name) => {
+  console.log(`Player left: ${name}`);
+});
+
+server.start().catch(console.error);
+```
+
+Basic Bedrock Server
+
+```typescript
+import { MinecraftServer } from '@dimzxzzx07/mc-headless';
+
+const server = new MinecraftServer({
+  platform: 'bedrock',
+  version: '1.20.1',
+  network: {
+    port: 19132,
+    motd: 'Bedrock Server'
+  }
+});
+
+server.start();
+```
+
+Cross-Play Server (Java + Bedrock)
+
+```typescript
+import { MinecraftServer } from '@dimzxzzx07/mc-headless';
+
+const server = new MinecraftServer({
+  platform: 'all',
+  version: '1.20.1',
+  type: 'paper',
+  network: {
+    port: 25565,
+    bedrockPort: 19132,
+    motd: 'Cross-Play Server'
+  }
+});
+
+server.start();
+```
+
+---
+
+Configuration Guide
+
+Complete Configuration Example
+
+```typescript
+import { MinecraftServer } from '@dimzxzzx07/mc-headless';
+
+const server = new MinecraftServer({
+  // Platform Selection
+  platform: 'all',                    // 'java', 'bedrock', 'all'
+  version: '1.20.1',                   // Minecraft version
+  type: 'paper',                       // paper, purpur, vanilla, spigot, forge, fabric
+  autoAcceptEula: true,                 // Auto-accept Minecraft EULA
+
+  // Resource Management
+  memory: {
+    init: '1G',                         // Initial memory allocation
+    max: '4G',                           // Maximum memory allocation
+    useAikarsFlags: true                  // Use Aikar's optimized GC flags
+  },
+
+  // Network Settings
+  network: {
+    port: 25565,                          // Java edition port
+    bedrockPort: 19132,                    // Bedrock edition port (for 'all' platform)
+    ip: '0.0.0.0',                         // Bind IP address
+    onlineMode: false,                      // Enable/disable authentication
+    motd: 'Minecraft Server'                 // Server message of the day
+  },
+
+  // World & Difficulty Settings
+  world: {
+    difficulty: 'normal',                    // peaceful, easy, normal, hard
+    hardcore: false,                          // Enable hardcore mode
+    gamemode: 'survival',                      // survival, creative, adventure, spectator
+    seed: 'my-secret-seed',                     // World seed (optional)
+    maxPlayers: 20,                              // Maximum player count
+    viewDistance: 10,                             // Chunk view distance
+    levelName: 'world'                              // World folder name
+  },
+
+  // Folder Management
+  folders: {
+    addons: './addons',        // Bedrock addons folder
+    mods: './mods',            // Forge/Fabric mods folder
+    plugins: './plugins',      // Paper/Spigot plugins folder
+    world: './world'           // World data folder
+  },
+
+  // Server Behavior
+  autoRestart: true,            // Auto-restart on crash
+  backup: {
+    enabled: true,               // Enable automatic backups
+    interval: '24h',              // Backup interval (24h, 12h, 6h, 1h, 30m)
+    path: './backups'              // Backup storage path
+  }
+});
+
+await server.start();
+```
+
+Configuration Options Reference
+
+Platform Options
+
+Option Type Default Description
+platform string 'java' 'java', 'bedrock', or 'all'
+version string '1.20.1' Minecraft version (e.g., '1.20.1', '1.19.4')
+type string 'paper' Server type: paper, purpur, vanilla, spigot, forge, fabric
+autoAcceptEula boolean true Automatically accept Minecraft EULA
+
+Memory Options
+
+Option Type Default Description
+memory.init string '1G' Initial heap size (e.g., '512M', '1G', '2G')
+memory.max string '4G' Maximum heap size (e.g., '2G', '4G', '8G')
+memory.useAikarsFlags boolean true Use Aikar's optimized GC flags
+
+Network Options
+
+Option Type Default Description
+network.port number 25565 Java edition server port
+network.bedrockPort number 19132 Bedrock edition server port
+network.ip string '0.0.0.0' Bind IP address
+network.onlineMode boolean false Enable Mojang authentication
+network.motd string 'Minecraft Server' Message of the day
+
+World Options
+
+Option Type Default Description
+world.difficulty string 'normal' peaceful, easy, normal, hard
+world.hardcore boolean false Enable hardcore mode
+world.gamemode string 'survival' survival, creative, adventure, spectator
+world.seed string undefined World generation seed
+world.maxPlayers number 20 Maximum player count
+world.viewDistance number 10 Chunk view distance
+world.levelName string 'world' World folder name
+
+Folder Options
+
+Option Type Default Description
+folders.addons string './addons' Bedrock addons folder
+folders.mods string './mods' Forge/Fabric mods folder
+folders.plugins string './plugins' Paper/Spigot plugins folder
+folders.world string './world' World data folder
+
+Backup Options
+
+Option Type Default Description
+backup.enabled boolean false Enable automatic backups
+backup.interval string '24h' Backup interval (24h, 12h, 6h, 1h, 30m)
+backup.path string './backups' Backup storage path
+
+---
+
+API Reference
+
+MinecraftServer Class
+
+```typescript
+class MinecraftServer extends EventEmitter {
+  constructor(config: Partial<MinecraftConfig>);
+  
+  // Methods
+  async start(): Promise<ServerInfo>;
+  async stop(): Promise<void>;
+  sendCommand(command: string): void;
+  async getInfo(): Promise<ServerInfo>;
+  getPlayers(): Player[];
+  async backup(type?: 'full' | 'world' | 'plugins'): Promise<string>;
+  
+  // Events
+  on(event: 'ready', listener: (info: ServerInfo) => void): this;
+  on(event: 'stop', listener: (data: { code: number }) => void): this;
+  on(event: 'player-join', listener: (player: Player) => void): this;
+  on(event: 'player-leave', listener: (name: string) => void): this;
+  on(event: 'resource', listener: (info: ServerInfo) => void): this;
+}
+```
+
+ServerInfo Interface
+
+```typescript
+interface ServerInfo {
+  pid: number;                    // Process ID
+  ip: string;                      // Server IP
+  port: number;                     // Server port
+  bedrockPort?: number;              // Bedrock port (if enabled)
+  version: string;                   // Minecraft version
+  type: ServerType;                   // Server type
+  platform: Platform;                  // Platform (java/bedrock/all)
+  players: number;                      // Current players
+  maxPlayers: number;                    // Max players
+  uptime: number;                         // Uptime in seconds
+  memory: {
+    used: number;                          // Used memory in MB
+    max: number;                            // Max memory in MB
+  };
+  status: 'starting' | 'running' | 'stopping' | 'stopped' | 'crashed';
+}
+```
+
+Player Interface
+
+```typescript
+interface Player {
+  name: string;          // Player username
+  uuid: string;          // Player UUID
+  ip: string;            // Player IP address
+  ping: number;          // Player ping in ms
+  connectedAt: Date;     // Connection time
+}
+```
+
+---
+
+Usage Examples
+
+Advanced Server Configuration
+
+```typescript
+import { MinecraftServer } from '@dimzxzzx07/mc-headless';
+
+const server = new MinecraftServer({
+  platform: 'java',
+  version: '1.20.1',
+  type: 'paper',
+  
+  memory: {
+    init: '2G',
+    max: '8G',
+    useAikarsFlags: true
+  },
+  
+  network: {
+    port: 25565,
+    ip: '0.0.0.0',
+    onlineMode: true,
+    motd: '§6Premium §cMinecraft §aServer'
+  },
+  
+  world: {
+    difficulty: 'hard',
+    hardcore: false,
+    gamemode: 'survival',
+    seed: 'my-epic-seed-123',
+    maxPlayers: 50,
+    viewDistance: 12,
+    levelName: 'survival_world'
+  },
+  
+  folders: {
+    plugins: './plugins',
+    world: './survival_world'
+  },
+  
+  autoRestart: true,
+  backup: {
+    enabled: true,
+    interval: '12h',
+    path: './backups'
+  }
+});
+
+server.on('ready', async (info) => {
+  console.log(`Server PID: ${info.pid}`);
+  console.log(`Memory: ${info.memory.used}/${info.memory.max} MB`);
+  
+  // Schedule daily restart
+  setInterval(() => {
+    console.log('Scheduled restart...');
+    server.sendCommand('say Server restarting in 1 minute');
+    setTimeout(() => server.stop(), 60000);
+  }, 24 * 60 * 60 * 1000);
+});
+
+server.on('resource', (info) => {
+  if (info.memory.used > info.memory.max * 0.9) {
+    console.log('High memory usage, warning players...');
+    server.sendCommand('say Memory usage is high, please restart soon');
+  }
+});
+
+server.start();
+```
+
+Multiple Servers Manager
+
+```typescript
+import { ServerManager } from '@dimzxzzx07/mc-headless';
+
+const manager = new ServerManager();
+
+// Create survival server
+const survival = manager.createServer('survival', {
+  platform: 'java',
+  version: '1.20.1',
+  type: 'paper',
+  network: { port: 25565 },
+  world: { levelName: 'survival' }
+});
+
+// Create creative server
+const creative = manager.createServer('creative', {
+  platform: 'java',
+  version: '1.20.1',
+  type: 'paper',
+  network: { port: 25566 },
+  world: { 
+    gamemode: 'creative',
+    levelName: 'creative'
+  }
+});
+
+// Create Bedrock server
+const bedrock = manager.createServer('bedrock', {
+  platform: 'bedrock',
+  version: '1.20.1',
+  network: { port: 19132 }
+});
+
+// Start all servers
+await manager.startServer('survival');
+await manager.startServer('creative');
+await manager.startServer('bedrock');
+
+// Broadcast to all servers
+await manager.broadcastCommand('say Server is running!');
+
+// Backup all servers
+await manager.backupAll('world');
+
+// Stop all servers on exit
+process.on('SIGINT', async () => {
+  await manager.stopAll();
+  process.exit();
+});
+```
+
+Server Control with Commands
+
+```typescript
+import { MinecraftServer } from '@dimzxzzx07/mc-headless';
+
+const server = new MinecraftServer({
+  version: '1.20.1',
+  type: 'paper'
+});
+
+await server.start();
+
+// Send various commands
+server.sendCommand('say Welcome to the server!');
+server.sendCommand('time set day');
+server.sendCommand('weather clear');
+server.sendCommand('difficulty normal');
+server.sendCommand('gamemode survival @a');
+
+// OP a player
+server.sendCommand('op Notch');
+
+// Give items
+server.sendCommand('give @a minecraft:diamond 1');
+
+// Teleport
+server.sendCommand('tp Dimzxzzx07 100 64 100');
+
+// Set world spawn
+server.sendCommand('setworldspawn 0 64 0');
+
+// Save world
+server.sendCommand('save-all');
+
+// List players
+server.sendCommand('list');
+
+// Get server stats
+const info = await server.getInfo();
+console.log(`Uptime: ${info.uptime}s`);
+console.log(`Players: ${info.players}/${info.maxPlayers}`);
+console.log(`Memory: ${info.memory.used}/${info.memory.max} MB`);
+```
+
+Automatic Backup System
+
+```typescript
+import { MinecraftServer } from '@dimzxzzx07/mc-headless';
+
+const server = new MinecraftServer({
+  version: '1.20.1',
+  type: 'paper',
+  backup: {
+    enabled: true,
+    interval: '6h',
+    path: './backups'
+  }
+});
+
+server.on('ready', () => {
+  console.log('Backup system active: every 6 hours');
+});
+
+// Manual backup
+setInterval(async () => {
+  console.log('Creating manual backup...');
+  const backupPath = await server.backup('full');
+  console.log(`Backup saved to: ${backupPath}`);
+  
+  // Check backup size
+  const fs = require('fs-extra');
+  const stats = await fs.stat(backupPath);
+  console.log(`Backup size: ${stats.size / 1024 / 1024} MB`);
+}, 24 * 60 * 60 * 1000); // Daily backup
+```
+
+---
+
+Server Types
+
+Paper (Recommended for Performance)
+
+```typescript
+const server = new MinecraftServer({
+  type: 'paper',
+  version: '1.20.1',
+  memory: {
+    useAikarsFlags: true  // Optimized for Paper
+  }
+});
+```
+
+Purpur (Most Features)
+
+```typescript
+const server = new MinecraftServer({
+  type: 'purpur',
+  version: '1.20.1'
+  // Purpur has additional configuration options
+});
+```
+
+Vanilla (Official Mojang)
+
+```typescript
+const server = new MinecraftServer({
+  type: 'vanilla',
+  version: '1.20.1'
+});
+```
+
+Spigot (Bukkit Compatible)
+
+```typescript
+const server = new MinecraftServer({
+  type: 'spigot',
+  version: '1.20.1'
+});
+```
+
+Forge (Modded)
+
+```typescript
+const server = new MinecraftServer({
+  type: 'forge',
+  version: '1.20.1',
+  folders: {
+    mods: './mods'  // Place your mods here
+  }
+});
+```
+
+Fabric (Lightweight Modding)
+
+```typescript
+const server = new MinecraftServer({
+  type: 'fabric',
+  version: '1.20.1',
+  folders: {
+    mods: './mods'  // Place your Fabric mods here
+  }
+});
+```
+
+---
+
+Platform Options
+
+Java Edition Only
+
+```typescript
+const server = new MinecraftServer({
+  platform: 'java',
+  version: '1.20.1',
+  type: 'paper',
+  network: {
+    port: 25565  // Java port only
+  }
+});
+```
+
+Bedrock Edition Only
+
+```typescript
+const server = new MinecraftServer({
+  platform: 'bedrock',
+  version: '1.20.1',
+  network: {
+    port: 19132  // Bedrock port
+  },
+  folders: {
+    addons: './addons'  // Bedrock addons
+  }
+});
+```
+
+Cross-Play (Java + Bedrock)
+
+```typescript
+const server = new MinecraftServer({
+  platform: 'all',
+  version: '1.20.1',
+  type: 'paper',
+  network: {
+    port: 25565,      // Java port
+    bedrockPort: 19132 // Bedrock port
+  }
+});
+// Automatically installs Geyser & Floodgate
+```
+
+---
+
+Memory Management
+
+Basic Memory Configuration
+
+```typescript
+memory: {
+  init: '1G',    // Initial heap size
+  max: '4G',     // Maximum heap size
+  useAikarsFlags: false
+}
+```
+
+Aikar's Flags (Optimized)
+
+```typescript
+memory: {
+  init: '2G',
+  max: '8G',
+  useAikarsFlags: true  // Enables optimized GC flags
+}
+```
+
+Memory Units
+
+Unit Value
+M Megabytes (e.g., '512M')
+G Gigabytes (e.g., '2G')
+
+Memory Recommendations
+
+Players RAM Init Max
+1-10 2 GB 1G 2G
+10-20 4 GB 2G 4G
+20-50 8 GB 4G 8G
+50-100 16 GB 8G 16G
+
+---
+
+Network Settings
+
+Basic Network
+
+```typescript
+network: {
+  port: 25565,
+  ip: '0.0.0.0',
+  onlineMode: false,
+  motd: 'My Server'
+}
+```
+
+Public Server with Authentication
+
+```typescript
+network: {
+  port: 25565,
+  ip: '0.0.0.0',
+  onlineMode: true,  // Requires Mojang authentication
+  motd: '§6Official §cMinecraft §aServer'
+}
+```
+
+Cross-Play Network
+
+```typescript
+network: {
+  port: 25565,        // Java port
+  bedrockPort: 19132, // Bedrock port
+  ip: '0.0.0.0',
+  onlineMode: false,  // Geyser handles auth
+  motd: '§bCross-Play §fServer'
+}
+```
+
+Port Forwarding Guide
+
+1. Local Network: Use 192.168.x.x IP
+2. Public Server: Use 0.0.0.0 and configure router
+3. Cloud/VPS: Use public IP or domain
+
+---
+
+World Configuration
+
+Basic World
+
+```typescript
+world: {
+  difficulty: 'normal',
+  gamemode: 'survival',
+  maxPlayers: 20,
+  viewDistance: 10,
+  levelName: 'world'
+}
+```
+
+Hardcore Mode
+
+```typescript
+world: {
+  difficulty: 'hard',
+  hardcore: true,      // Players get banned on death
+  gamemode: 'survival',
+  maxPlayers: 10
+}
+```
+
+Creative Server
+
+```typescript
+world: {
+  difficulty: 'peaceful',
+  gamemode: 'creative',
+  maxPlayers: 50,
+  viewDistance: 16
+}
+```
+
+Custom Seed
+
+```typescript
+world: {
+  seed: 'my-amazing-seed-12345',
+  levelName: 'custom_world'
+}
+```
+
+---
+
+Folder Structure
+
+Java Server Folders
+
+```
+server/
+├── plugins/          # Paper/Spigot plugins
+├── mods/             # Forge/Fabric mods
+├── world/            # World data
+├── logs/             # Server logs
+└── backups/          # Backup files
+```
+
+Bedrock Server Folders
+
+```
+server/
+├── addons/           # Bedrock behavior packs
+├── world/            # World data
+├── logs/             # Server logs
+└── backups/          # Backup files
+```
+
+Custom Folder Configuration
+
+```typescript
+folders: {
+  addons: './custom_addons',
+  mods: './custom_mods',
+  plugins: './custom_plugins',
+  world: './custom_world'
+}
+```
+
+---
+
+Backup System
+
+Enable Automatic Backups
+
+```typescript
+backup: {
+  enabled: true,
+  interval: '24h',  // Daily backup
+  path: './backups'
+}
+```
+
+Backup Intervals
+
+Interval Cron Equivalent Description
+'24h' 0 */24 * * *  Every 24 hours
+'12h' 0 */12 * * *  Every 12 hours
+'6h' 0 */6 * * *  Every 6 hours
+'1h' 0 * * * * Every hour
+'30m' */30 * * * * Every 30 minutes
+
+Manual Backup
+
+```typescript
+// Full backup (entire server)
+const fullPath = await server.backup('full');
+
+// World only backup
+const worldPath = await server.backup('world');
+
+// Plugins only backup
+const pluginsPath = await server.backup('plugins');
+```
+
+---
+
+Event System
+
+Server Events
+
+```typescript
+server.on('ready', (info) => {
+  console.log('Server ready at', info.port);
+});
+
+server.on('stop', ({ code }) => {
+  console.log('Server stopped with code', code);
+});
+
+server.on('resource', (info) => {
+  console.log(`CPU/Memory: ${info.memory.used}/${info.memory.max} MB`);
+});
+```
+
+Player Events
+
+```typescript
+server.on('player-join', (player) => {
+  console.log(`${player.name} joined from ${player.ip}`);
+  server.sendCommand(`say Welcome ${player.name}!`);
+});
+
+server.on('player-leave', (name) => {
+  console.log(`${name} left the game`);
+});
+```
+
+---
+
+Commands
+
+Built-in Commands
+
+```typescript
+// Send any Minecraft command
+server.sendCommand('say Hello world');
+server.sendCommand('time set day');
+server.sendCommand('weather clear');
+server.sendCommand('difficulty hard');
+server.sendCommand('gamemode creative @a');
+```
+
+Console Commands
+
+```typescript
+// Stop server
+server.sendCommand('stop');
+
+// Save world
+server.sendCommand('save-all');
+
+// List players
+server.sendCommand('list');
+
+// Ban player
+server.sendCommand('ban Notch');
+
+// Whitelist
+server.sendCommand('whitelist add Dimzxzzx07');
+```
+
+---
+
+Player Management
+
+Get Player List
+
+```typescript
+const players = server.getPlayers();
+players.forEach(player => {
+  console.log(`
+    Name: ${player.name}
+    UUID: ${player.uuid}
+    IP: ${player.ip}
+    Ping: ${player.ping}ms
+    Connected: ${player.connectedAt}
+  `);
+});
+```
+
+Player Count
+
+```typescript
+const info = await server.getInfo();
+console.log(`Players online: ${info.players}/${info.maxPlayers}`);
+```
+
+---
+
+Cross-Play (Geyser)
+
+Automatic Setup
+
+```typescript
+const server = new MinecraftServer({
+  platform: 'all',  // Enables Geyser & Floodgate
+  version: '1.20.1',
+  type: 'paper',
+  network: {
+    port: 25565,
+    bedrockPort: 19132
+  }
+});
+```
+
+Manual Geyser Configuration
+
+```typescript
+import { GeyserBridge } from '@dimzxzzx07/mc-headless';
+
+const geyser = new GeyserBridge();
+await geyser.setup({
+  folders: { plugins: './plugins' }
+});
+```
+
+---
+
+Termux Setup
+
+Install in Termux
+
+```bash
+# Update packages
+pkg update && pkg upgrade
+
+# Install Node.js
+pkg install nodejs
+
+# Install Java
+pkg install openjdk-17
+
+# Install mc-headless
+npm install -g @dimzxzzx07/mc-headless
+
+# Create server directory
+mkdir minecraft-server
+cd minecraft-server
+
+# Create server script
+cat > server.js << 'EOF'
+const { MinecraftServer } = require('@dimzxzzx07/mc-headless');
+
+const server = new MinecraftServer({
+  platform: 'java',
+  version: '1.20.1',
+  type: 'paper',
+  memory: {
+    init: '512M',
+    max: '2G'
+  }
+});
+
+server.on('ready', (info) => {
+  console.log(`Server running on port ${info.port}`);
+});
+
+server.start();
+EOF
+
+# Run server
+node server.js
+```
+
+Termux Optimizations
+
+```typescript
+const server = new MinecraftServer({
+  platform: 'java',
+  version: '1.20.1',
+  type: 'paper',
+  memory: {
+    init: '512M',    // Lower memory for Termux
+    max: '2G',
+    useAikarsFlags: false  // Disable heavy GC flags
+  }
+});
+```
+
+---
+
+Troubleshooting
+
+Common Issues
+
+Issue Cause Solution
+Java not found Java not installed Run pkg install openjdk-17 in Termux
+Port already in use Another server running Change port or kill other process
+Out of memory Insufficient RAM Reduce max memory or add more RAM
+Connection refused Firewall blocking Check firewall settings
+EULA not accepted autoAcceptEula: false Set to true or accept manually
+Server crash on start Wrong Java version Install Java 17
+
+Debug Mode
+
+```typescript
+const server = new MinecraftServer({
+  // ... config
+});
+
+server.on('resource', (info) => {
+  console.log('Debug:', info);
+});
+```
+
+Logs Location
+
+```bash
+# Server logs
+tail -f logs/latest.log
+
+# MC-Headless logs
+tail -f logs/mc-headless.log
+```
+
+---
+
+
+Project Structure
+
+```
+mc-headless/
+├── src/
+│   ├── core/
+│   │   ├── MinecraftServer.ts
+│   │   ├── ConfigHandler.ts
+│   │   └── JavaChecker.ts
+│   ├── engines/
+│   │   ├── PaperEngine.ts
+│   │   ├── VanillaEngine.ts
+│   │   └── ...
+│   ├── platforms/
+│   │   ├── GeyserBridge.ts
+│   │   └── ...
+│   └── utils/
+│       ├── Logger.ts
+│       └── FileUtils.ts
+├── tests/
+├── examples/
+└── README.md
+```
+---
+
+License
+
+UNLICENSED - Proprietary software. All rights reserved.
+
+This software and its source code are the exclusive property of Dimzxzzx07. Unauthorized copying, modification, distribution, or use of this software is strictly prohibited without express written permission.
+
+---
+
+<div align="center">
+    <img src="https://i.imgur.com/aPSNrKE.png" alt="Dimzxzzx07 Logo" width="200">
+    <br>
+    <strong>Powered By Dimzxzzx07</strong>
+    <br>
+    <br>
+    <a href="https://t.me/Dimzxzzx07">
+        <img src="https://img.shields.io/badge/Telegram-Contact-26A5E4?style=for-the-badge&logo=telegram" alt="Telegram">
+    </a>
+    <a href="https://github.com/Dimzxzzz">
+        <img src="https://img.shields.io/badge/GitHub-Follow-181717?style=for-the-badge&logo=github" alt="GitHub">
+    </a>
+    <br>
+    <br>
+    <small>Copyright © 2026 Dimzxzzx07. All rights reserved.</small>
+</div>