|
15 | 15 | <summary>Quick navigation</summary> |
16 | 16 | <ol> |
17 | 17 | <li> |
18 | | - <a href="#information">Information</a> |
| 18 | + <a href="#information">📚 Information</a> |
19 | 19 | </li> |
20 | 20 | <li> |
21 | | - <a href="#installation">Installation</a> |
| 21 | + <a href="#installation">📥 Installation</a> |
22 | 22 | </li> |
23 | 23 | <li> |
24 | | - <a href="#usage">Usage</a> |
| 24 | + <a href="#usage">✏ Usage</a> |
25 | 25 | </li> |
26 | 26 | </ol> |
27 | 27 | </details> |
|
30 | 30 |
|
31 | 31 | ## 📚 Information |
32 | 32 |
|
33 | | -**banco 🏦** provides server owners with a simple and configurable item-based currency system, ideal for RPG-style servers. |
34 | | - |
35 | | ->[!WARNING] |
36 | | -> banco is still under development. Although most of its features do work, we cannot promise a bug-free experience. You can report any misbehaviours or share any feedback by [creating an issue](https://github.com/myth-MC/banco/issues). |
| 33 | +**banco 🏦** provides server owners with a **simple** and **configurable** item-based currency system, ideal for RPG-style servers. The plugin has been designed with **performance** on mind, making it a good fit for small or large servers equally. |
37 | 34 |
|
38 | 35 | ### Features |
39 | 36 |
|
40 | | -* **Item-based** economy system |
41 | | -* Customizable items (display name, lore and **custom model data**) |
42 | | -* [Vault](https://www.spigotmc.org/resources/vault.34315/) support (Towny Advanced, Factions, Jobs Reborn...) |
43 | | -* [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) support |
44 | | -* **Multi-language** (full list [here](https://docs.mythmc.ovh/banco/administration/translations)) |
45 | | -* **Lightweight** and performant |
46 | | -* Developed with **configurability** and simplicity on mind |
47 | | -* No dependencies other than Vault |
| 37 | +* 💰 **Item-based** economy system with support for bundles |
| 38 | +* 💭 **Customizable items** (display name, lore, custom model data, item attributes...) with built-in support for **ItemsAdder**, **Nexo**, Slimefun, Oraxen, Nova and MythicMobs |
| 39 | +* 🤝 [Vault](https://www.spigotmc.org/resources/vault.34315/) support (Towny Advanced, Factions, Jobs Reborn...) |
| 40 | +* 🏷️ [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) support |
| 41 | +* 🌐 **Multi-language** (full list [here](https://banco.mythmc.ovh/docs/getting-started/configuration/translations/)) |
| 42 | +* 🍃 **Lightweight** and performant with scalable optimizations |
| 43 | +* 😮💨 Developed with **configurability** and simplicity on mind |
| 44 | +* ☕️ Extensive **API for developers** with countless possibilities |
| 45 | +* ‼️ No dependencies other than Vault |
48 | 46 |
|
49 | 47 | ### Planned features |
50 | 48 |
|
|
69 | 67 | ### Dependencies |
70 | 68 |
|
71 | 69 | * [Vault](https://www.spigotmc.org/resources/vault.34315/) 1.7+ or [VaultUnlocked](https://www.spigotmc.org/resources/vaultunlocked.117277/) 2.2+ (required) |
72 | | -* [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) (optional) |
73 | | -* [Towny Advanced](https://townyadvanced.github.io) (optional) |
74 | 70 |
|
75 | 71 | <div id="installation"></div> |
76 | 72 |
|
|
87 | 83 |
|
88 | 84 | When you run banco for the very first time it will automatically generate two files: |
89 | 85 | * 'settings.yml' contains general settings |
90 | | -* 'accounts.yml' is where data will be stored |
| 86 | +* 'accounts.db' is where accounts will be stored |
| 87 | + |
| 88 | +banco comes with a very simple emerald-based economy setup that can be expanded by modifying `settings.yml` |
| 89 | + |
| 90 | +### Built-in Integrations |
91 | 91 |
|
92 | | -banco comes with a very simple gold-based economy setup that can be expanded by modifying `settings.yml` |
| 92 | +* 🏷️ [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) |
| 93 | +* 🐣 [social](https://github.com/myth-MC/social) |
| 94 | +* Any other plugin with Vault support, including Factions, Towny Advanced, Jobs... |
93 | 95 |
|
94 | | -#### Other supported plugins |
| 96 | +<hr> |
95 | 97 |
|
96 | | -* [Towny Advanced](https://townyadvanced.github.io) |
97 | | -* [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) |
98 | | -* Any other plugin with Vault support |
99 | | - |
100 | | -<div id="bugs"></div> |
| 98 | +<a href="https://sponsor.mythmc.ovh/"> |
| 99 | + <img src="https://assets.mythmc.ovh/banner_godlike.png" /> |
| 100 | +</a> |
| 101 | +<div align="center"> |
| 102 | + <p>We're sponsored by <a href="https://sponsor.mythmc.ovh/">Godlike</a>, a high performance game server hosting. Check them out!</p> |
| 103 | +</div> |
0 commit comments