Usage Guide

Data Sources

The plugin currently supports six default methods for obtaining IP geolocation If you have your own ideas or channels, feel free to let me know

1. Offline local data source mode (supports IPv4/IPv6 with 99% data accuracy)
2. ipPlus360 online API mode (supports IPv4/IPv6, paid)
3. ipApi online API mode (supports IPv4/IPv6, free but with minute request limits)
4. whois online API mode (supports IPv4/IPv6, free)
5. voreApi online API mode (supports IPv4/IPv6, free)
6. Tencent Maps online API mode (requires an application Key and SecretKey)

Pros and Cons Analysis

Type	Cost	Data Accuracy	Internet Required	Network Support	Highest Support Level	Official Website
offline	Free	99%	No	IPv4 and IPv6	City Level	Official Website
ipPlus360	Paid	99.999%	Yes	IPv4 and IPv6	District Level	Official Website
ipApi	Free	99.9%	Yes	IPv4 and IPv6	City Level	Official Website
whois(1.3.0+)	Free	99.9%	Yes	IPv4 and IPv6	District Level	Official Website
voreApi(1.3.0+)	Free	99.9%	Yes	IPv4 and IPv6	District Level	Official Website
tencent(2.3.0+)	Per official terms	Per official data	Yes	Per official support	City Level	Official Website

Special Notes

For offline type starting from plugin version 2.0.0+, data is no longer built-in and needs to be downloaded manually and placed in the plugins/ip2region directory.

123 Drive: Click to Access
GitHub: Click to Access

For ipPlus360, we recommend purchasing the city-level version if you plan to buy it:
IPv4IPv6

If district-level data is needed:
Please add the following configuration to config.yml according to the official API documentation, modify for other levels as needed.

ipPlus360Ipv4Url: "https://api.ipplus360.com/ip/geo/v1/district/"
ipPlus360Ipv6Url: "https://api.ipplus360.com/ip/geo/v1/ipv6/district/"

For Tencent mode, create an application in the Tencent Maps console, enable WebServiceAPI and signature verification, then configure:

dataSource: tencent
tencentAppKey: "Tencent Maps application Key"
tencentAppSecret: "Tencent Maps SecretKey"

Testing Instructions

For offline, ipApi, and Tencent modes, add the following to config.yml, then reload the plugin and test with players logging in again.

testIp: Test IP

For ipPlus360 mode, add the following to config.yml, then reload the plugin and test with players logging in again (only one can be added at a time; if both are added, IPv4 will be used by default).

testIp4: Test IP
testIp6: Test IP