# Download/Setup on a local PC

### Step 1

First, you will need to choose between the headless version or the launcher version. The headless version is just a console of the specific program, and the launcher version will let you choose which program you want to launch, just by supplying your binmaster key. In both versions you will need to tweak a bit the `config.json` and `filter.json`.

All files are available to download at [Links](/binmaster-docs/support/links.md).

### Step 2

Make sure that you have your binmaster key and a Hypixel API Key, for the binmaster key, go to [#bot-commands](https://discord.com/channels/966113525539934218/982045653666529280) and do `/key`, that will display your key, copy that. For the Hypixel API Key, go to the [Developer Panel](https://developer.hypixel.net/) and generate one.

### Step 3

{% hint style="danger" %}
**PLEASE READ THE BOX BELOW CONTINUING**\
**CONFIG**: Even though we don't mention it, please fill the other fields of the `config.json` file with the desired values, you can check what these values are [here](https://github.com/aesthetic0001/binmaster-docs).
{% endhint %}

{% hint style="warning" %}
**ZIPPED FILES:** Please do not run the executable without first unzipping the `.zip` file.
{% endhint %}

{% hint style="info" %}
**EDITING FILES IN LINUX:** File editing in Linux is done through the Command Line, you can learn the commands needed in [this page](https://www.linuxstart.com/edit-files-ubuntu/).
{% endhint %}

* **LAUNCHER**
  * **AH Macro:** If you downloaded the launcher version, install it, your OS will probably warn you about it but it is safe, on top of it, it is open source, so anyone can contribute to it. It will let you choose the AH Macro. Then, fill the `binmaster_key` field with the key you got by executing `/key`, and the `hypixel_api_key` with the Hypixel API Key, in the `Configure Executables` tab. Hit `Launch`, it will automatically download the latest version and start it, you will see the output in the panel on the left, and you will be able to type in the console with the input box.
  * **Combat Macro:** If you downloaded the launcher, install it, your OS will probably warn you about it but it is safe, on top of it, it is open source, so anyone can contribute to it. It will let you choose the Combat Macro. Then, fill the `binmaster_key` field with the key you got by executing `/key`. Hit `Launch`, it will automatically download the latest version and start it, you will see the output in the panel on the left, and you will be able to type in the console with the input box.
* **CONSOLE**
  * **AH Macro:** If you downloaded the console version. You will need to fill in the `config.json`, the `binmaster_key` field with the key you got by executing `/key`, and the `hypixel_api_key` with the Hypixel API Key. Then, run the executable, it will automatically download the latest version and start it.
  * **Combat Macro:** If you downloaded the console version. You will need to fill in the `config.json`, the `binmaster_key` field with the key you got by executing `/key`. Then, run the executable, it will automatically download the latest version and start it.

{% hint style="info" %}
**LINUX:** Before running the file in Linux, it is recommended to execute the command `chmod 777 binmaster-auction-linux` or `chmod 777 binmaster-slayer-linux` respectively, to give the necessary permissions to the executable.
{% endhint %}

### Step 4

While running, you can access the built-in webpage with your a browser:

* If you're on the same machine where you're running the bot, you can visit: `localhost:PORT`
* If you're on another machine but connected to the same WIFI, you can visit: `127.0.0.1:PORT`

{% hint style="danger" %}
**PORT:** `PORT` refers to the port you have set in the `config.json`, by default it should be set to `6969`.

**IT IS RECOMMENDED TO CHANGE IT TO ANOTHER VALUE TO AVOID UNWANTED ACCESS TO THE WEBPAGE**
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://binmasterdocs.gitbook.io/binmaster-docs/download-setup/download-setup-on-a-local-pc.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.