DOCSEARCHbyAlgolia
Submit Docs

MineTrax Documentation

website·Indexed 30 days ago

https://minetrax.github.io

Documentation for MineTrax, a web platform for Minecraft server analytics and player management. Includes guides on installation via Docker, AutoInstaller, or manual setup, SMTP and Discord integration, custom theme development, and configuration of the .env file and config.yml. Features detailed instructions on using the AskDB AI bot for database queries, managing roles and permissions, and configuring hero particle effects.

Tokens
24.3K
Snippets
130
Records
191
Agent score
75%

What's inside MineTrax

  1. Overview of MineTrax Suite features

    MineTrax is a comprehensive suite for server management that includes the following core capabilities:

    • Player Tracking & Linking: Users can sign up on the website and link their player accounts for security and rewards, allowing them to view detailed stats and compare themselves with others.
    • Powerful Analytics (Intel): Provides detailed insights into server performance and player activity to identify trends and detect suspicious activity.
    • In-game Chat Integration: Enables live communication between website visitors and in-game players. Administrators can also execute commands (kick, ban, mute) directly from the website.
    • Custom Ranking Tools: Allows administrators to create custom player ranking and rating algorithms via the admin panel settings.
    • Security & Scalability: Supports multiple servers with encrypted critical data and encrypted web-to-plugin communication.
    • Additional Tools: Includes BanWarden (punishments), Shoutbox, Post Feeds, News, Polls, Pages, Forms, and Themes.

  2. Overview of BanWarden features and supported plugins

    BanWarden allows server administrators to track and manage punishments (bans, mutes, warns, and kicks) through a web interface. Key capabilities include viewing punishment details, pardoning punishments from the web, attaching evidence, and utilizing AI scoring for punishments.

    Currently supported punishment plugins include:

    • LiteBans
    • LibertyBans

  3. Overview of AskDB AI Bot

    AskDB is an AI-based database query system for MineTrax that allows users to ask natural language questions about their server and players (e.g., "How many players joined my server in the last 24 hours?"). It leverages Large Language Model (LLM) providers to translate questions into database queries. Note that passwords and secret keys are stored in encrypted/hashed form and cannot be retrieved via AskDB.

  4. Understand Minetrax Server-to-Web communication via HTTP API

    When the Minecraft server needs to send data to the web interface, the Minetrax plugin uses the Web's HTTP API. This communication path is used for transmitting player intelligence, server intelligence, in-game chat logs, and console logs from the server to the web.

  5. Manage Minecraft servers with MineTrax 2.0 Admin Section

    MineTrax 2.0 introduces a completely overhauled Admin Section designed for more intuitive and efficient day-to-day server operations through a streamlined interface and optimized workflow.

  6. Analyze server performance with Server Analytics/Intel

    The Server Analytics/Intel feature in MineTrax 2.0 provides data on server performance, player behavior, and resource usage to help administrators make informed optimization decisions.

  7. Understand MineTrax theme inheritance

    MineTrax uses a fallback system for themes. When a file is requested, the system first checks the active custom theme directory. If the file is missing, it automatically falls back to the resources/default/ theme. This applies to:

    1. Vue/JS files: A Vite plugin intercepts @/ imports to resolve them from the custom theme first, then the default theme.
    2. Blade views: Laravel's view system checks the custom theme's views/ directory before falling back to default/views/.

    Developers only need to create the specific files they wish to override; all other assets are inherited automatically.

  8. Use Socketi as a self-hosted Pusher alternative

    Socketi is a self-hosted WebSocket server that supports the Pusher protocol. It is recommended as an alternative for users who have outgrown the Pusher free tier (which limits users to 200k push messages per day and 100 concurrent connections) and want to avoid the costs of paid Pusher plans.

  9. MineTrax product overview and core capabilities

    MineTrax is a web suite and analytics tool for Minecraft servers designed to improve server engagement. It provides a unified dashboard for players to view their data or can be used privately for server-side analytics. Key capabilities include:

    • Analytics: In-depth server and player tracking (Intel).
    • Player Management: Registration, linking website accounts to in-game characters, social logins (Facebook, Twitter), and password resets (useful for cracked servers).
    • Server Administration: Command Runner for executing or scheduling server commands via the web, permission-based admin management, and a punishment tracking system (BanWarden) that hooks into punishment plugins.
    • Player Interaction: Skin changing via the website (SkinChanger), a player rating system based on custom algorithms, and a live in-game chat bridge for website visitors.
    • Community Tools: News/announcements section, shoutbox, post feed with likes/comments, polls, staff recruitment system, and custom forms/pages.
    • Customization: Custom themes, branding, predefined color schemes, dark mode, localization/language switching, and a drag-and-drop custom navigation menu.
    • Integrations: Discord integration including notifications, auto-join server, linked roles, and webhooks.
    • Utility: AI-based database query system (AskDB) and a downloads section.

  10. Understand the MineTrax architecture

    MineTrax consists of two primary components:

    1. Web: The main suite containing the UI and backend layer, developed using Laravel. It handles the management interface and data processing.
    2. Plugin: A Spigot and proxy plugin (Bungee/Velocity) installed on Minecraft servers. It is responsible for calculating and sending player/server intel to the Web component, syncing chat/logs, enabling web-to-game chat, executing remote commands, and integrating with other plugins like SkinsRestorer.

  11. Install a custom theme in MineTrax

    Custom themes are used to change the layout, structure, or functionality of pages. MineTrax uses theme inheritance, meaning custom themes only need to contain files that differ from the default theme.

    1. Prepare Files: Ensure the theme package contains a resources/ directory (with the theme folder) and optionally a public/theme-assets/ directory.
    2. Upload via SFTP: Connect to the server (e.g., using Bitvise or MobaXterm) and navigate to the installation directory (typically /var/www/minetrax).
    3. Deploy Files:
      • Copy the resources/[theme-name]/ directory to the project's resources/ folder.
      • Copy public/theme-assets/[theme-name]/ to the project's public/theme-assets/ folder if applicable.
    /var/www/minetrax/
├── resources/
│   ├── my-shiny-theme/    # Custom theme files
│   └── default/            # Default theme
└── public/
    └── theme-assets/
        └── my-shiny-theme/ # Additional assets