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

# Getting Started

> Get started with KoroneStrap

koroneStrap is a Python script that adds steroids to Korone!

<Warning>
  At this time, support is limited to **2020L** and **2021M** Korone clients. Development for **2017** and **2018** client compatibility is in progress.
</Warning>

<Accordion title="Supported platforms" icon="computer">
  * Windows XP, Windows Vista, Windows 7, Windows 8, Windows 10, Windows 11
  * macOS
  * Linux

  >
</Accordion>

<Tabs>
  <Tab title="Windows" icon={"windows"}>
    # Installation

    <Card title="Download latest release" icon="download" href="https://github.com/LittleBigDevs/koroneStrap/releases/latest/download/koroneStrap.exe">
      koroneStrap.exe
    </Card>

    <sub><sup>[or download previous releases](https://github.com/LittleBigDevs/koroneStrap/releases)</sup></sub>
  </Tab>

  <Tab title="macOS" icon={"app-window-mac"}>
    # Prerequisites

    * [wine](https://www.winehq.org)
    * [Python 8.0+](https://www.python.org/downloads/)
    * colorama
    * [git](https://git-scm.com)

    # Installation

    <Card title="Download the ZIP" icon="folder-archive" href="https://github.com/LittleBigDevs/koroneStrap/archive/refs/heads/main.zip">
      koroneStrap-main.zip
    </Card>

    <Accordion title="Alternative Method" icon="github">
      Clone the repository:

      ```zsh theme={null}
      git clone https://github.com/LittleBigDevs/koroneStrap
      ```

      >
    </Accordion>

    Cd into the folder:

    ```zsh theme={null}
    cd koroneStrap
    ```

    Install the required packages:

    ```zsh theme={null}
    pip3 install -r requirements.txt
    ```

    ## Usage

    Run the script:

    ```zsh theme={null}
    python3 koroneStrap.py
    ```
  </Tab>

  <Tab title="Linux" icon={"linux"}>
    # Prerequisites

    * [wine](https://www.winehq.org)
    * [Python 8.0+](https://www.python.org/downloads/)
    * colorama
    * [git](https://git-scm.com)

    # Installation

    <Card title="Download the ZIP" icon="folder-archive" href="https://github.com/LittleBigDevs/koroneStrap/archive/refs/heads/main.zip">
      koroneStrap-main.zip
    </Card>

    <Accordion title="Alternative Method" icon="github">
      Clone the repository:

      ```zsh theme={null}
      git clone https://github.com/LittleBigDevs/koroneStrap
      ```

      >
    </Accordion>

    Cd into the folder:

    ```bash theme={null}
    cd koroneStrap
    ```

    Install the required packages:

    ```bash theme={null}
    pip3 install -r requirements.txt
    ```

    ## Usage

    Run the script:

    ```zsh theme={null}
    python3 koroneStrap.py
    ```
  </Tab>
</Tabs>
