> For the complete documentation index, see [llms.txt](https://documentation.hak5.org/payload-studio/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.hak5.org/payload-studio/getting-started/getting-started.md).

# Getting Started

## TL;DR Overview

![PayloadStudio Overview](/files/UYpY3A7HtWlt7vejTYZy)

{% hint style="info" %}
Upon logging in for the first time PayloadStudio will take you on a tour; you can relaunch the tour under **Help** > **Product Tour** at any time for a refresher!
{% endhint %}

<figure><img src="/files/cXEApoTFtbGjYd5qbn5d" alt=""><figcaption><p>Help > Product Tour</p></figcaption></figure>

## Menu Bar

Access various features and settings of PayloadStudio. Clicking one will toggle the menu open/closed.

<figure><img src="/files/1GTjVtgLI6hxneGHJMmv" alt=""><figcaption><p>PayloadStudio Menu bar (Top Left)</p></figcaption></figure>

### File Menu

<figure><img src="/files/Zv8H6O4oRsQfpe4ci8wu" alt=""><figcaption><p>File menu from the Menu Bar</p></figcaption></figure>

### Import or Open Payloads

Don't know where to start on your payload writing journey? Open Examples, import via URL or even upload from local files directly into the editor!

<figure><img src="/files/fu3NRehNSwsNE254aAx1" alt=""><figcaption><p>Open / Import payload modal</p></figcaption></figure>

## Resources

Links directly to relevant repositories, Hak5 PayloadHub, Shop and Community.

<figure><img src="/files/nwZag7wyC66TLhK9EqXW" alt=""><figcaption><p>PayloadStudio Resources (Top Right)</p></figcaption></figure>

<figure><img src="/files/zCtBhXyS8kywkhxi7PAc" alt=""><figcaption></figcaption></figure>

## Payload Editor

Here you can craft your payloads for all your favorite Hak5 gear. We've got it all set up for you with everything from autocompletion to syntax highlighting and more. Where you'll spend most of your time in PayloadStudio!

{% hint style="info" %}
Remember: you can customize your experience in the [Settings!](/payload-studio/customization/editor-settings.md)
{% endhint %}

<figure><img src="/files/b8L8n6vvXpzLPNE71vXS" alt=""><figcaption><p>PayloadStudio Payload Editor</p></figcaption></figure>

## Compile /  Deploy

Compile your DuckyScript payloads, or, for other device modes, save your payload.

<figure><img src="/files/WIBkdflUUvrxhE94Varz" alt=""><figcaption><p>PayloadStudio Generate Payload / Save Payload button</p></figcaption></figure>

{% hint style="info" %}
[Read More](/payload-studio/getting-started/editing-basics.md) about devices and deploying payloads
{% endhint %}

## Console

PayloadStudio will use this as a location to tell you **important info.** It's also used for DuckyScript Debugging/Breakpoints. Errors, messages, and status updates will appear here.  Hide the console to keep it out of the way while building your payload or open it for an easy notepad-like environment to test your keystroke injection in! No more juggling multiple windows!

{% hint style="info" %}
The console can be used to **test** parts of your payload, *it's also a convenient text editor with the ability to Edit, Save, Clear, and toggle Open with ease.*
{% endhint %}

<figure><img src="/files/MUS7TYIesXUlDCkzDvnE" alt=""><figcaption><p>PayloadStudio Console</p></figcaption></figure>

### Open the Console

<figure><img src="/files/nFFcqoMnJjGgYcIVhGJ6" alt=""><figcaption><p>Console toggle button (Bottom Right)</p></figcaption></figure>

<figure><img src="/files/jLNrq7D0iIVvgyuQRuAv" alt=""><figcaption><p>Open the Console button</p></figcaption></figure>

### Minimize the console

<figure><img src="/files/Uc5mJceX9xfjSL3drQ6x" alt=""><figcaption><p>Minimize the console button</p></figcaption></figure>

{% hint style="info" %}
ESC / Escape will also minimize the console if it is open in the default keybinding mode
{% endhint %}

## Help menu

Here you can find links to more detailed documentation (here :wave:) as well as other useful info

* Documentation
* Quick Reference
* [Show Keybinds](/payload-studio/customization/keyboard-shortcuts.md)
* Relaunch Product Tour

<figure><img src="/files/auJhHdwAKVE5mUT8hLuD" alt=""><figcaption></figcaption></figure>

## Session Status bar

The session status bar provides at a glance info regarding your payload editing session as well as shortcuts to common actions.

<figure><img src="/files/SvckcauhVlVLZT7ObQWm" alt=""><figcaption><p>Session Status bar</p></figcaption></figure>

### <mark style="color:blue;">Info</mark>, <mark style="color:yellow;">warning</mark> and <mark style="color:red;">error</mark> counts

Info, warning and error counts are only used in USB Rubber Ducky mode

<figure><img src="/files/ylnE5iuEKgudkXCGl78r" alt=""><figcaption><p>Info, warning and error counts</p></figcaption></figure>

{% hint style="info" %}
Clicking one of the <mark style="color:blue;">Info</mark>, <mark style="color:yellow;">warning</mark> and <mark style="color:red;">error</mark> indicators will step through them in your editor
{% endhint %}

### Current DUCKY\_LANG

DUCKY\_LANG is only used in USB Rubber Ducky mode

<figure><img src="/files/h53FAHcahkd6wvyZEMoh" alt=""><figcaption><p>Info, warning and error counts</p></figcaption></figure>

{% hint style="info" %}
Clicking the language by default will bring you to [Compiler Settings](/payload-studio/customization/compiler-settings.md) to change your [DUCKY\_LANG](/payload-studio/customization/compiler-settings.md#ducky_lang)
{% endhint %}

### Editing / Read Only mode indicator and toggle

{% hint style="info" %}
Toggle editor from Read Only to Editing by clicking the label or icon pinned to the top right above the editor
{% endhint %}

<figure><img src="/files/5v1KtfCdYh1FmPfkosNS" alt=""><figcaption><p>Read Only Mode</p></figcaption></figure>

<figure><img src="/files/DfulsSfaosXK5DoBlSSo" alt=""><figcaption><p>Editing Mode</p></figcaption></figure>

### Session Save Status

{% hint style="info" %}
Auto save status is indicated at the top right of the editor\
![Unsaved Session Indicator](/files/M5RHPpGMXW2N1jbZlQVd) <mark style="color:red;">Unsaved</mark> ![Saved Session Indicator](/files/hHst2dxXNo2grMvLJHLN) <mark style="color:green;">Saved</mark>
{% endhint %}

## Breadcrumbs

Change Editor Modes by clicking the device name or logo, and view + edit your current payload filename

<figure><img src="/files/Mi4Atx1V8MAyIYjq9aVn" alt=""><figcaption><p>Breadcrumbs</p></figcaption></figure>

### Payload Name

Ready to export your payload source code? Naming it will help keep you organized. Change the name of your payload by double clicking the current payload name from the top left of the editor.

<figure><img src="/files/DsJq4rJ7U7jUJNyTETI0" alt=""><figcaption><p>Edit payload name</p></figcaption></figure>

### Device / Editing mode

Changing editor modes is as easy as two clicks!&#x20;

1. Click the current device from the top left of the editor
2. Choose a new device mode from the Device Picker Menu

<figure><img src="/files/mo14sPd5fjKjk4eIUuAE" alt=""><figcaption><p>Change editor mode</p></figcaption></figure>

<figure><img src="/files/I6qASR5tospwAIMgOuim" alt=""><figcaption><p>PayloadStudio Device Picker</p></figcaption></figure>

{% hint style="info" %}
[Read More](/payload-studio/getting-started/editing-basics.md) about devices and deploying payloads
{% endhint %}