Skip to content

Latest commit

 

History

History

plugin

README.md

MC-ID

MC-ID Plugin

This is a companion plugin for the MC-ID project.

You can grab the latest release from the releases page.

Plugin

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.

Installation

  1. You will need to have a Velocity server running.
  2. Download the latest release from the releases page.
  3. Place the downloaded .jar file in the plugins folder of your Velocity server.
  4. Start your Velocity server.
  5. Configure the plugin by editing the config.yml file in the plugins/MC-ID folder.
  • Leave the file-version as it is to ensure compatibility with future updates.
  • Set the api-endpoint to the URL of your MC-ID website.
  • Set the api-key to 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:read permission.
    • This is used by the plugin to authenticate requests to the API.
  1. 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.

Usage

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.

Contributing

Check the CONTRIBUTING.md file for information on how to contribute to this project or on how to build the plugin from source.

Credits

This project is maintained by RioTheDev under the Tonantzintla organization.

License

This project is licensed under the GNU General Public License v3.0. See the LICENSE file for more details.