# Developer Platform

<h2 align="center"><mark style="color:purple;"><strong>FisFisItemEvolve Wiki</strong></mark></h2>

<p align="center"><mark style="color:$primary;">The ultimate item evolution system for your Minecraft server.</mark></p>

<p align="center"></p>

<h3 align="center"><mark style="color:purple;"><strong>What is FisFisItemEvolve?</strong></mark></h3>

<p align="center"><mark style="color:$primary;">FisFisItemEvolve is a powerful and highly flexible plugin that introduces a dynamic item progression system to your server. Instead of static tools and weapons, items can now evolve into more powerful versions based on how they are used. A simple Iron Sword can become a legendary custom weapon by killing monsters, a pickaxe can upgrade itself by mining rare ores, and armor can grow stronger as it protects you from harm. All evolution paths are completely customizable through easy-to-use YML files.</mark></p>

<h4 align="center"><mark style="color:purple;"><strong>MC-Version:</strong></mark><strong> </strong><mark style="color:$primary;"><strong>1.16+</strong></mark>  </h4>

### <mark style="color:purple;">Key Features</mark>

* <mark style="color:$primary;">Dynamic Evolution Paths: Create an unlimited number of evolution paths for any item. Define the base item, the target item, and the progress required.</mark>
* <mark style="color:$primary;">Multiple Triggers: Items can gain progress through various actions:</mark>
  * `on_kill`: <mark style="color:$primary;">Killing mobs. (for item in main hand).</mark>
  * `on_block_break`: <mark style="color:$primary;">Breaking blocks. (for item in main hand).</mark>
  * `on_damage_taken`: <mark style="color:$primary;">Taking damage (for armor).</mark>
* <mark style="color:$primary;">Weighted Progress System: Assign different point values for different actions! Killing a Zombie might give 1 point, while killing a MythicMobs boss gives 500.</mark>
* <mark style="color:$primary;">Advanced Enchantment Control: Require base items to have specific enchantments to start evolving, and add new enchantments to the target item upon evolution.</mark>
* <mark style="color:$primary;">Deep Plugin Integrations: Natively supports custom items, blocks, and mobs from:</mark>
  * <mark style="color:$primary;">**ItemsAdder**</mark>
  * <mark style="color:purple;">**Oraxen**</mark>
  * <mark style="color:$success;">**Nexo**</mark>
  * <mark style="color:purple;">**MythicMobs**</mark>
* <mark style="color:$primary;">Fully Configurable: Customize everything from the</mark> `/evolve` <mark style="color:$primary;">menu to the messages and titles shown to players via the</mark> `config.yml`.

### <mark style="color:purple;">Commands & Permissions</mark>

#### <mark style="color:purple;">Player Commands</mark>

<mark style="color:$primary;">These are the commands that regular players will use.</mark>

<mark style="color:purple;">**/evolve**</mark>

<mark style="color:$primary;">Opens a graphical user interface (GUI) that displays the evolution path for the item currently held in the player's main hand. If the item has an evolution path, it will show the current item, the progress made, and the target item it will evolve into.</mark>

* <mark style="color:$primary;">Usage:</mark> `/evolve`
* <mark style="color:$primary;">Permission:</mark> `fisfisitemevolve.evolve` <mark style="color:$primary;">(Granted to all players by default)</mark>

#### <mark style="color:purple;">Admin Commands</mark>

<mark style="color:$primary;">These commands are intended for server administrators to manage the plugin.</mark>

<mark style="color:purple;">**/fie reload**</mark>

<mark style="color:$primary;">Reloads the</mark> `config.yml` <mark style="color:$primary;">and all evolution path</mark> `.yml` <mark style="color:$primary;">files from the</mark> `evolutions` <mark style="color:$primary;">folder. This is useful for applying changes made to the configuration on the fly.</mark>

* <mark style="color:$primary;">Alias:</mark> `/fisfisitemevolve reload`
* <mark style="color:$primary;">Usage:</mark> `/fie reload`
* <mark style="color:$primary;">Permission:</mark> `fisfisitemevolve.admin` <mark style="color:$primary;">(Should only be granted to administrators)</mark>

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><h4><i class="fa-folder">:folder:</i></h4></td><td><strong>Configurations</strong></td><td>information about how you can edit the config file.</td><td><a href="https://fisfis.gitbook.io/fisfisitemevolve/configurations">https://fisfis.gitbook.io/fisfisitemevolve/configurations</a></td><td><a href="https://793644067-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWp51H3X0qGUcyp4Db3F%2Fuploads%2FaZ1LUvm535rkZHw8eUVE%2Fimage.png?alt=media&#x26;token=c49e8340-406a-425a-ab36-7d9fe7518289">image.png</a></td></tr><tr><td><h4><i class="fa-book-blank">:book-blank:</i></h4></td><td><strong>Evolve Paths</strong></td><td>information about how you can edit the evolve files.</td><td><a href="https://app.gitbook.com/o/wrJZCtOEG3Hyck3YBMht/s/7XLyZusQsELRhUTi91zC/">Documentation</a></td><td><a href="https://793644067-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWp51H3X0qGUcyp4Db3F%2Fuploads%2FkONObKkcCob4j5GWMI4Q%2Fimage.png?alt=media&#x26;token=31240a53-7cbd-4467-bfd0-03a298131ca6">image.png</a></td></tr><tr><td><h4><i class="fa-suitcase-medical">:suitcase-medical:</i></h4></td><td><strong>Supported Plugins</strong></td><td>information about how you can use the supported plugins.</td><td><a href="https://fisfis.gitbook.io/fisfisitemevolve/supported-plugins">https://fisfis.gitbook.io/fisfisitemevolve/supported-plugins</a></td><td><a href="https://793644067-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWp51H3X0qGUcyp4Db3F%2Fuploads%2FddTFxmKAsyDPbl1oOhxk%2Fimage.png?alt=media&#x26;token=87472534-0b5d-49fe-b6a4-871e226e64f5">image.png</a></td></tr></tbody></table>

