Start here

Getting started · Updated 09 November 2026

Pick a language, find out where scripts live on disk, and run your first one.

BotWithUs scripts can be written in Java, Python or Lua. Whichever you choose, your script does not talk to the game directly. It runs inside a script host, a program the BotWithUs launcher installs and starts for you. The host reads live game state, hands it to your script, and sends your script's actions back to the game.

Which language should I pick?

Java Python Lua
Runs in the Java host bwu_host bwu_host
You install JDK 25 and Gradle nothing: Python 3.12 is bundled nothing: Lua 5.4 is bundled
A script is a JAR built from a Gradle project one .py file one .lua file
on_loop returns milliseconds milliseconds server ticks
Script Market (SDN) live coming soon coming soon
  • Java is the most complete option today, and the only one you can sell or share through the Script Market right now. It is the right choice if you want to publish a script.
  • Python is the quickest way to try an idea. Save a file and run it, with no build step.
  • Lua is small and simple, with no build step either. Its scripts run on one thread and pace themselves in game ticks.

Python and Lua run in the same native host, bwu_host, and see the same game state.

Where scripts go

Language Folder
Java ~/.botwithus/scripts
Python ~/.botwithus/scripts/python
Lua ~/.botwithus/scripts/lua

~ is your Windows user folder, so ~/.botwithus/scripts/python is %USERPROFILE%\.botwithus\scripts\python.

Running a script on your own machine

  1. Start the game through the BotWithUs launcher, so a client is running with BotWithUs attached.
  2. Put your script in the folder for its language (above).
  3. Open the host, pick your script and the client to run it on, and start it.

You can also run Python and Lua scripts from a console:

bwu_host --py $HOME\.botwithus\scripts\python\hello.py
bwu_host --lua $HOME\.botwithus\scripts\lua\woodcutter.lua

Each language section explains its own way of running scripts in detail.

Where to next