Expand README

This commit is contained in:
Gabriel Simmer 2022-07-15 17:34:19 +01:00
parent 37d1e125cb
commit 2821e8bd58

View file

@ -7,6 +7,25 @@ Minecraft Server Invites [mc.gmem.ca](https://mc.gmem.ca)
_Looking for the frontend? See here: https://git.sr.ht/~gmem/minecraft-server-invites-frontend_ _Looking for the frontend? See here: https://git.sr.ht/~gmem/minecraft-server-invites-frontend_
## About
Sometimes you want to allow people to play on your Minecraft server, but you don't necessarily want to
go through the whole process of asking for their username, then manually sending the command to add them
to the whitelist*. Instead, this application offers the ability to generate a short link that directs
a user through an OAuth flow to automatically fetch their Minecraft account (assuming the account has been
migrated - I have no plans at this time to support non-migrated accounts, despite how I may personally feel
about them) and send a command over RCON to your server to add them to the whitelist. It will then give them
the address to connect to the server.
This is currently hosted at [mc.gmem.ca](https://mc.gmem.ca) while being developed. It's currently free, and
while I do want to eventually monetize this hosted version, you are more than welcome to host your own instance
(this is actually recommended if you have the ability, since it allows you to keep RCON private). I do
happily [accept donations](https://www.buymeacoffee.com/gmem) though!
*while the term "whitelist" is by and large being replaced in places, this is still the term Minecraft servers
utilise, and is therefore the term used in this application. Should it be changed, use of the term here will
also be changed.
## Building ## Building
```shell ```shell