To install the CraftSearch plugin on your server, download it and move the downloaded file in the /plugins/ folder of your server.
2. Configuration
To configure the plugin, start the server a first time to generate the /plugins/CraftSearch/config.yml file. When the file is generated, open it. You can find all options in this table :
Property
Description
name
Display name of the server in the search engine
description
Description of the server in the search engine
ip
Domain name or ip of your server
owner
UUID of the server owner, to link it with a CraftSearch Account in the manager
enable-premiumguard
Enable PremiumGuard service
enable-checkforupdate
Enable check for update
You have to reload/restart your server to apply changes.
The procedure to add one or multiple servers at once is the same, no matter if you are a hosting company, a server list company, an independent helper, or a server owner.
Step 1 : Generate an XML file somewhere on your website.
This is the hardest part. You will need to generate an XML file containing all the servers you want to add on CraftSearch. You can create the file manually, or if you have a large amount of servers to add, we recommend you making a script to generate the file. Here is the guideline to properly generate your XML file.
Your XML file should start with the <list> tag, and end with the </list> tag. If you do not add these tags, we will not be able to read your file.
You can only declare one list per XML file. If you use the <list> tag more than once in your XML file, we will not be able to read it at all.
Then, each server should be declared with the <server> tag at the beginning, and the </server> tag at the end of the server details. You should have as many <server> tags as the servers you want to add.
Inside a <server> tag, you will have to provide some informations about the server you want to add. Here is all the informations that you need to give :
Tag
Description
<ip>
The IP or domain name of the server with the port (if it is different of 25565)
Example: play.exmulhia.net
<name>
The name of the server you want to add.
Example: ExmulhiaMC
<description>
The description of the server being added.
Example: We provide high quality gaming experience, with exclusive mini-games like the Replica, the Space Water Run, or less exclusive mini-games like UHCs, Bedwars, or hide-and-seek. Join us now!
<online>
Set if the server is in online-mode. True or false. No other variable accepted. If you are pointing your Spigot server that is in offline-mode, and that you have an online-mode BungeeCord, you need to indicate false, because the server you are referring to is in offline-mode.
Example: true
<whitelist>
Set if the server has its whitelist enabled. True or false. No other variable accepted.
Example: false
<owner>
Set the premium Minecraft UUID of the owner. It will be used to check the server status directly in CraftSearch Manager. If you don’t want to give it, or don’t have one, please do not add the tag.
Example: 32ndhys-fnbsk42-gdnsjk6456-fn346
Note: the examples given are fake. Similarity with real data is coincidence.
To sum up, here is how your XML file should look like in the end, using your variables of course.
<list>
<server>
<ip>play.exmulhia.net</ip>
<name>ExmulhiaMC</name>
<description>We provide high quality gaming experience, with exclusive mini-games like the Replica, the Space Water Run, or less exclusive mini-games like UHCs, Bedwars, or hide-and-seek. Join us now!</description>
<online>true</online>
<whitelist>false</whitelist>
<owner>32ndhys-fnbsk42-gdnsjk6456-fn346</owner>
</server>
</list>
If you already have a CraftSearch account, jump to step 3.
You will need to have a premium Minecraft account to create your CraftSearch account. Log in into Minecraft using the version you want, and connect on mc.craftsearch.net. Once you are logged in, execute the /password command to set a password to your account.
Note : the examples given are fake. Similarity with real data is coincidence.
Once you confirm with the « Add this URL » button, you’re all set! We will scan your XML file in the following 5-10 minutes and progressively process the informations you gave to us.
Step 4 : optional step to make your Premium server compatible with Click-To-Connect.
You will need to use the PremiumGuard service, but it is not yet available. Please come back later.
You will need to set up a BungeeCord. After you successfully set your BungeeCord up, you will need to configure PremiumGuard.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
