Home

Welcome to the comprehensive documentation for XDiscordUltimate! This documentation provides detailed information about the plugin's architecture, configuration, modules, and development.

📚 Documentation Index

Quick Start

Document
Description
Audience

README.md

Project overview and quick start

All users

DEVELOPER.md

Development setup and guidelines

Developers

INSTALLATION.md

Installation instructions

Administrators

Core Documentation

Document
Description
Audience

ARCHITECTURE.md

System architecture and design

Developers

API.md

Complete API reference

Developers

DATABASE.md

Database schema and configuration

Administrators

Configuration & Modules

Document
Description
Audience

modules/MODULES.md

All 18 module documentation

All users

CONFIGURATION.md

Complete configuration guide

Administrators

MESSAGES.md

Message customization guide

Administrators

Feature Guides

Document
Description
Audience

modules/CHAT-BRIDGE.md

Chat bridge setup and usage

All users

modules/VERIFICATION.md

Verification system guide

All users

modules/TICKETS.md

Support ticket system

All users

modules/MODERATION.md

Moderation features

Moderators

modules/SERVER-LOGGING.md

Server logging setup

Administrators

User Guides

Document
Description
Audience

FEATURES.md

Feature overview and comparison

All users

COMMANDS.md

Complete commands reference

All users

PERMISSIONS.md

Permissions reference

Administrators

TROUBLESHOOTING.md

Common issues and solutions

All users

Developer Resources

Document
Description
Audience

DEVELOPER.md

Development setup

Developers

API.md

API reference

Developers

CONTRIBUTING.md

Contribution guidelines

Developers

CHANGELOG.md

Version history

All users

🎯 Documentation by Audience

For Server Administrators

Start Here:

  1. INSTALLATION.md - Install the plugin

  2. CONFIGURATION.md - Configure the plugin

  3. modules/MODULES.md - Enable features you need

Essential Guides:

Module-Specific Setup:

For End Users

Player Guides:

  1. FEATURES.md - What the plugin does

  2. COMMANDS.md - Available commands

  3. modules/VERIFICATION.md - How to verify

Player Features:

  • Chat between Minecraft and Discord

  • Account verification

  • Support tickets

  • Player statistics

For Developers

Development Setup:

  1. DEVELOPER.md - Set up dev environment

  2. ARCHITECTURE.md - Understand the system

  3. API.md - API reference

Contributing:

Customization:

For Moderators

Moderation Features:

🚀 Quick Start Guide

New Users

  1. Read the Overview

  2. Install the Plugin

  3. Configure Basic Features

  4. Set Up Discord Bot

    • Create Discord application

    • Add bot to server

    • Configure bot token and guild ID

  5. Enable Modules

    • Chat Bridge (chat integration)

    • Verification (account linking)

    • Tickets (support system)

Returning Users

  1. Check Changelog

  2. Update Plugin

    • Backup configuration

    • Replace JAR file

    • Restart server

  3. Review New Features

Developers

  1. Set Up Development Environment

  2. Understand Architecture

  3. Study API

  4. Contribute

📖 Documentation Structure

🔍 Finding Information

By Topic

Setup & Installation:

Features:

Development:

Troubleshooting:

By Feature

Chat Bridge:

Verification:

Tickets:

Moderation:

📝 Documentation Standards

Writing Style

Tone:

  • Clear and concise

  • Professional but approachable

  • Action-oriented

  • Consistent terminology

Structure:

  • Start with overview

  • Provide step-by-step instructions

  • Include code examples

  • Add troubleshooting tips

Code Examples:

  • Always test before including

  • Use proper formatting

  • Include comments explaining key parts

  • Provide context

File Naming

  • Use PascalCase for file names

  • Use hyphens in file names (e.g., QUICK-START.md)

  • Keep names descriptive

  • Avoid abbreviations