{% columns %}
{% column width="50%" %}

###

### <mark style="color:purple;">**See It in Action: Evolution Through Combat!**</mark>

#### <mark style="color:$primary;">Experience the thrill as your items grow with every challenge overcome. In this example, watch how a simple sword transforms into a more powerful weapon just by defeating enemies!</mark>

{% endcolumn %}

{% column width="50%" %}

<figure><img src="https://793644067-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWp51H3X0qGUcyp4Db3F%2Fuploads%2FucTcTRqUXTfctztjlDBC%2FEvolution%20%E2%80%90%20Clipchamp%20ile%20yap%C4%B1ld%C4%B1.gif?alt=media&#x26;token=a33512a8-73a4-48c9-86f5-df02565d1e80" alt=""><figcaption></figcaption></figure>
{% endcolumn %}
{% endcolumns %}

{% columns %}
{% column width="41.66666666666667%" valign="middle" %}

<figure><img src="https://793644067-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWp51H3X0qGUcyp4Db3F%2Fuploads%2FkvQyl4USSvecirHOCXpd%2Fevolve%20progress.png?alt=media&#x26;token=46ed16ad-a95d-4c1e-9413-cc60e767c74b" alt=""><figcaption></figcaption></figure>
{% endcolumn %}

{% column width="58.33333333333333%" %}

### <mark style="color:purple;">**Tracking Progress on Your Items**</mark>

<mark style="color:$primary;">You can easily track the evolution progress of your items directly in-game! As you use an item that has an evolution path, a special line of text will be added to its description (lore). This text automatically updates in real-time, showing your current progress towards the goal.</mark>

<mark style="color:$primary;">The format and text of this progress lore can be fully customized by server administrators in the</mark> `config.yml` <mark style="color:$primary;">file.</mark>
{% endcolumn %}
{% endcolumns %}

<h2 align="center"></h2>

{% columns %}
{% column width="58.333333333333336%" %}

### <mark style="color:purple;">**The /evolve Menu**</mark>

<mark style="color:$primary;">Want a more detailed, visual preview of your item's evolution path? Simply hold the item in your main hand and type the</mark> `/evolve` <mark style="color:$primary;">command.</mark>

<mark style="color:$primary;">A special menu will open, showing you:</mark>

* <mark style="color:$primary;">Your current item on the left.</mark>
* <mark style="color:$primary;">The target item it will evolve into on the right.</mark>
* <mark style="color:$primary;">A progress indicator in the middle with your exact points.</mark>
  {% endcolumn %}

{% column width="41.666666666666664%" valign="middle" %}

<div align="center"><figure><img src="https://793644067-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWp51H3X0qGUcyp4Db3F%2Fuploads%2FbCjafaWZhHHkI4Eouxql%2Fevolve%20gui.png?alt=media&#x26;token=f78f5804-684b-4f91-a7b2-36a555f70504" alt=""><figcaption></figcaption></figure></div>
{% endcolumn %}
{% endcolumns %}

<h2 align="center"><mark style="color:purple;"><strong>Any Questions ? Join Discord</strong></mark></h2>

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td><h4><i class="fa-discord">:discord:</i></h4></td><td><strong>Discord Community</strong></td><td>You can give me feedback, make suggestions, ask questions about the plugin and ask for help if you have a problem by joining my Discord server.</td><td><a href="https://discord.gg/rt8XtsEfmx" class="button primary">Join Discord</a></td><td data-object-fit="contain"><a href="https://793644067-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDWp51H3X0qGUcyp4Db3F%2Fuploads%2FifEavVDlUV5eunMXDKg1%2FFisFisLogo.png?alt=media&#x26;token=cd81b938-9f29-4b05-b64f-d195d55e4154">FisFisLogo.png</a></td></tr><tr><td><h4><i class="fa-github">:github:</i></h4></td><td><strong>HEADER</strong></td><td>Text</td><td><a href="https://app.gitbook.com/o/wrJZCtOEG3Hyck3YBMht/s/DWp51H3X0qGUcyp4Db3F/" class="button primary">Submit a PR</a></td><td></td></tr></tbody></table>
