Custom Combat Script

From Kolmafia
Revision as of 08:04, 15 March 2021 by Philmasterplus (talk | contribs) (→‎Macros in Consult Scripts)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Basic CCS

A Custom Combat Script (CCS) is a way of instructing mafia how to handle combat, round by round. For example, a simple CCS would be to tell mafia to pickpocket on round 1, then cast entangling noodles on round 2 and finally on rounds 3+ to use shieldbutt. If it is unable to carry out one of those steps, then that step will be skipped. For instance, if the character failed to get initiative, then pickpocket will be skipped and the character will go straight to entangling noodles. That CCS would look like this:

[ default ]
try to steal an item
skill entangling noodles
skill shieldbutt

If you wanted to treat different monsters differently, that can be accommodated also. For instance, the following CCS will attempt to cast Transcendent Olfaction upon Black Knights while treating all other monsters differently. If the character currently has "On the Trail" then that line will be skipped.

[ Black Knight ]
try to steal an item
skill transcendent olfaction
skill entangling noodles
skill shieldbutt

[ default ]
try to steal an item
skill entangling noodles
skill shieldbutt

Note that when you use a CCS, your CLI will report "character executes a macro!" because the CCS is converted into a macro to save on page loads

Available Commands

  • attack
  • skill
  • item, use
  • try to steal an item, pickpocket
  • summon pastamancer ghost
  • jiggle chefstaff
  • combo {followed by one of the following}
    • Disco Concentration, Disco Nirvana, Disco Inferno, Disco Bleeding, Disco Blindness
    • Rave Knockout, Rave Bleeding, Rave Concentration, Rave Steal, Rave Nirvana, Rave Stats
    • random rave
  • abort
  • abort after
  • section [section name]
  • special
  • delevel
  • skip
  • note
  • twiddle

Using ASH Constants in CCS

Certain ASH constants can be used in CCS as section headers.

  • $phylum[ ] refers to the 22 Monster Phylumn.
  • $element[ ] refers to either the attack or the defense element. As long as one matches, this check will be satisfied.
  • $item[ ] refers to an item that the monster drops. If there are multiple monsters that drop the item (such as SGEEA) it will match any of those monsters.

You may specify more than one of these, but unless everything matches, it won't match. So if you specify an impossible combination, that CCS section will not run.

[ $element[ spooky ] $item[ hobo nickel ] ]
skill entangling noodles
skill weapon of the pastalord

[ bathroom $element[ spooky ] ]

[ $phylum[ beast ] ]
skill stomp

Macros in CCS

Macros may be used in a Custom Combat Script in addition to the basic commands. Any line in quotes and any macro command used in a CCS will be made into part of the macro which KoLmafia is passing to KoL. You can find an primer on all KoL's macros at Combat Macros.

Also there is a section in the CCS called "global prefix" which will be part of every combat macro KoLmafia generates, regardless of the monster encountered.

Example of CCS Macro

Here's an example of a CCS that generates a macro which will cause KoL to wait for a hobo monkey to steal meat from your enemy before launching attacks.

[ default ]
sub monkey_stasis

while !match "climbs up and sits on your shoulder" && !pastround 20 && !hppercentbelow 20
call stasis_item

call monkey_stasis

[ global prefix ]
"abort missed 5"
"abort pastround 27"
sub stasis_item

if hascombatitem facsimile dictionary
item facsimile dictionary
goto _endstasisitem
if hascombatitem seal tooth
item seal tooth
goto _endstasisitem
if hascombatitem spices
item spices
goto _endstasisitem
if hascombatitem spectre scepter
item spectre scepter
goto _endstasisitem
if hascombatitem dictionary
item dictionary
goto _endstasisitem
"abort "No infinite use items detected!" "
mark _endstasisitem

sub stasis

while !pastround 20 && !hppercentbelow 20 && mppercentbelow 99
call stasis_item


Concerns for macros in CCS

  • A macro's abort command needs to be encased in quotes because abort is also a legal CCS command. That's why all aborts in the previous example were quoted.
  • If a comment is the last line in a CCS, that will be used as your finishing attack even though it does nothing. Never conclude a CCS with a macro comment or it will abort to the mini-browser with a warning from KoL that you executed 37 commands in a row without taking an action.

Consult Scripts

