Developer Guides#

Welcome to the Void developer guides. Here you'll find comprehensive documentation for getting started, developing, and testing Void.

Quick Navigation#

🚀 Getting Started#

New to Void? Start here! Learn how to:

• Install and run the server
• Understand the project structure
• Connect with a Minecraft client
• Learn key architectural concepts

🔧 Development Guide#

Set up your development environment and learn best practices:

• IDE setup (VS Code, CLion)
• Code organization and naming conventions
• Working with the protocol and macros
• Async/Tokio patterns
• Git workflow
• Debugging and optimization

✅ Testing Guide#

Write and run tests with confidence:

• Unit tests, integration tests, documentation tests
• Testing strategies for each component
• Running the test suite
• Coverage goals and best practices
• Common test patterns

Topics by Role#

For Backend Developers#

1. Getting Started - Set up and understand the basics
2. Development Guide - Configure your environment
3. Architecture (from main nav) - Understand the design
4. Testing Guide - Write quality code

Typical workflow:

# Setup
cargo build && cargo test

# Development
git checkout -b feature/your-feature
# ... make changes ...

# Test and verify
cargo fmt && cargo clippy && cargo test

# Submit PR
git push origin feature/your-feature

For Performance Optimizers#

1. Getting Started - Understand the project
2. Performance Metrics (from main nav) - Learn what we measure
3. Benchmarking (from main nav) - Profile and optimize
4. Development Guide - Use profiling tools

Key tools:

• cargo bench - Run benchmarks
• cargo flamegraph - Visualize hot spots
• Performance metrics dashboard

For QA & Testing#

1. Testing Guide - Understand our test strategy
2. Performance Metrics - Learn performance testing
3. Getting Started - Set up test environment

Key responsibilities:

• Running test suite
• Manual testing scenarios
• Performance regression detection
• Documentation of test results

Common Tasks#

Running the Server#

# Development (debug build)
cargo run

# Release (optimized)
cargo run --release

# With custom settings
RUST_LOG=debug cargo run --release

Server starts at 127.0.0.1:25565

Testing Changes#

# All tests
cargo test

# Specific test
cargo test test_name

# With output
cargo test -- --nocapture

# Single-threaded
cargo test -- --test-threads=1

Code Quality#

# Format
cargo fmt

# Lint
cargo clippy -- -D warnings

# Documentation
cargo doc --no-deps --open

Performance Analysis#

# Benchmarks
cargo bench

# Flame graph
cargo flamegraph
open flamegraph.svg

# Memory profiling
cargo tarpaulin --out Html

Project Structure#

Key Concepts#

Protocol States#

Each state handles different packets.

Async Architecture#

• Non-blocking I/O with Tokio
• One task per client
• Shared state via Arc<Mutex<T>>

Type Safety#

• Rust's type system prevents many errors
• Macros auto-derive Encode/Decode
• Protocol validated at compile-time

Getting Help#

• Questions? Open a GitHub Discussion
• Found a bug? Report an issue
• Need help? Check existing discussions
• Want to contribute? Read the Contributing guide

Next Steps#

Choose your path:

1. I want to build features → Development Guide
2. I want to optimize performance → Performance Metrics
3. I want to ensure quality → Testing Guide
4. I want to contribute → Contributing Guide
5. I want to understand the design → Architecture

Happy coding! 🎮 If you have questions, don't hesitate to reach out!