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

# Installation/First Run

This page is dedicated to the installation of the plugin and its first run

Hawn is not dependent on any other plugin, because Hawn is a core plugin itself. It can be run without any problems. Maybe Hawn is not dependent on plugins to work, but some Hawn features have been added to support some plugins. Hawn supports PlaceHolderAPI, or WorldGuard etc. A section of this page is dedicated to the optional dependencies of the plugin, these plugins only add features to Hawn, nothing more.

### Installation

{% hint style="info" %}
Hawn runs on the spigot environment. This means that the plugin will only work if you have spigot, or a fork of spigot, like tacospigot, or paper.\
\
Hawn supports server versions from 1.8 to 1.15.2, as long as it's spigot or spigot-based (fork). Hawn supports java from version 1.8.
{% endhint %}

Once your server under a spigot environment is ready. You can begin the installation of the plugin:

* First, you need to get the plugin at this link: <https://www.spigotmc.org/resources/hawn-hub-lobby-management.66907/>
  * If the server is on, it is better to turn it off first to get a good and smooth installation.
* Once the file is downloaded, you will have to drag/copy it to the *"**plugins**"* folder on your server.&#x20;
  * If the folder does not exist, create one manually, but logically, the folder is created systematically when you start the server.
* Once you have the plugin file in the *"**plugins**"* folder, you can start your server.
  * A folder named *"**Hawn**"* will be created inside the folder named *"**plugins**"*. A certain number of files will be created, but don't panic, it may seem complicated at first, but as you go along, you will be able to use the plugin correctly.

{% hint style="info" %}
Let's create your server ! Well, your lobby server, normally you're here for that. But the plugin is very flexible, so.. it can be installed somewhere other than on a lobby server.
{% endhint %}

### First Run

After you have installed the plugin, and generated the Hawn folder with all its configuration files, the plugin configuration is separated in many folders, to contain the large number of configuration files generated by the plugin.

All the files that Hawn generates are in fact, modules, events, commands, messages (that you can configure as you wish) etc.

Hawn does not give default permissions, it is mostly up to you to assign permissions according to your needs.

You can disable Hawn (really disable) commands that you do not need. Add aliases or make your own commands.

For the moment, Hawn only supports MySQL databases, but in the future it will support SQLite data absences

### Need more features ?

Hawn supports **optional** plugins. **Optional** in the sense that you don't need them to run the plugin, but if you add them, it can add more possibilities to the plugin. Here is the list of these plugins:

* **PlaceholderAPI**
  * This plugin will allow you to use more placeholders within Hawn.\
    <https://www.spigotmc.org/resources/placeholderapi.6245/>
* **WorldGuard**
  * Hawn supports, for some of its functionalities, the integration of worldguard. All this is configured in its configuration files.\
    <https://dev.bukkit.org/projects/worldguard>
* **BattleLevels**
  * This plugin will allow you to use more placeholders within Hawn related to BattleLevels.\
    <https://www.spigotmc.org/resources/battlelevels.2218/>

{% hint style="success" %}
You are now **ready to use Hawn**, if you have the slightest error, or need support with the plugin, let me know on Discord, by sending me the error/problem directly in the reserved channel to avoid requesting them. You can also request features, I'm really open to all suggestion, *but I can't accept all, I am not a god in development.*
{% endhint %}