How to Start
Information of the plugin to work correctly on your server.
Requirements
1) Spigot
You need Spigot or Paper for the plugin to work. Don't use Craftbukkit.
Optional Dependencies
1) MythicMobs or Citizens
If you want to add entities to searches you need MythicMobs: https://www.spigotmc.org/resources/5702/ or Citizens: https://www.spigotmc.org/resources/citizens.13811/
2) PlaceholderAPI
If you need to add TheSearch variables on another plugin: https://www.spigotmc.org/resources/placeholderapi.6245/
3) Holographic Displays, DecentHolograms or CMI
If you want to use the hologram find effect, you will need a hologram plugin:
HolographicDisplays: https://dev.bukkit.org/projects/holographic-displays DecentHolograms: https://www.spigotmc.org/resources/96927/ CMI: https://www.spigotmc.org/resources/3742/
Installation and first steps
To install the plugin on your server place the TheSearch.jar file inside your plugins folder and start your server.
To start using the plugin do the following:
Use
/thesearch create <name>
to create a new Search.Use
/thesearch addblock <name>
looking at a block, to add it to the Search. This block is the one players must find. If you want players to find a mob/entity instead, use/thesearch addentity <name>
looking at a MythicMobs/Citizens entity. You can find a more detailed example of this HERE.
You will see that the block now displays a particle. This particle will show only to players that haven't find the object. This particle is completely configurable.
You can now start editing the properties of this Search. There are 2 ways.
The first one is to open the editing GUI using /thesearch edit <search>
. There you can change actions when finding objects of the search, teleport to objects, get some informational variables, and so on...
The Editing GUI is still being built, there are some missing options. You can modify the missing properties on the config.
The second way is to modify all the properties of the search in its config on the searches folder. Click HERE to learn about all the options.
Last updated