# UncomplicatedCustomItems (UCI)

<button type="button" class="button primary" data-action="ask" data-icon="gitbook-assistant">Ask a question...</button>

<a href="/spaces/lIh9axAte7Pryx4zxpm3/pages/LThc2RqOxBKU56Qt3TMy" class="button secondary" data-icon="rocket-launch">Get Started</a><a href="/spaces/lIh9axAte7Pryx4zxpm3/pages/h9axIj5sumogWQdi6sco" class="button secondary" data-icon="key">Custom Flags</a><a href="/spaces/lIh9axAte7Pryx4zxpm3/pages/7RAEvbqd5bVs7rGMGhI4" class="button secondary" data-icon="layer-plus">CustomItem API</a>

&#x20;

<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-leaf" style="color:$primary;">:leaf:</i></h4></td><td><strong>No code required</strong></td><td>Get started with UCI in 10 minutes.</td><td><a href="/spaces/lIh9axAte7Pryx4zxpm3/pages/7FvWQMF0kTK7HGhlQfmo">/spaces/lIh9axAte7Pryx4zxpm3/pages/7FvWQMF0kTK7HGhlQfmo</a></td><td><a href="/files/LHIOZGoI6dPF36TuRaxH">/files/LHIOZGoI6dPF36TuRaxH</a></td></tr><tr><td><h4><i class="fa-server" style="color:$primary;">:server:</i></h4></td><td><strong>CustomItem API</strong></td><td>Learn more about using UCI's CustomItems API.</td><td><a href="/spaces/lIh9axAte7Pryx4zxpm3/pages/7RAEvbqd5bVs7rGMGhI4">/spaces/lIh9axAte7Pryx4zxpm3/pages/7RAEvbqd5bVs7rGMGhI4</a></td><td><a href="/files/IaUMODRBBSBL8eUaPX09">/files/IaUMODRBBSBL8eUaPX09</a></td></tr><tr><td><h4><i class="fa-terminal" style="color:$primary;">:terminal:</i></h4></td><td><strong>Pre-release content</strong></td><td>Browse, test, and implement APIs.</td><td><a href="/spaces/lIh9axAte7Pryx4zxpm3/pages/i94vSoQwencxwzt5abep">/spaces/lIh9axAte7Pryx4zxpm3/pages/i94vSoQwencxwzt5abep</a></td><td><a href="/files/ebMoLMpZFyLqpzByuzrk">/files/ebMoLMpZFyLqpzByuzrk</a></td></tr></tbody></table>

&#x20;

&#x20;

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

## Get started in minutes

Make your first CustomItem in under 10 minutes.

This quickstart walks through the basic setup: downloading the plugin, creating a YAML file, and using custom flags.

{% hint style="warning" icon="life-ring" %}
**Need some help?**

Troubleshoot common issues or ask for help.

<details>

<summary>I'm getting a YAML exception in my console</summary>

* Make sure your CustomItem is following the correct format.
* Make sure you're using the correct collection type and closing them correctly

</details>

<details>

<summary>I can't run any commands</summary>

* Make sure you have the required permissions
* If you're using LabApi, the permissions file will be at `SCP Secret laboratory/LabApi/configs/Permissions.yml`
* If you're using Exiled, the permissions file will be at `EXILED/config/Permissions.yml`
* The required permission for a command is specified in its docs page.

</details>

<details>

<summary>My example does not run</summary>

* Make sure all the dependencies are installed.
* Check your console for exceptions or errors.
* If you cannot fix it, please send us a log report by running `ucilogs` in your server's console

</details>

<button type="button" class="button primary" data-action="ask" data-icon="gitbook-assistant">Explain what's happening...</button>
{% endhint %}

With your CustomItem done, use the guides for deeper setup and the API docs for examples and guides.

<a href="/spaces/lIh9axAte7Pryx4zxpm3/pages/7FvWQMF0kTK7HGhlQfmo" class="button primary" data-icon="rocket-launch">Get started</a> <a href="/spaces/lIh9axAte7Pryx4zxpm3/pages/brQhuUq0jupNo1GMRXCM" class="button secondary" data-icon="terminal">API</a>

&#x20;

&#x20;
{% endcolumn %}

{% column width="50%" %}
{% stepper %}
{% step %}

#### Download the plugin

Download the latest stable release from GitHub, or the latest pre-release from our Discord.

<a href="https://github.com/UncomplicatedCustomServer/UncomplicatedCustomItems/releases/latest" class="button primary">Latest Stable</a><a href="https://discord.gg/5StRGu8EJV" class="button secondary">Latest Pre-release</a>
{% endstep %}

{% step %}

#### Make your CustomItem

Below are some examples of CustomItems

{% tabs %}
{% tab title="CustomWeapon" %}
{% code expandable="true" %}

```yaml
```

{% endcode %}
{% endtab %}

{% tab title="CustomItem" %}

{% endtab %}

{% tab title="CustomArmor" %}

{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}

#### Load the CustomItem

You can either reload all CustomItems by running `uci reload` in the RA console or by restarting your server.
{% endstep %}
{% endstepper %}
{% endcolumn %}
{% endcolumns %}

&#x20;

&#x20;

<h2 align="center">Join a community of over 900 People</h2>

<p align="center">Join our Discord community or create your first PR in just a few steps.</p>

<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="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h4><i class="fa-discord">:discord:</i></h4></td><td><strong>Discord community</strong></td><td>Join our Discord community to post questions, get help, and share resources with over 900 like-minded people.</td><td><a href="https://discord.gg/5StRGu8EJV" class="button secondary" data-icon="arrow-left-from-bracket">Join Discord</a></td><td></td><td><a href="https://www.gitbook.com/">https://www.gitbook.com/</a></td></tr><tr><td><h4><i class="fa-github">:github:</i></h4></td><td><strong>GitHub</strong></td><td>Our product is 100% open source and built by developers just like you. Head to our GitHub repository to learn how to submit your first PR.</td><td><a href="https://github.com/UncomplicatedCustomServer/UncomplicatedCustomItems" class="button secondary" data-icon="arrow-up-to-line">Submit a PR</a></td><td></td><td><a href="https://www.gitbook.com/">https://www.gitbook.com/</a></td></tr></tbody></table>

&#x20;


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.uci.ucserver.it/home/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
