About RynixAPI
RynixAPI is a web application that provides both a nice looking user-facing interface for querying the current status of Minecraft servers as well as gathering information about those same servers when they are queried. This is accomplished by communicating with the public backend API of the service, which runs code on the server side that makes a connection to the requested Minecraft servers and attempts to collect and return as much data as it can about the server.
You may recognise this type of service from mcsrvstat.us, and they were indeed the driving inspiration behind this site. We wanted to create a similar service, but one that would work (or at least feel) a bit faster and provide a nicer looking interface. On top we had the forethought of implementing meta tags for the server-side-rendered responses, where if you append the address (IP/hostname +- port) of the server you want to query at the end of this site's URL, you will see the information you requested in an "embed" on supported platforms such as Discord.
Credits
While it certainly would be interesting to attempt to write all the software for this project on our own, it would definitely not be practical. As such we believe we owe it to the people who contributed to the libraries we're using here to thank them:
- minecraft-server-util — Minecraft protocol querying functions
- @sfirew/mc-motd-parser — Parsing various strings encoded with Minecraft colour codes
- ping — Sending ICMP packets to remote hosts
- validator — Checking for valid FQDN's and IP addresses
- isomorphic-dompurify — Sanitizing MOTD & infobox output on the server & client side.
- tailwindcss — Styling & forms
- Heroicons — Icons
- NextJS — Framework
Open Source
This project is based on an open-source project available on GitHub. It has been built upon and made publicly available.