This is a companion plugin for the MC-ID project.
You can grab the latest release from the releases page.
This plugin is designed to be used with the MC-ID Website and sends requests to the API to get the 6-digit code and display it to the user. The user can then use this code to log in the app they are using.
- You will need to have a Velocity server running.
- Download the latest release from the releases page.
- Place the downloaded
.jarfile in thepluginsfolder of your Velocity server. - Start your Velocity server.
- Configure the plugin by editing the
config.ymlfile in theplugins/MC-IDfolder.
- Leave the
file-versionas it is to ensure compatibility with future updates. - Set the
api-endpointto the URL of your MC-ID website. - Set the
api-keyto the same value as the one created in the MC-ID website.- This must match the key generated in the MC-ID website.
- This must have the
plugin:readpermission. - This is used by the plugin to authenticate requests to the API.
- Restart your Velocity server to apply the changes.
Optionally, you can customize the server's icon, MOTD, etc. Consult the Velocity documentation for more information on how to do this.
Once the plugin is installed and configured, users can connect to your Velocity Minecraft server. The plugin will retrieve the 6-digit code from the MC-ID API if available and display it to the user. The user can then use this code to log in to the app they are using.
Check the CONTRIBUTING.md file for information on how to contribute to this project or on how to build the plugin from source.
This project is maintained by RioTheDev under the Tonantzintla organization.
- Main Developer: RioTheDev
- Project Maintainer: Tonantzintla
This project is licensed under the GNU General Public License v3.0. See the LICENSE file for more details.