While a CCS may seem reasonably flexible, sometimes you will want to do something too complicated to express in that format. For instance if you want your character to take different actions based on your characters current stats or current monster level, a consult script can automatically figure it out. There are few limits to what a consult script can enable. The downside to using a consult script is that KoLmafia will not be able to generate a combat macro to pass to KoL. As a result multi-round combat will take somewhat longer.

A consult script is called by using the "consult" command in your CCS, as follows:

[ default ]
consult myscript.ash

The main() function in the ASH script being consulted must accept three parameters:

void main(int round, monster mob, string page_text)

These values will be supplied by mafia when the consult script is called.

Example of a Consult Script

This example will attempt to maximize use of a Sauceror's spells as a Sauceror by making use of sauce splash effects when they can be used.

// Save this as SauceSplash.ash
boolean sauceSplash() {
   if(!my_class() == $class[Sauceror])
         return false;
   int normal = numeric_modifier("spell damage");
   if(normal >= 25)
      return true;
   int cold = numeric_modifier("cold spell damage");
   int hot = numeric_modifier("hot spell damage");

   #deal with monsters weak to cold
   if(((((monster_element() == $element[stench]) || (monster_element() == $element[sleaze]))
     && have_skill($skill[Immaculate Seasoning]))
     || have_equipped($item[Gazpacho's Glacial Grimoire]))
     && cold + normal >= 25)
        return true;
   #deal with monsters weak to hot
   else if((((((monster_element() == $element[cold]) || (monster_element() == $element[spooky]))
     && have_skill($skill[Immaculate Seasoning]))
     || have_equipped($item[Codex of Capsaicin Conjuration])
     || have_equipped($item[Ol' Scratch's manacles])
     || have_equipped($item[Ol' Scratch's ash can]))
     && hot + normal >= 25)
   #deal with monsters weak to neither (hot/non-aligned)
   else if(have_skill($skill[Immaculate Seasoning])
      && cold != hot && max(cold, hot) + normal >= 25)
         return true;
   else return false;

void main(int initround, monster foe, string page) {
   if(have_effect($effect[Burning Soul]) || have_effect($effect[Soul Freeze]) || !sauceSplash())
      use_skill($skill[Wave of Sauce]);

This consult script can then be integrated into a CCS like this:

[ default ]
consult SauceSplash.ash

Parts of a Combat Consultation Script

As you can see in the above example, a consultation script is called with three parameters.

  • The first parameter is the round of combat that the script is called. Sometimes it is important to keep track of the round. This is particularly important to keep from losing the fight by going over 30 rounds.
  • The second parameter is the monster that you are fighting. This is important because it enables you to take different actions for different monsters.
  • The third parameter is the text of the page. This is important because it enables you to examine every detail of the fight as it is taking place. It can be analyzed for potential actions, damage that you deal to a monster and all other events.

All possible actions you can take in a round of combat are listed under In-combat Consulting.

Resolution of a Combat Consultation Script

The consult script can automate as many, or as few rounds of combat as desired to achieve its goal. When it finishes executing, if the monster is not yet dead, then the CCS will continue combat from the current round. Note that the current round is not always the next line in a script. For instance, if the consult script is called at round 1 and executes three actions, then it will return to the CCS at round 4. This is why most CCSs containing consult script prefer to have only a line after the consult script, usually a simple method of killing a monster.

Note: unlike CCS themselves or macros, consult scripts will NOT automatically stop if the monster dies. The entire consult script is seen as a single "action" by the CCS, which will go through its entirety before deciding whether to keep fighting or to give the control back to whatever script/player action/automation was going on prior to the fight.
This means that a consult script such as...

void main(int initround, monster foe, string page){

...will GENERATE AN ERROR if the first saucegeyser defeats the monster, as mafia will try to look for a skill called "saucegeyser" to cast once out of combat.
However, this also means that if you are sure the combat will be over at a certain point, you could include actions like changing your equipment, eating, or straight up adventuring at another location!

Macros in Consult Scripts

It is possible for a consult script to submit a macro. As a simple example, if your consult script wants to submit a macro that simply attacks the monster until the combat ends...

string macro = "attack; repeat"
visit_url("fight.php?action=macro&macrotext=" + url_encode(macro) ,true,true);

Between macro commands you need to insert either \n or a semi-colon as in the above example. Your submitted macro can be as complicated as you wish.