Final pre-release

Changelog

API

• Added HereAuthMultiFactorAuthEvent.

Bug fixes

• Fixed /unregister.
• /chpw is now officially supported (tested).
• /rename is now completed, but not tested. Use with caution.

Miscellaneous

• Bumped API version. Now explicitly supports the following PocketMine API versions:
  • 1.12.x
  • 1.13.x
  • 2.0.x (the PHP 7 update, required for 0.14.0 onwards)

Unimplemented features

• Chat masking
  • Disallow players from seeing the chat messages sent to that client from the server/other plugins until authenticated
• Customized authentication messages for different authentication methods
  • I really thought nobody wanted it 😨
• Import external databases
  • Actually, the code for importing into memory is already completed.
  • However, I haven't got the time to implement the part of writing imported accounts into HereAuth databases yet.
  • Also, the commands to do so have not been completed either.
  • There is a very likely chance that this process is eventually done through running the entry script of the plugin (opening the phar file with php.exe on Windows, or running php HereAuth.phar on other systems).

Compiling

HereAuth is licensed under the GNU Lesser General Public License version 3. You are welcome to make changes to the plugin under the terms from the license. If you would like to contribute, or just make your own edits, you can clone this repository (or fork it first if you wish to make a pull request) and edit the source code. To compile the plugin so that it can be actually used on a server, you have to run the compile.php file. A fresh new phar build of HereAuth built from the source code you edited will appear/overwrite at compile/HereAuth_Dev.phar. No plugin.yml file is needed, nor would one be ever added directly to the source code.

By the way, the compile.php file comes from the NOWHERE framework by @PEMapModder. It is not an original part of HereAuth.

Should I use this on my server?

There are three types of builds: RC (release candidate), beta and development. A beta build is meant for test servers. If you are running a production server, it's recommended to stay away from these builds. If you really want to use it, please test this build in an environment isolated from your production server (e.g. do not share same database, do not use in same directory, do not open on the same port, etc.) before actually applying it on the production server.

This build, Beta #174, actually already stably covers all features that SimpleAuth offers, as well as other unique features that HereAuth innovated (e.g. data masking), so it is actually stable for production use, theoretically.
However, technically, if any issues occurred during migration from a beta version to another, they are not supported. Migration from an RC to another is supported, but not from a beta/development build and/or to a beta/development build. Therefore, if you do not want to bear the risk of resetting the config file or the database by HereAuth Beta builds, you may want to wait until an RC is published, where migration such as database migration, config migartion, etc. would be supported in the next release.

Nevertheless, this beta build alone is safe to use (but again, test it on a server on a different port and a different database first!). I do not expect more big changes to the config file, so personally I don't think there is the need to wait until an RC is released.

Reporting bugs

Please report bugs to the HereAuth issue tracker on GitHub. I politely ask you not to submit duplicated issues, submit issues for unimplemented features or for questions, or use the issue tracker as a forum. Please also do not start any issues asking why there is no plugin.yml file.

Downloading binaries (phar)

Download the HereAuth_Beta.phar below.

Bug fixes

Changelog

• Typo fix by @GoneTone
• Typo fix by @Driesboy
• Fixed the /opt command
• Fixed multi-factor authentication
• Tested data masking (inventory and location), confirmed to be working
• (Unused) Incomplete atabase import structure, contained in the beta release but cannot be used yet

Unimplemented features

Some features specified in the config file may not be implemented/tested yet. Please check the README for what is confirmed to be working.

Incompatible configs across versions

The config file has been slightly changed since the last beta release. You are recommended to delete the config.yml file to let HereAuth generate a new one.

Compile only with the NOWHERE compiler script

Please do not attempt to compile this plugin through pmt.mcpe.me or DevTools or ConsoleScript, because this plugin uses the NOWHERE framework. It is slightly pre-processed, and plugin.yml is generated using the NOWHERE compiler script. Therefore, normal loaders won't work on it as they won't find a plugin.yml file. It can be compiled into an independent usable plugin .phar build with the NOWHERE compile script compile.php found at the root directory of this repo. The script requires PHP 7 to run.

Direct phar download

You can download the phar release from the links below, or get the latest development/beta/RC builds from the compile/ directory in the repo.

Should I use this on my server?

There are three types of builds: RC (release candidate), beta and development. A beta build is meant for test servers. If you are running a production server, it's recommended to stay away from these builds. If you really want to use it, please test this build in an environment isolated from your production server (e.g. do not share same database, do not use in same directory, do not open on the same port, etc.) before doing applying it on the production server.

This build, Beta #163, actually already stably covers all features of the SimpleAuth and other unique features of HereAuth's, so it is actually stable for production use, theoretically.
However, technically, if any issues occurred during migration from a beta version to another, they are not supported. Migration from one release to another is supported, but not from a beta/development build and/or to a beta/development build. Therefore, if you do not want to bear the risk of resetting the config file or the database by HereAuth Beta builds, you may want to wait until a release candidate is published, where migration such as database migration, config migartion, etc. would be supported in the next release.

Reporting bugs

Please report bugs to the HereAuth issue tracker on GitHub. I politely ask you not to submit duplicated issues, submit issues for unimplemented features or for questions, or use the issue tracker as a forum.

Initial pre-release

This is the first beta release. Completed features can be found at the README file.

Unimplemented features

Some features specified in the config file may not be implemented/tested yet. Please check the README for what is confirmed to be working.

Incompatible configs across versions

There may be incompatible file changes between beta releases (but not between RCs; in every RC a new config file will be used, although some former values might be deprecated).

Do not compile from source without NOWHERE compiler

Please do not attempt to compile this plugin through pmt.mcpe.me or DevTools or ConsoleScript, because this plugin uses the NOWHERE framework. It is slightly preprocessed and plugin.yml is generated using the NOWHERE compiler script, so normal loaders won't work on it. It can only be compiled into a plugin phar using the NOWHERE compile script compile.php found at the root directory of this repo, using PHP 7.

Download phar directly

And this is the main point. You can simply download the phar release from the links below, or get the latest development/beta/RC builds from the compile/ directory in the repo.

Why is this build #82?

Due to the nature of the NOWHERE framework, the build number is bumped every time I compile the code. Hence, every time I modified some code and want to create a new phar to test, the build number is bumped. I have compiled it for 82 times, so it is build #82 now. This does not mean that this is the 82nd development/beta builds, because a lot of numbers have been skipped when I internally test them or just accidentally compiled twice. Higher number means a newer version, but do not think that there are 82 versions.

MySQL support

I know, right, this pre-release is just 21 hours from the last pre-release.

Please read all instructions at the previous release; I'm not going to repeat them here.

This update adds full MySQL support to the plugin, and fixes some minor issues. It also added the none option for RemindLogin.Type. Please check out the new config.yml for changes, although there aren't a lot of changes. (Just some updates in comments)

Please check the README file for this version to see what features have been implemented and tested (ticked = fixed).