PlayerLocations Plugin Documentation

Introduction

PlayerLocations is a Minecraft plugin designed to enhance the server experience by providing information about player locations based on their IP addresses. This documentation will guide you through the installation, configuration, and usage of the plugin.

Installation

Download the latest version of the plugin from SpigotMC.
Place the plugin JAR file into the 'plugins' folder of your Bukkit or Spigot server.
Restart the server to load the plugin.

Configuration

The plugin requires an API key from ipstack to fetch location information. Follow these steps to configure the plugin:

Sign up for a free ipstack account at ipstack signup page.
Confirm your email by clicking on the confirmation link sent to you.
Log in to your ipstack account.
Copy your API key from the ipstack dashboard.
Open the plugins/PlayerLocations/config.yml file.
Add your API key to the configuration file:

# Configuration for PlayerLocations
key: "YOUR_IPSTACK_API_KEY"

Replace YOUR_IPSTACK_API_KEY with the API key you obtained from ipstack.

Features

Display player join events in the server console, including player name and their country based on IP address.
Command for administrators to have knowledge of their server's traffic by players.

Commands

/playerlocations Shows information about plugin and restarts the plugin
/country [username] Shows the location of a user

Permissions

playerlocations.command.playerlocations
playerlocations.command.country

Troubleshooting

If you encounter any issues while using the plugin, consider the following:

Check the server console for error messages.
Verify that your ipstack API key is correctly configured in the config.yml file.
Ensure that the plugin is compatible with your server version.

API Usage (if applicable)

PlayerLocations does not currently provide an external API for developers.

Contributing

Contributions are welcome. You can contribute by providing useful code, suggesting new ideas for updates, or reporting issues/bugs encountered while using the plugin

License

PlayerLocations is licensed under the Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License.

You are free to:

Share — Copy and redistribute the material in any medium or format.
Adapt — Remix, transform, and build upon the material.

Under the following terms:

Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
NoDerivatives — If you remix, transform, or build upon the material, you may not distribute the modified material.

jallox/PlayerLocations