> For the complete documentation index, see [llms.txt](https://warden-plugins.gitbook.io/weconomy/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://warden-plugins.gitbook.io/weconomy/getting-started-with-weconomy.md).

# Getting Started with WEconomy

This page will guide you through the installation and configuration requirements, and introduce the plugin.

## Introduction

WEconomy is a plugin under the dependency of Vault that will allow you to have control over the economy of your server, you can choose two methods of storage made available, the data of the players are cached to avoid the influx of requests in database the name of your currency as well as the messages are customizable in the configuration file.

{% hint style="info" %}
**Note**: Due to the plugin's frequent updates, you may encounter bugs. If you find any, please report it in the [**Discord Server**](https://discord.gg/cJF48s3SBJ)
{% endhint %}

## Installation

Installing WEconomy is quite simple, and it installs like most other Spigot plugins.

1. Download the plugin from [**here**](https://www.spigotmc.org/resources/%E2%9C%85-weconomy-the-economy-easy-solution-1-16-5.107785/)**.**
2. Download [**Vault**](https://www.spigotmc.org/resources/vault.34315/).
3. Place the downloaded files in your `server/plugins` folder
4. Restart your server 

### Uninstalling

If, for some reason, you're dissatisfied with the plugin, or simply wish to switch to something else, here's how to properly uninstall it.

1. Stop your server.
2. Delete the config folder: `server/plugins/WEconomy`.
3. Delete the plugin from `server/plugins`.
4. Start your server.

{% hint style="info" %}
**Note**: We also recommend using [**Paper**](https://papermc.io/) over [**Spigot**](https://hub.spigotmc.org/jenkins/job/BuildTools/) for the best performance, as the plugin is tested with a Paper server, and Paper provides many glitch fixes and performance patches over Spigot. 

If you need any help, our [**Discord**](https://discord.gg/cJF48s3SBJ) is the place to go to ask for support!
{% endhint %}

## Extended Features

WEconomy can hook into other plugins to provide a better experience. These plugins are **NOT dependencies**, they are not required for WEconomy to function. These plugins are:

* [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/)
* [WMonsterCoins](https://www.spigotmc.org/resources/⭕-wmonstercoins-reward-for-hunting-1-16-5.107862/)
* [WBlockCoins](https://www.spigotmc.org/resources/⭐wblockcoins-reward-for-breaking-or-placing-blocks-1-16-5.107906/)
* [WAFKMode](https://www.spigotmc.org/resources/✨wafkmode-teleport-your-afk-reward-player-1-16-5.107948/)

### Server Software

WEconomy officially supports Spigot, and it is recommended to use Paper or one of its forks.

* [SpigotMC](https://hub.spigotmc.org/jenkins/job/BuildTools/)
* [PaperMC](https://papermc.io/) (Recommended)
* [Airplane](https://airplane.gg/)
* [Purpur](https://purpurmc.org/) (Recommended)
* [Tuinity](https://github.com/Tuinity/Tuinity)