> ## Documentation Index
> Fetch the complete documentation index at: https://udcore.unrealdirective.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start

> Learn how to install and contribute to the UDCore plugin in your Unreal Engine project.

## Getting Started

Welcome to the UDCore documentation guide. Follow the instructions below to learn how to install the UDCore plugin in your Unreal Engine project.

### 1. Prerequisites

* [**Unreal Engine**](https://www.unrealengine.com/en-US/download) - UDCore is works with Unreal Engine 5.3 or later.
* **Platform** - UDCore currently supports Windows 10 or later.

### 2. Installation

<AccordionGroup>
  <Accordion title="Plugin Downloader" icon="download">
    Plugin Downloader is a free marketplace plugin that allows you to easily install and update Unreal Engine plugins
    from GitHub from inside of the Unreal Engine editor.

    <Steps>
      <Step title="Install Plugin Downloader">
        Install [Plugin Downloader](https://www.unrealengine.com/marketplace/en-US/product/plugin-downloader) from
        the Unreal Engine Marketplace
      </Step>

      <Step title="Enable the Plugin Downloader plugin">
        * Open your Unreal Engine project.
        * Go to `Edit` -> `Plugins`.
        * Search for `Plugin Downloader` and enable it.
        * Restart the Unreal Engine editor.
      </Step>

      <Step title="Download the UDCore plugin">
        * Go to `Edit` -> `Plugins`
        * Click on `Download` in the upper left of the `Plugins` window
        * In the `Download Plugin` window, Select `UDCore` from the install list
        * Click on `Download` in the bottom right of the `Download Plugin` window
        * Wait for download to complete
        * Restart the Unreal Engine editor when prompted

        <Frame type="glass">
          <img src="https://mintcdn.com/unrealdirective/gTrBcYn7mADNUpHm/images/quick-start/download-udcore.jpg?fit=max&auto=format&n=gTrBcYn7mADNUpHm&q=85&s=b9f061fed25c709bcf183c346e4dd3f2" width="1920" height="1080" data-path="images/quick-start/download-udcore.jpg" />
        </Frame>
      </Step>

      <Step title="Enable the UDCore plugin">
        * Open your Unreal Engine project.
        * Go to `Edit` -> `Plugins`.
        * Search for `UDCore` and enable it.
        * Restart the Unreal Engine editor.
      </Step>
    </Steps>
  </Accordion>

  <Accordion title="Git Clone" icon="github">
    <Steps>
      <Step title="Clone the repository">
        ```sh theme={null}
        git clone https://github.com/UnrealDirective/UDCore.git
        ```
      </Step>

      <Step title="Copy the plugin to your Unreal Engine project" icon="puzzle-piece-simple">
        * Navigate to your Unreal Engine project's `Plugins` directory.
        * Copy the `UDCore` folder into the `Plugins` directory.
      </Step>

      <Step title="Enable the plugin" icon="github">
        * Open your Unreal Engine project.
        * Go to `Edit` -> `Plugins`.
        * Search for `UDCore` and enable it.
        * Restart the Unreal Engine editor.
      </Step>
    </Steps>
  </Accordion>
</AccordionGroup>

### 3. Contributing

We welcome contributions to enhance the functionality of UDCore. Please follow these steps to contribute:

<Steps>
  <Step title="Fork the repository">
    Fork the repository.
  </Step>

  <Step title="Create a new branch">
    Create a new branch (git checkout -b feature/YourFeature).
  </Step>

  <Step title="Commit your changes">
    Commit your changes (git commit -am 'Add new feature').
  </Step>

  <Step title="Push to the branch">
    Push to the branch (git push origin feature/YourFeature).
  </Step>

  <Step title="Create a new Pull Request">
    Create a new Pull Request.
  </Step>
</Steps>