Bukkit

Alpha Register, simple, yet comprehensive!

Alpha Register is a very simple plugin to let your users register themselves with a password which is then stored into a MySQL database. Which can be used for multiple purposes. (Like a login for a mobile app or web application)

Main Idea

Since there was an android-application being developed for our server, we needed some form of registration from inside Minecraft. I decided to make a plugin myself. Of course you can use this for other applications/solutions as well.

Features

1. Simple installation and configuration
2. Simple use of the in-game commands, everyone can understand!
3. Somewhat extensive configuration-abilities (Everything down to the MySQL-column names are configurable)
4. The /register command for players to register themselves.
5. The /changepass command for players to change their own password.

Installation

Step 1: Downloading

• Download the plugin and put the AlphaRegister.jar into the 'plugins' folder.

Step 2: Generating default config

• Start your server and wait for it until it finishes loading, you will see errors coming from AlphaRegister about not being able to connect to MySQL. (This is normal and nothing to worry about; this will go away after configuration.)

Step 3: Configuring

Stop your server, and navigate into the 'plugins/AlphaRegister' of your server. Once there open up the 'config.yml' file with a text-editor of your choice. This is what it will look like:

MySQL:
   host: localhost
   port: 3306
   user: yourUser
   password: yourPassword
Database:
   dbName: dbToSaveTo
   tableName: tableToSaveTo
   columnUser: columnNameToSaveUsernamesTo
   columnPassword: columnNameToSavePasswordsTo
Debug: false

Explanation:

• MySQL:
  • host: Hostname (or ip address) of your MySQL server.
  • port: Port where your MySQL server is listening on.
  • user: MySQL user to use.
  • password: Password to use when logging onto the user specified.
• Database:
  • dbName: Name of the database to save all data to. (THE DATABASE WILL BE GENERATED FOR YOU!)
  • tableName: Name of the table to save all data to. (JUST LIKE THE DATABASE, THIS WILL BE GENERATED FOR YOU, DOING THIS YOURSELF MAY CAUSE ERRORS)
  • columnUser: Name of the column to save usernames to. (WILL BE GENERATED WITH THE TABLE)
  • columnPassword: Name of the column to save passwords to. (They will be hashed with MD5)
• Debug: <true/false> - Should there be debug-messages in the console, this should only be used when errors occur or something seems off, defaults to false. (This will spam the console if turned on because there's lots of debug-messages)

Step 4: Permissions

There are just a few permissions:

• AlphaRegister.register - Allows a player to register him-/herself (Allowed to everyone by default)
• AlphaRegister.register - Allows a player to change his/her own password (Only allowed to ops by default)
• AlphaRegister.* - Allows all permissions for AlphaRegister.

Step 5: Check

If you believe you've done everything correctly, you can start your server again. If you actually did do everything right, the errors should be gone and the plugin should be enabled! Have fun!

Upcoming features/More ideas

• Administrative commands like: '/deluser <name>' and '/resetpass <user> <password>'. (Upcoming feature)
• Configurable option to require the providing of e-mail address before you can register. (Idea)

Bugs

If you find a bug or another thing that might not be right, please be so kind to open a ticket and explain the problem. Be as specific as possible when describing the problem.

If you simply have a question, additional features or possibly a compliment, you can leave it in a comment at this page.

Side-notes

1. If you use '/version MyRegister' on the plugin, it will show DJ_Jack as the author; this is my Minecraft name.
2. This is my second plugin, and if you use it I hope it will be useful.
3. My native language is Dutch, so my English might not be perfect; but I tried to make it as clear as possible.