# Mist World Bot Guide

Welcome to the Mist World Bot guide! This guide is designed to help new users navigate and utilize the Mist World Bot effectively. We'll cover everything from basic keystrokes within the bot interface to scripting and configuration. Let's get started.

## 1. Getting Started with the Bot

### 1.a. Bot Interface Keystrokes

#### General Help

- Ctrl + H: Opens the bot's homepage and help section.

#### Translator Functions

- Alt + T: In the chat tab, toggles the bot translator on. This allows you to communicate in your own language while receiving all incoming messages translated into English, as if everyone is speaking English.
- Ctrl + T: Similar to Alt + T but translates all incoming text from Mist World.

#### Private Messaging

- Alt + Enter: Opens the private message window to select a user to send a message to.

#### Channel Navigation

- F4: While focused in the chat area, opens the channel dialog. You can type any name to set your channel, effectively creating or joining a channel with that name.
- The most commonly used system channel is general, where users ask questions.
- Note: Test accounts do not have access to this channel; it is reserved for paid users. Test users can use the test channel.

#### Server Ping

- F5: Sends a ping to the server to check the connection speed.

### 1.b. Scripts Management

#### Accessing the Scripts Tab

Tab over to the "Maps" or "Scripts" tab (depending on translation) to access your stored scripts. Note that the function keys may behave differently in this tab.

#### Creating New Scripts

- F1: Opens a dialog to create a new script. Enter a name and press Enter to create it.
- F4: On a script, opens it for editing, allowing you to read or write to the script.

#### Uploading/Downloading Scripts

- F6: In both the chat and script tabs, opens the Exchanger. This is the main tool for uploading and downloading scripts.
- To upload a script you've created to the bot server:
  1. Go to the Scripts/Maps tab.
  2. Select your script.
  3. Press Ctrl + U. It will automatically upload to the Exchanger.
- In the Exchanger (opened with F6), pressing Enter on a script downloads it. The file is saved into the "files" folder within the bot folder (think of this as the bot's download folder).
- Ctrl + E: Opens a shortcut to the bot's files and folders area.

#### Running Scripts

- To run a script, press Enter on it in the Maps/Scripts tab.
- F5 (in the Script tab): Refreshes your scripts if you have manually added them to your Maps folder.

### 1.c. Hotbar System for Scripts

The bot features a hotbar system for saving favorite scripts to keys for convenience.

- To assign a script to a number key (on the number row of your keyboard):
  1. Navigate to the script in your Scripts tab.
  2. Press Ctrl + Shift + [Number].
- Example: If you have a script that takes you to the gang entrance of every city and you assign it to the number 4, you can activate this script by pressing Alt + 4.
- You can assign scripts to numbers 1 through 0.

F7: On a script in the Maps/Scripts tab, opens the time dialog for scheduling a script to launch at a particular time.

## 2. Understanding Wallmaps

### 2.a. Importance of Wallmaps

The "maps" folder in the bot folder contains another folder called "wallmap."

Wallmaps are crucial for the bot to function effectively, especially when following a virtual map. These files contain X and Y coordinates marking where walls are in the game. This allows the bot to navigate around obstacles and reach specified locations without getting stuck.

### 2.b. Downloading and Installing Wallmaps

Most wallmaps are available, and you can get started by downloading the most up-to-date archive of wallmaps that Nikolaj uploaded. It is in the Exchanger and is called:

> area maps in English, check readme in archive.rar; Size: 36 KB; User: Nikolaj; Date of Uploading: 10-11-2024 09:46:44

To install:

1. Download and unpack the file.
2. Open the "wallmaps" folder within the extracted files.
3. Copy all the files named after areas.
4. Navigate to your Maps/Scripts folder (called "maps") in the bot folder.
5. Open the "wallmaps" folder.
6. Paste and replace the files.
7. Now you have many wallmaps, which should improve your experience with farming and navigating to locations.

### 2.c. Dealing with Non-English Wallmaps

Note that some of the wallmaps may be written in Chinese, which might appear blank to some English screen readers. To read these files, you may need to turn on an NVDA translator.

If you can't find a map, check the Chinese files first and rename them to match the location names as they appear in your game language (e.g., High Climbing Grasslands).

We have wallmaps in various languages including Spanish, English, and Russian. If you use another language, rename the wallmap files accordingly.

## 3. Scripting Basics

### 3.a. Starting with Scripts

To start learning how to script, press Ctrl + H and read through the content on the help page.

Additionally, download and read the following file carefully:

> List of commands for version 2024.11.09.txt; Size: 33 KB; User: Nikolaj; Date of Uploading: 09-11-2024 10:11:34

This file is a comprehensive list of functions and commands for the bot, painstakingly written by Nikolaj. It's regularly updated.

### 3.b. Essential Commands

At the top of every script, you should add the line:

    open_game_window

This ensures that the bot opens the game window when the script runs.

Example of a simple script to go to coordinates (50, 50):

    goposition=50|50

### 3.c. Pausing and Stopping Scripts

- Left Ctrl + F2: Stops the script completely and unloads it.
- F2: Pauses the script.

## 4. Additional Bot Functions

### Reloading the Bot

- Alt + R: Reloads the bot.

### Opening/Closing Mist World

- Alt + G: Automatically opens the Mist World game if it is not already open.
- Alt + Q: Closes Mist World.

## 5. Bot Configuration

### 5.a. Language Settings

In the main bot folder, you'll find a file called `language.ini`.

If you're an English speaker and find that some tabs in the bot are still in Russian, you can replace this file with the one created by Dippydippy, which translates the bot interface completely into English:

> language.ini; Size: 5 KB; User: Dippydippy; Date of Uploading: 22-09-2024 18:51:58

To install:

1. Download the file.
2. Move it from the "files" folder to the main bot folder.
3. Replace the existing `language.ini` file.
4. Your bot will now be fully translated to English.

Alternatively, you can edit the `config.ini` file in the main bot folder and change the following lines:

    translate_target_language=en
    translate_chat_write=en
    lang=English

### 5.b. NVDA and Screen Reader Compatibility

Note: You must be using NVDA (NonVisual Desktop Access) for the bot to work properly.

If you use the game's built-in SAPI, the bot cannot communicate with Mist World. Ensure that your incoming speech is set to NVDA in Mist World so the bot can interact with the game text.

## 6. Purchasing the Bot

Once you purchase the bot through Skrill or PayPal, you will have access to the general channel where users ask questions. In a test account, you're restricted to the "test" channel.

## 7. Contacting Admins

The admins of the bot are:

- Nikolaj
- Eugen

Reach out for support, but read through this setup file plus many other help files first. exercise common sense before asking questions where you can easily obtain answers. The help files with CTRL+h and the List of Commands file you can think of these as your handbook before you ask for function names in the general Channel.

## Conclusion

We hope this guide has helped you get started with the Mist World Bot. Happy botting!