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

# Introduction

> Learn the basics of Spoofify

<Note>
  Spoofify can be self-hosted, or hosted for you by Ducky.
</Note>

### Glossary

<AccordionGroup>
  <Accordion title="Self-Hosted">
    This refers to the act of copying the project files and running them either on your computer, or on your own server.
  </Accordion>

  <Accordion title="Browser Overlay">
    This refers to a webpage that can be displayed as a **Browser Source** within broadcasting software (i.e. OBS Studio)

    Usually used to display "widgets" on a user's stream.
  </Accordion>

  <Accordion title="User ID">
    A User ID is a publicly visible unique string of characters that identifies a specific user on any given platform.
  </Accordion>

  <Accordion title="Access Token">
    An access token is a unique string of characters generated by the API granting specific permissions to the application, called Scopes.

    **The Access Token should be treated like a password to your API application. Never share it.**
  </Accordion>

  <Accordion title="Refresh Token">
    A refresh token is a unique string of characters generated by the API, used to regenerate (refresh) an Access Token.

    **The Refresh Token should be treated like a password to your API application. Never share it.**
  </Accordion>

  <Accordion title="Scopes">
    Scopes are a set of permissions (scopes) that a user grants an application to generate an Access Token.

    Scopes dictate which parts of an API are available to an application.
  </Accordion>

  <Accordion title="Client ID">
    A Client ID is a public-facing unique string of characters that identifies which application is making an API request.
  </Accordion>

  <Accordion title="Client Secret">
    A Client Secret is a unique string of characters, tied to the Client ID.

    **The Client Secret should be treated like a password to your API application. Never share it.**
  </Accordion>
</AccordionGroup>

## What is Spoofify?

Spoofify is a Spotify-focused Now Playing Overlay & Queue Management Twitch bot.

Spoofify can be hosted by Ducky for you, or [self-hosted](self_hosted/installation).

### Running Spoofify

<Columns cols={2}>
  <Card title="Self-Host" icon="download" cta="View Installation Guide" href="self_hosted/installation">
    Install and run Spoofify on your own machine
  </Card>

  <Card title="Ducky Hosting" icon="duck" cta="Contact Ducky on Discord" href="https://ducky.wiki/travel/discord">
    Contact Ducky via Discord to have Spoofify hosted for you on a domain of your choosing. (BYOD)
  </Card>
</Columns>