Skip to content

itzzjustmateo/FluxTine

 
 

Repository files navigation

⚡ FluxTine

FluxTine is a custom Velocity fork focused on experimentation, internal refactors, and future‑oriented ideas—without losing the stability and architectural strengths that make Velocity solid.

FluxTine is proxy‑only software. It is not a plugin, library, or web service. The project is in early development, and while it is usable, you should expect rapid changes and occasional breakage.

🧭 Versioning & Release Philosophy

FluxTine uses a structured, transparent versioning scheme:

  • Prefixes: SNAPSHOT, ALPHA, BETA, RC
  • Full Releases: Stable milestones intended for wider testing
  • Large Changesets: Major refactors or feature introductions
  • Small Changesets: Targeted improvements or cleanups
  • Fix Releases: Bug fixes, documentation updates, and polish

Version numbers are descriptive rather than marketing-driven. Stability is earned, not assumed.

🚀 Quick Start

FluxTine is built and run like Velocity.

  1. Clone the repository.

  2. Build the project using the Gradle wrapper:

    ./gradlew build
    
  3. Locate the shaded JAR in:

    proxy/build/libs
    
  4. Run it with Java:

    java -jar fluxtine-*-all.jar
    

On first launch, FluxTine generates a default configuration file.

🧱 Project Structure

FluxTine closely follows Velocity’s architecture:

FluxTine/
├─ proxy/          # Core proxy implementation
├─ api/            # Public API surface
├─ native/         # Platform-specific code
├─ build-logic/    # Gradle build logic
├─ .github/        # CI & automation
└─ README.md       # Project documentation

The structure is intentionally conservative to allow rebasing onto upstream Velocity when needed.

🎯 Goals

  • Maintain Velocity’s high concurrency and scalability model
  • Experiment with internal improvements and architectural ideas
  • Keep the codebase readable and contributor-friendly
  • Avoid breaking upstream compatibility without strong reasons

FluxTine is a testing ground—not a rewrite for the sake of rewriting.

🧪 Features & Status

Important: Many features are experimental or incomplete.

  • Custom startup and lifecycle handling
  • Internal refactors and cleanup work
  • Selective divergence from upstream Velocity
  • Focus on correctness before raw performance gains

This project is not recommended for production-critical networks yet.

🤝 Contributing

Contributions are welcome, especially from developers familiar with Velocity internals.

  1. Fork the repository.
  2. Create a focused branch.
  3. Keep commits small and well-described.
  4. Open a Pull Request explaining why the change exists.

Large changes should be discussed before implementation.

📜 License

FluxTine is licensed under GPLv3, inherited from Velocity.

🧬 Relationship to Velocity

FluxTine is not affiliated with PaperMC.

All credit for the original project goes to the Velocity contributors. Issues specific to FluxTine should not be reported upstream.

🛣 Roadmap

Planned and possible directions:

  • Deeper internal cleanup and documentation
  • Experimental proxy features
  • Improved diagnostics and logging
  • Long-term maintainability improvements

Ideas may evolve—or be discarded—based on real-world testing.

📬 Contact

About

The modern, next-generation Minecraft server proxy based on Velocity.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Java 99.3%
  • Other 0.7%