Xenos is a Minecraft profile data proxy that can be used as an ultra-fast replacement for the official Mojang API on Kubernetes.
The name "Xenos" is derived from the Greek word xénos which means something like "stranger" or "guest friend" (source). That alludes to the process of profile resolution by which strangers become known players.
Mojang already offers an API to query the profile data of Minecraft accounts, but it is strictly rate limited. And while the performance is overall okay, it's by no means optimal and can therefore only be used as a fallback. Xenos aims for performance and reliability and can be used as the primary source of truth for profile information.
It is built with scaling and high availability in mind and can be set up fairly easy. Compared to existing solutions like MineTools, Xenos introduces little to no additional latency and primarily uses cached and latency-optimized responses to communicate with the services. It is meant to completely replace any kind of internal caching and always use the API instead for inter process communication.
The differences between Xenos and serverless solutions like Crafthead are, that Xenos is deployed on your own infrastructure to minimize latency, Xenos uses your own IPs regarding the rate-limit and you'll have more over what requests are performed, that Xenos is based on gRPC to cut down API response times even further and that Xenos will always try to return a value, even if only outdated data is available.
Therefore, Xenos is a reliable service, offering high-availability for Mojang API calls. It offers all the standard Mojang APIs and will even be able to proxy authentication requests in the future.
- Perform gRPC and HTTP REST lookups for profile information.
- Make efficient use of your available IP addresses to not run into rate limits.
- Get best-in-class caching inbuilt and always request Xenos with very low latency.
- Set Xenos up with replication, to get high availability.
- Supply data in any representation without converting it first (dashed vs non-dashed UUIDs).
- Fall back to retrieving cached data, if the Mojang API is currently not available.
- Store resolved information to allow for grace periods for the resolution between name changes!
Xenos provides multiple images with configurations for different remote caches. Additional caches might be provided in the future. Caches are excluded from the build process using build features. This allows for a greater variety of caches while minimizing security risks arising from their dependencies.
Currently, the supported remote caches are:
- None (
minimal) - Redis (
redis)
Warning
Xenos is under active development and may experience breaking changes until the first version is released. After that version, breaking changes will be performed in adherence to Semantic Versioning
Once this project is ready, information about how to run Xenos will be published here. Stay tuned!
To report a security issue for this project, please note our Security Policy.
Participation in this project comes under the Contributor Covenant Code of Conduct.
Thanks for considering contributing to this project! In order to submit a Pull Request, please read our contributing guide. This project is in active development, and we're always happy to receive new contributions!
The project includes the official Mojang skins for Steve and Alex. We do NOT own them, and it is NOT officially approved by Mojang. They are only present in the source code to speed up the request time.
This project is developed and distributed under the MIT License. See this explanation for a rundown on what that means.