> For the complete documentation index, see [llms.txt](https://ajneb97.gitbook.io/thesearch/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ajneb97.gitbook.io/thesearch/how-to-start.md).

# How to Start

## Requirements

**1) Spigot**

{% hint style="warning" %}
You need Spigot or Paper for the plugin to work. Don't use Craftbukkit.
{% endhint %}

## Optional Dependencies

**1) MythicMobs or Citizens**

{% hint style="info" %}
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/>
{% endhint %}

**2) PlaceholderAPI**

{% hint style="info" %}
If you need to add TheSearch variables on another plugin: <https://www.spigotmc.org/resources/placeholderapi.6245/>
{% endhint %}

**3) DecentHolograms or FancyHolograms**

{% hint style="info" %}
If you want to use the hologram find effect, you will need a hologram plugin:

FancyHolograms: <https://modrinth.com/plugin/fancyholograms>\
DecentHolograms: <https://www.spigotmc.org/resources/96927/>
{% endhint %}

## 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:

1. &#x20;Use `/thesearch create <name>` to create a new Search.
2. Use `/thesearch addblock <name>` . This will enable a mode to start adding blocks to searches.\
   Right click the block you want players to find to add it to the Search.\
   \
   If you want players to find a mob/entity instead, use `/thesearch addentity <name>` . You can only add MythicMobs/Citizens entities. You can find a more detailed example of this [**HERE**](/thesearch/examples/search-with-mythicmobs-example.md).

<figure><img src="/files/Eb8xwe6KNkBpmnJSs99x" alt=""><figcaption></figcaption></figure>

3. 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.
4. 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...

<figure><img src="/files/lyPIU7idVJd4TWlbCpfW" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
The Editing GUI is still being built, there are some missing options. You can modify the missing properties on the config.
{% endhint %}

The second way is to modify all the properties of the search in its config on the searches folder. Click [**HERE**](/thesearch/searches-tutorial.md) to learn about all the options.