> For the complete documentation index, see [llms.txt](https://wiki.glaremasters.me/guilds/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.glaremasters.me/guilds/installation.md).

# Installation

## First-Time Setup

1. Download the latest jar file from either the SpigotMC page or the development build page. You can find the latest version from SpigotMC [right here](https://www.spigotmc.org/resources/66176/)!
2. Locate your server's plugin directory, then place the Guilds jar you grabbed in the previous step into that folder!
3. Start your server and then step it again so that the plugin can generate all the data it needs to. You can now find the config in `/Guilds/config.yml`
4. Make any changes you need to the config, then save it!
5. Start the server back up and you'll be ready to rock and roll!

## Requirements

### Plugin Dependencies

**Vault** [Vault](https://www.spigotmc.org/resources/34315/) is a requirement for the plugin to run. It helps handling economy and permissions. Please make sure this plugin is on your server before you try and start Guilds, or it will NOT start!

**Economy Plugin** An economy plugin is required to make the plugin work properly. Some popular ones are [EssentialsX](https://www.spigotmc.org/resources/9089/), [TheNewEconomy](https://www.spigotmc.org/resources/7805/), etc.

**Permission Plugin** A permission plugin is required on for this plugin to work properly. The commands and other features all use permission nodes to properly work. A popular one is [LuckPerms](https://www.spigotmc.org/resources/28140/)!

### Server Dependencies

**CPU:** The plugin will run perfectly fine on basically any CPU. It's optimized to be smooth and non-intensive to the server it runs on.

**RAM:** Guilds will uses fairly little RAM. You should expect to see a usage of at least 256MB on startup from the plguin and depending on how many Guilds you have on the server, it could be a little higher.

**Disk Space:** Guilds uses very little space. It's optimized to keep itself clean and not bloat up your drive.