> For the complete documentation index, see [llms.txt](https://pickytweaks.gitbook.io/wanderer-project-showcase/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pickytweaks.gitbook.io/wanderer-project-showcase/manual/config.yml.md).

# config.yml

Understanding the config.yml

Hover over every line of text to understand its purpose.

<pre class="language-yaml" data-title="config.yml"><code class="lang-yaml"><strong>
</strong><strong><a data-footnote-ref href="#user-content-fn-1">players:</a>
</strong><strong>  <a data-footnote-ref href="#user-content-fn-2">enabled: true</a>
</strong>  <a data-footnote-ref href="#user-content-fn-3">show-own-icon-invisibility: true</a>
  <a data-footnote-ref href="#user-content-fn-4">show-helmet: true</a>
  <a data-footnote-ref href="#user-content-fn-5">invisibility: true</a> #Hide players from map with invisibility potion active?
  <a data-footnote-ref href="#user-content-fn-6">shift_invisibility: true</a> # Hide players from map if those are shifting?
  <a data-footnote-ref href="#user-content-fn-7">default-amount-waypoints: 5</a>
  <a data-footnote-ref href="#user-content-fn-8">map-position: right</a> # Left or right
  <a data-footnote-ref href="#user-content-fn-9">appearance:</a>
    <a data-footnote-ref href="#user-content-fn-10">default-image-invisibility:</a>
      <a data-footnote-ref href="#user-content-fn-11">image: "images/generic/crosshair.png"</a>
      <a data-footnote-ref href="#user-content-fn-12">width: 8</a>
      <a data-footnote-ref href="#user-content-fn-13">height: 8</a>
    x-offset: -3
    y-offset: -3
    width: 8
    show-trace:
      enable: true
      color: "#000000"



minecraft-mobs:
  enabled: true
  distance-range: 100
  max_height_range: 10
  #for instance, this will draw up 3 blocks on top and below the entity!
  #Resultin in a cuboid of 100 blocks with a max height of 3 + 3 + 2(player's size).

custom-mobs:
  enabled: true
  distance-range: 100
  max_height_range: 10
  #for instance, this will draw up 3 blocks on top and below the entity!
  #Resultin in a cuboid of 100 blocks with a max height of 3 + 3 + 2(player's size).


frame:
  image: default # assets -> frames.yml (type the unique name to assign the default frame)
  gif:
    ticks: 5 #ticks to re-create the gif (velocity)
  control-pixels:
    map_left:
      color-top-left: 0,0,0
      color-top-right: 0,0,0
      color-bottom-left: 0,0,0
      color-bottom-right: 0,0,0
      central: 180,0,0
    map_right:
      color-top-left: 0,0,0
      color-top-right: 0,0,0
      color-bottom-left: 0,0,0
      color-bottom-right: 0,0,0
      central: 220,0,0

map:
  control-pixels:
    map_left:
      color-top-left: 84,84,135
      color-top-right: 84,84,135
      color-bottom-left: 84,84,135
      color-bottom-right: 84,84,135
    map_right:
      color-top-left: 135,0,0
      color-top-right: 135,0,0
      color-bottom-left: 135,0,0
      color-bottom-right: 135,0,0
  mode:
    dynamic: true
    rotation: true # when dynamic is on, if rotation is true, the map will rotate.
  zoom_range:
    minimum: "CLOSEST"
    maximum: "NORMAL"

























</code></pre>

[^1]: <mark style="color:blue;">General icon options for the players.</mark>

[^2]: <pre class="language-yaml"><code class="lang-yaml"><strong><a data-footnote-ref href="#user-content-fn-14">enabled: true</a>
    </strong></code></pre>

    Enable/Disable player icons visibility on the map.

[^3]: <pre class="language-yaml"><code class="lang-yaml">  <a data-footnote-ref href="#user-content-fn-15">show-own-icon-invisibility:</a>
    </code></pre>

    When you are invisible and the cause is:

    * Vanish
    * Spectator mode
    * Potion effect

    You can decide to show the player its own icon or not.

[^4]: ```
    show-helmet: true
    ```

    When rendering the player's head on the map this option let you decide to render his helmet skin layer or not.

[^5]: ```
    invisibility: true
    ```

    This is a general rule that works for all the players.

    If this is set to true and a player is invisible the player will be hidden from the map from all players.

[^6]: ```
    shift_invisibility: true
    ```

    If this is set to true, when you sneak your own player head will be hidden from the map and replaced with a crosshair icon.

[^7]: ```
    default-amount-waypoints: 5
    ```

    Decide how many waypoints a player can save, by default 5.

[^8]: ```
    map-position: right
    ```

    This is a general rule, decide where to show the minimap by default between left or right.

[^9]: <mark style="color:blue;">Options for the player icons visual properties.</mark>

[^10]: ```yaml
    default-image-invisibility:
    ```

    This sub-section defines the file path of of the crosshair image when the player is sneaking.

[^11]: <pre class="language-yaml"><code class="lang-yaml"><a data-footnote-ref href="#user-content-fn-16">image: "images/generic/crosshair.png"</a>
    </code></pre>

    This is the actual file path in which the crosshair image will be stored by default.

[^12]: <pre class="language-yaml"><code class="lang-yaml"><a data-footnote-ref href="#user-content-fn-16">width: 8</a>
    </code></pre>

    Defines the width of the icon.

[^13]: <pre><code><a data-footnote-ref href="#user-content-fn-16">height: 8</a>
    </code></pre>

    Defines the height of the crosshair icon