> For the complete documentation index, see [llms.txt](https://scripting.breeze.rip/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://scripting.breeze.rip/newgen/getting_started.md).

# Getting Started

#### Creating the script file.

To start you have to create a javascript file inside of the breeze scripting folder. You can find this folder in two ways:

* Pressing the <i class="fa-folder">:folder:</i> icon inside of the breeze scripting tab.\
  ![](https://4203817094-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3UG7g7Xz12FZAHjyIrlp%2Fuploads%2Fgit-blob-060dba2f11ca9918eccc5e204de5c22e16a926ae%2Fimage%20\(2\).png?alt=media)
* Or manually navigate to the appdata folder, the same folder where [`.minecraft`](https://stickypiston.co/account/knowledgebase/130/How-do-I-find-my-Minecraft-Folder.html) is. In the folder navigate the following path to find the breeze scripting folder -> `breeze/<version>/scripts`, for example `breeze/26.1.2/scripts`.

In the `scripts` directory create a file with the name of your script ending with `.js`.

{% hint style="success" %}
The script name that shows up inside of breeze is defined by what you name the file! For example calling your file `PingSpoof.js` will make the script show up as **PingSpoof**.

<img src="https://4203817094-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3UG7g7Xz12FZAHjyIrlp%2Fuploads%2Fgit-blob-b15ef44fcd4bee85e034a9e88775d57993e70e5e%2Fimage%20(3)%20(1).png?alt=media" alt="" data-size="original">
{% endhint %}

#### Script Description

To start your script we can use the [script](/newgen/api/namespaces/script.md) namespace to set the description for the script.

```javascript
script.description = "Test description for this script";
```

#### Saving and reloading

Breeze watches the scripts folder. Saving a script reloads it on its own: settings keep their values, and a script that was enabled stays enabled. If the new code has an error, it shows up in the script's console and the script stays off until you save a working version.

#### Enabling, disabling and unloading

```javascript
script.onEnable(() => script.log("enabled"));
script.onDisable(() => script.log("disabled"));

// runs when the script is reloaded or removed, after onDisable: clean up anything you started here
script.onUnload(() => script.log("unloaded"));
```

{% hint style="warning" %}
A script that runs for too long at once (2 seconds while loading, 250 ms in any callback), for example because of an endless loop, is stopped and disabled so the game doesn't freeze. A script that throws 50 errors in a row is disabled too.
{% endhint %}
