Scripting
A script plays a repetitive part of the game for you: it climbs the Sky Pass, works through kungfu creation, or runs a long NPC errand from start to finish, while you watch or do something else.
What a script can do
Battlemation already fights and Auto-travel already walks. A script ties those together with everything in between: it talks to NPCs, picks their answers, starts and finishes fights, buys and uses items, catches pets, joins teams and moves on to the next step. It can also read your stats and your pets' — and spend your attribute points as you level.
The game ships with a library of ready-made scripts:
- Sky Pass, Couples Pass and Friends Pass — climb the tower and claim a chest, as many times as you like;
- Kungfu Creation — raise the Kungfu stat, or keep trying until one move is made;
- Leave the Martial Circle and Cindyflys for Thievery — two long NPC errands;
- Jingle Jailbreak — trades the level-1 Jingles in your pet stable for MermaidNecklaces, storing the necklaces at a pawnshop as the bag fills.
You can also write your own in Lua, a small programming language that is easy to pick up.
Quick start
- In the game, open Action → Script.
- Pick a script from the list, read its description and check its settings.
- Press Start. The window closes and the script goes to work. Its progress shows in chat.
- Press Esc at any time to stop it.
The ground rules
- It runs in your game client. The client has to stay open and logged in. Logging out or losing the connection stops the script, and it does not start again by itself when you come back.
- One script at a time, and not while Battlemation is running. Starting a script turns Auto Fight and Repeat Battle off; the script decides how each fight is fought.
- You can always take over. Pressing Esc, clicking the ground or clicking a monster stops the script at once.
- Scripts never fight other players. If you are pulled into a fight against players or their pets, the script stops and the fight is yours to play.
- The server's rules still apply. A script can only do what you could do by hand, and it pays the same fees, needs the same items and gets the same refusals.
Scripts are allowed here. They are a supported part of the game client, not a cheat, and nothing on the server treats a scripted player differently.