QuickStart
Download the plugin
Download the latest version of the plugin from here
Install the plugin
Copy the plugin jar file to your /plugins folder.
Configure the plugin
Edit the config.yml file to your liking. You can find the config file in the plugins/VPNStop folder.
Get an API key
You can get an API key from
https://proxycheck.io/
You're done! Now you can start your server and enjoy the plugin.
Commands
Default command. Will show the plugin info.
/vpnstop
Add an IP. connected player to the whitelist
/vpnstop add <ip|name>
Remove an IP. connected player to the whitelist
/vpnstop remove <ip|name>
Show the help menu
/vpnstop help
Show the player IP information
/vpnstop info <name>
Retrigger an IP checking
/vpnstop check <name>
Permissions
-
vpnstop.bypass: Allows bypassing the VPNStop plugin IP checking. OP only by default.
-
vpnstop.command.add: Allows players to add IPs to the whitelist. OP only by default.
-
vpnstop.command.remove: Allows players to remove IPs from the whitelist. OP only by default.
-
vpnstop.command.help: Allows players to see the help menu. OP only by default.
-
vpnstop.command.info: Allows players to get info about the plugin
-
vpnstop.command.check : Allows players to retrigger an IP checking
-
vpnstop.commands: Allows players to use VPNStop commands
Config file
api_url: "
https://proxycheck.io/v2/" # API URL
api_key: "Use your own api key" # API KEY
on_bad_ip: "broadcast %player% tried to join the server with IP %ip% but was blocked by VPNStop : %reason%"
%player% will be replaced by the player name and %ip% by the player IP and %reason% by the reason of the kick
kick_message: "Your IP is not allowed to join this server."
vpn_kick_message: "You are using a VPN connection. Please disable it and try again."
openvpn_kick_message: "You are using a OpenVPN connection. Please disable it and try again."
proxy_kick_message: "You are using a Proxy connection. Please disable it and try again."
tor_kick_message: "You are using a Tor connection. Please disable it and try again."
mobile_kick_message: "You are using a Mobile (H+/4G/5G) connection. Please log using a Wi-Fi connection and try again."
business_kick_message: "You are using a Business connection. Please log using your own Wi-Fi connection and try again."
hosting_kick_message: "You are using a Hosting connection. Please log using your own Wi-Fi connection and try again."
Check https://proxycheck.io/api/#type_responses for all types of connections details
block_vpn: true
# If true, the plugin will block VPN connections
block_openvpn: true
# If true, the plugin will block OpenVPN connections
block_proxy: true
# If true, the plugin will block Proxy connections
block_tor: true
# If true, the plugin will block Tor connections
block_mobile: true
# If true, the plugin will block Mobile connections
block_business: true
# If true, the plugin will block Business connections
block_hosting: true
# If true, the plugin will block hosting connections
COMMON QUESTIONS
How to get an API key?
You can get an API key from
https://proxycheck.io/
How to get the API URL?
The API URL is
https://proxycheck.io/v2/
Do you save data using this plugin?
No, we don't save any data. We only use the API to check if the IP is a VPN, OpenVPN, Proxy, Tor, Mobile, Business or Hosting connection.
Will this plugin stay free?
Yes, this plugin will stay free forever. The only thing I ask is to give me credit if you use this plugin in your server. The only thing you may pay for is the API key from proxycheck.io if the free one is not enough for you.
How can I support you?
You can support me by giving me a star on GitHub and visiting my patrons page:
https://www.patreon.com/yuri_hikari
Please check :
https://github.com/yurihikari/Vpn-Stop-Plugin