Versioning

  • Documentation version matches plugin version

  • Breaking changes documented in CHANGELOG.md

  • Update all relevant docs when making changes

  • Mark new features clearly

🤝 Contributing to Documentation

How to Help

  1. Report Issues

    • Found a typo? Report it!

    • Unclear explanation? Report it!

    • Missing information? Report it!

  2. Submit Improvements

    • Fork the repository

    • Edit documentation files

    • Submit pull request

  3. Write New Docs

    • New feature needs documentation

    • Fill gaps in existing docs

    • Translate to other languages

Documentation Guidelines

  1. Be Clear

    • Use simple language

    • Avoid jargon

    • Explain acronyms

  2. Be Complete

    • Cover all use cases

    • Include examples

    • Link to related topics

  3. Be Accurate

    • Test instructions

    • Update for new versions

    • Verify commands work

  4. Be Consistent

    • Use same terminology

    • Follow file structure

    • Match existing style

🔗 Useful Links

Official Resources

  • GitHub Repository: https://github.com/xreatlabs/XDiscordUltimate

  • Issue Tracker: https://github.com/xreatlabs/XDiscordUltimate/issues

  • Discord Server: https://discord.gg/xreatlabs

  • Spigot Resource: https://www.spigotmc.org/resources/...

External Resources

Tools

📞 Getting Help

Community Support

  1. Discord Server

    • Join: https://discord.gg/xreatlabs

    • Ask questions in #support

    • Share your setup

  2. GitHub Discussions

    • https://github.com/xreatlabs/XDiscordUltimate/discussions

    • Feature discussions

    • General questions

Bug Reports

Before Reporting:

  1. Check TROUBLESHOOTING.md

  2. Search existing issues

  3. Test with debug mode enabled

Report Bug:

  • GitHub Issues: https://github.com/xreatlabs/XDiscordUltimate/issues

  • Include: Minecraft version, plugin version, error logs

  • Provide: Steps to reproduce, configuration (sanitized)

Feature Requests

Request Feature:

  • GitHub Issues: https://github.com/xreatlabs/XDiscordUltimate/issues

  • Label: "enhancement"

  • Describe: Use case, benefits, alternatives considered

📊 Documentation Stats

Category
Count

Total Documents

20+

Module Guides

16

API Methods

100+

Configuration Options

200+

Database Tables

7

🎓 Learning Path

New Server Administrator

  1. Read README.md for overview

  2. Follow INSTALLATION.md

  3. Configure with CONFIGURATION.md

  4. Enable modules from modules/MODULES.md

  5. Reference COMMANDS.md for usage

Power User

  1. All administrator steps

  2. Customize with MESSAGES.md

  3. Enable advanced modules

  4. Set up automated tasks

  5. Monitor with TROUBLESHOOTING.md

Developer

  1. All user steps

  2. Study ARCHITECTURE.md

  3. Set up dev environment from DEVELOPER.md

  4. Read API.md thoroughly

  5. Contribute via CONTRIBUTING.md

📅 Maintenance

Documentation Updates

Documentation is maintained alongside code:

  • Updated with each release

  • Reviewed monthly

  • Community feedback incorporated

Version Compatibility

Documentation Version
Plugin Version
Status

1.1.0

1.1.0

✅ Current

1.0.x

1.0.x

⚠️ Legacy

0.9.x

0.9.x

❌ Deprecated

Thank you for using XDiscordUltimate! This documentation is continuously improved based on community feedback. If you find it helpful, please consider contributing back by reporting issues or submitting improvements.

Need Help?

  • 📧 Email: [email protected]

  • 💬 Discord: https://discord.gg/xreatlabs

  • 🐛 Issues: https://github.com/xreatlabs/XDiscordUltimate/issues

  • 📚 Docs: https://github.com/xreatlabs/XDiscordUltimate/wiki

Last updated: December 2024 For XDiscordUltimate v1.1.0

PreviousAPI ReferenceNextAPI Reference

Last updated