Nucleus / Nucleus Heisenberg

GeoIP for player location determination
Download

Nucleus Heisenberg

Licence: MIT (except for the Nucleus logo, which is all rights reserved)

The GeoIP module from Nucleus now on its own.

Why Heisenberg? The Heisenberg Uncertainty Principle states that you cannot know both someone’s position and momentum at the same time. We’ll know their position!

Usage

Make sure that you accept the licence in the config file before using the plugin. This is to signify your agreement to the use of the Maxmind database.

Please note that this plugin is capable of making an external connection to MaxMind servers to download the latest version of the GeoLite 2 databases. This will only be done once the licence is accepted and upon request thereafter. No information about your server or your players, including IP and location data, is transmitted by this plugin.

Commands

  • /geoip <player> - Get GeoIP information for a player. Requires the permission heisenberg.lookup
  • /geoip reload - Reload the config.
  • /geoip update - Update the local GeoIP database. Requires the permission heisenberg.update

There is also the heisenberg.login permission if alert-on-login is turned on for displaying a player’s location on login.

Getting and Building Heisenberg

To get a copy of the Heisenberg source, ensure you have Git installed, and run the following commands from a command prompt or terminal:

  1. git clone git@github.com:NucleusPowered/Heisenberg.git
  2. cd Heisenberg
  3. cp scripts/pre-commit .git/hooks

To build Heisenberg, navigate to the source directory and run either:

  • ./gradlew build on UNIX and UNIX like systems (including macOS and Linux)
  • gradlew build on Windows systems

You will find the compiled JAR which will be named like Heisenberg-[version].jar in output/.

Third Party Libraries

The compiled Heisenberg plugin includes the following libraries (with their licences in parentheses):

  • MaxMind GeoIP2 API (Apache 2)
  • MaxMind DB (Apache 2)
  • Jackson (Apache 2)

See [THIRDPARTY] for more details.

Category: Admin Tools

Published on Oct 19, 2018

217 views

18 total downloads

Licensed under MIT

Pages

Members