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

# Quickstart

> Get your script ready in under 10 minutes

## Creating your account

Luarmor works with an `invite code` system. This means that you can only create an account if you have an invite code. You can also buy invite codes for other people to use!

<AccordionGroup>
  <Accordion title="Getting an invite code">
    Invite codes can be purchased from the main site [here](https://luarmor.net/#prices).
  </Accordion>

  <Accordion title="Extending your membership">
    Invite codes can also be used to extend your membership by an extra 30 days by redeeming an invite code on your [profile page](https://luarmor.net/profile).
  </Accordion>

  <Accordion title="Creating an account">
    <Steps>
      <Step title="Go to the site">
        Go to the [registration page](https://luarmor.net/signup).
      </Step>

      <Step title="Enter your invite code">
        Enter your invite code in the `Invite Code` field.
      </Step>

      <Step title="Fill in the form">
        Fill in the rest of the form and click `Register`.

        <Frame caption="Successful registration">
          <img src="https://mintcdn.com/luarmor/8pPKYh_Y132D2Y4u/images/create-step-1.png?fit=max&auto=format&n=8pPKYh_Y132D2Y4u&q=85&s=995a4a3ae94520aa987da8ea73d7b107" alt="The screen you see after successfully registering" width="696" height="669" data-path="images/create-step-1.png" />
        </Frame>
      </Step>

      <Step title="Receive your login credential">
        You will receive your login credential (`API Key`) in your emails

        <Frame caption="API key in email">
          <img src="https://mintcdn.com/luarmor/8pPKYh_Y132D2Y4u/images/create-step-2.png?fit=max&auto=format&n=8pPKYh_Y132D2Y4u&q=85&s=6252e6f9d38532955c3b9c017288aa1a" alt="An email from Luarmor, showing the API key" width="599" height="239" data-path="images/create-step-2.png" />
        </Frame>
      </Step>

      <Step title="Log in">
        [Log in](https://luarmor.net/login) to your account and access the dashboard with your API Key.

        <Frame caption="Successful log in">
          <img src="https://mintcdn.com/luarmor/8pPKYh_Y132D2Y4u/images/create-step-3.png?fit=max&auto=format&n=8pPKYh_Y132D2Y4u&q=85&s=63ec7b895930867228a0a2ff243c512b" alt="The screen you see after successfully logging in" width="569" height="381" data-path="images/create-step-3.png" />
        </Frame>
      </Step>
    </Steps>
  </Accordion>
</AccordionGroup>

## Creating a project

Luarmor has a feature called **project folders**. They can contain multiple scripts, allowing you to have a **script hub** with multiple games in it.

<AccordionGroup>
  <Accordion title="Create a project">
    A project can contain multiple scripts. You can create a project [here](https://luarmor.net/projects) by clicking `Create Project`.

    <Frame caption="Luarmor dashboard">
      <img src="https://mintcdn.com/luarmor/8pPKYh_Y132D2Y4u/images/create-step-4.png?fit=max&auto=format&n=8pPKYh_Y132D2Y4u&q=85&s=e32d449ce5050d8e4c2acf039287422f" alt="An image showing the Luarmor dashboard with the mouse over the `Create Project` button" width="964" height="433" data-path="images/create-step-4.png" />
    </Frame>
  </Accordion>

  <Accordion title="Enter project details">
    Enter all of the details for the project including the name, webhooks, and configuring HWID resets.

    <Frame caption="Project details all filled in">
      <img src="https://mintcdn.com/luarmor/8pPKYh_Y132D2Y4u/images/create-step-5.png?fit=max&auto=format&n=8pPKYh_Y132D2Y4u&q=85&s=1786151e4a6886b83a26126cf5cd7d09" alt="An image showing all of the project details filled in" width="677" height="531" data-path="images/create-step-5.png" />
    </Frame>
  </Accordion>
</AccordionGroup>

## Uploading your script

All scripts live inside a project, to learn how to create one, please refer to the previous section.

<AccordionGroup>
  <Accordion title="Upload your script to the project">
    To start uploading a script, under the project you created, click `New Script`.

    <Frame caption="The button to click that adds a script to the project">
      <img src="https://mintcdn.com/luarmor/8pPKYh_Y132D2Y4u/images/create-step-6.png?fit=max&auto=format&n=8pPKYh_Y132D2Y4u&q=85&s=5918635a9df029e2a01a2396ef808fe9" alt="The button to click that adds a script to the project" width="772" height="480" data-path="images/create-step-6.png" />
    </Frame>
  </Accordion>

  <Accordion title="Enter script details">
    After you click `New Script`, you will be prompted to enter the script details. Fill in all of the details, **upload your script**, and press the green tick in the top right.

    <Note>
      Your screen may be too small and you may not be able to see the `Upload File` button. If this is the case, try to zoom out or use another computer / monitor.
    </Note>

    <Frame caption="Entering all of the script details">
      <img src="https://mintcdn.com/luarmor/8pPKYh_Y132D2Y4u/images/create-step-7.png?fit=max&auto=format&n=8pPKYh_Y132D2Y4u&q=85&s=398844a0316f63b847512cc16f8cd225" alt="An image with all of the script details filled in" width="655" height="587" data-path="images/create-step-7.png" />
    </Frame>
  </Accordion>
</AccordionGroup>

## Distributing your script

After you have uploaded your script, you can now download the loader script and start whitelisting users.

<AccordionGroup>
  <Accordion title="Download the loader">
    <Warning>
      Please use the Luarmor loadstring to ensure your script is always up to date. Uploading the contents of the loadstring and using that instead will cause an error!
    </Warning>

    Download the loader script by clicking the `Loader` button.

    <Frame caption="Highlighted button that downloads the loader">
      <img src="https://mintcdn.com/luarmor/8pPKYh_Y132D2Y4u/images/create-step-8.png?fit=max&auto=format&n=8pPKYh_Y132D2Y4u&q=85&s=36c4f9bdc1e295f6adc7c41858843dda" alt="An image with the red box around the download 'Loader' button" width="928" height="586" data-path="images/create-step-8.png" />
    </Frame>
  </Accordion>

  <Accordion title="Create whitelist keys">
    Generate an empty key on the [user](https://luarmor.net/users) area and give it to the user. Alternatively, you can mass-generate keys and put them to your [Sellix](https://sellix.io) / [Shoppy](https://shoppy.gg) as `serials` for automated purchases.

    <CardGroup>
      <Frame caption="Mass generate keys">
        <img src="https://mintcdn.com/luarmor/8pPKYh_Y132D2Y4u/images/create-step-9.png?fit=max&auto=format&n=8pPKYh_Y132D2Y4u&q=85&s=10bf3d063152a2c64e122a44ab7bfd45" alt="The screen that lets you pass generate keys" width="627" height="558" data-path="images/create-step-9.png" />
      </Frame>

      <Frame caption="Upload keys to Sellix">
        <img src="https://mintcdn.com/luarmor/8pPKYh_Y132D2Y4u/images/whitelist-key-sellix.gif?s=5b136af490675f617b7f0ecc967d8e60" alt="A gif showing uploading keys to Sellix" width="1017" height="609" data-path="images/whitelist-key-sellix.gif" />
      </Frame>
    </CardGroup>
  </Accordion>
</AccordionGroup>

## Mass import / export users

<AccordionGroup>
  <Accordion title="Import">
    To import all your users, it's recommended to use the JSON format when exporting.

    <Steps>
      <Step title="Go to your project settings">
        Go to your project settings by clicking the gear icon next to the project in the [user dashboard](https://luarmor.net/users)

        <Frame caption="Gear icon highlighted">
          <img src="https://mintcdn.com/luarmor/8pPKYh_Y132D2Y4u/images/project-gear-icon.png?fit=max&auto=format&n=8pPKYh_Y132D2Y4u&q=85&s=4930e13dcf500f6243c7ed814fe5fe61" alt="The gear icon highlighted next to the project on the user dashboard" width="933" height="599" data-path="images/project-gear-icon.png" />
        </Frame>
      </Step>

      <Step title="Import">
        Press `Import JSON` and paste the JSON file you exported earlier.

        <Frame caption="Import JSON button">
          <img src="https://mintcdn.com/luarmor/8pPKYh_Y132D2Y4u/images/project-import-users.png?fit=max&auto=format&n=8pPKYh_Y132D2Y4u&q=85&s=f1fef02cc4af0509bc363009eb5ce877" alt="The import JSON button highlighted" width="627" height="474" data-path="images/project-import-users.png" />
        </Frame>
      </Step>
    </Steps>
  </Accordion>

  <Accordion title="Export">
    You can export all your users to either a TXT file or JSON file. For images, see the import section.

    <Steps>
      <Step title="Go to your project settings">
        Go to your project settings by clicking the gear icon next to the project in the [user dashboard](https://luarmor.net/users)
      </Step>

      <Step title="Download">
        Press either `Download TXT` or `Export JSON`. To import later, it's recommended to use `Export JSON`.
      </Step>
    </Steps>
  </Accordion>
</AccordionGroup>
