Kolmafia - User contributions [en]

Browser JSON API

2024-10-26T15:06:08Z

Ikzann: add details

Any relay script that injects client-side JavaScript code into the relay browser can get access to Mafia data by making an HTTP request to the <code>/KoLmafia/jsonApi</code> endpoint. Requests should be x-www-urlencoded with <code>pwd=[hash]</code> and <code>body=[json object]</code>.

== Request API ==

The JSON request object has the type <code>{ properties?: string[], functions?: { name: string, args: unknown[] }[] }</code>. Names of functions are in JS style (camelCase).

The response will have type <code>{ error: string }</code> or <code>{ properties?: string[], functions?: unknown[] }</code>, with <code>properties</code> and <code>functions</code> each present if they were present on the request object. The ordering of each of <code>properties</code> and <code>functions</code> will correspond to the request ordering.

Enumerated types (Item, Familiar, Modifier, etc.) can be passed in with either of the following placeholder formats: <code>{ objectType: EnumeratedTypeName, identifierString: string } | { objectType: EnumeratedTypeName, identifierNumber: number }</code>. If both <code>identifierString</code> and <code>identifierNumber</code> are present, <code>identifierNumber</code> will be prioritized. Enumerated types will be returned as a POJO with all the fields of a JS enumerated type, with field names in camelCase, except any second-level referenced objects will be left as placeholders. Objects will also have the placeholder fields (<code>objectType</code>, <code>identifierString</code>, <code>identifierNumber</code> if applicable) set.

Details for an enumerated type instance can be requested with the special <code>identity</code> function, which can take placeholder arguments and return the full object.

== Example ==

Example request body:

<pre>
{
"properties": ["kingLiberated"],
"functions": [{ "name": "availableAmount", "args": [{
"objectType": "Item",
"identifierString": "seal-clubbing club"
}] }]
}
</pre>

Example response:

<pre>
{
"properties": [true],
"functions": [0]
}
</pre>

== TypeScript code ==

The following browser TypeScript code will allow easy submission of API calls. Or you can use the more full-featured <code>tome-kolmafia</code> library to handle this all for you.

<pre>
type ApiRequest = {
properties?: readonly string[];
functions?: readonly { name: string; args: unknown[] }[];
};

type ApiResponse = {
properties?: string[];
functions?: unknown[];
};

export async function apiCall(
request: ApiRequest,
pwd: string,
): Promise<ApiResponse> {
const response = await fetch("/KoLmafia/jsonApi", {
method: "post",
body: new URLSearchParams({
body: JSON.stringify(request),
pwd,
}),
headers: {
// Mafia only accepts this format.
"Content-Type": "application/x-www-form-urlencoded",
},
});
const json = await response.json();
if ("error" in json) {
throw new Error(json.error);
}
return json;
}
</pre>

Browser JSON API

2024-10-26T14:58:46Z

Ikzann: create browser json page

Main Page

2024-10-26T14:50:21Z

Ikzann: add browser JSON API page

<center>
<div align="center" style="margin: 0 0 20px 0; text-align: center; border: none;">
<span style="font-size: 1.4em;">Welcome to the KoLmafia Wiki!</span><br />
<span style="font-size: 1em; line-height: 1.6em;">Progress level: [[Special:Statistics|{{NUMBEROFARTICLES}}]]</span>
</div>

<div style="width: 50%; float: left;">

<table style="width: 90%; border: 2px solid black; margin: 5px 5px 15px 5px;" cellpadding="0" cellspacing="0">
<tr><td colspan=2 style="background-color: #ffac62; padding: 4px; border-bottom: 1px solid black">Quick Links for ASH Scripters</td></tr>
<tr>
<td style="background-color: #ffc48e; padding: 4px; vertical-align: top;">
<span style="line-height: 0.875em; font-size: 0.875em; font-weight: bold; padding: 0; margin: 0 0 0 0.4em;">FUNCTION CATEGORIES</span><br />
* [[Your Character]]
* [[Item Management]]
* [[Equipment]]
* [[Skills and Effects]]
* [[Adventuring]]
* [[In-combat Consulting]]
* [[Math and Numbers]]
* [[String Handling Routines]]
* [[Datatype Conversions]]
* [[Modifier Functions]]
* [[Relay Browser Functions]]
* [[Miscellaneous Functions|Miscellaneous]]
</td>
<td style="background-color: #ffc48e; padding: 4px; vertical-align: top;">
<p><span style="line-height: 0.875em; font-size: 0.875em; font-weight: bold; padding: 0; margin: 0 0 0 0.4em;">LANGUAGE CONVENTIONS</span>
* [[Operators]]
* [[Data Types]]
* [[Control Structures]]
* [[Data Structures]]
* [[Proxy Records]]
* [[Miscellaneous ASH Features|Misc. ASH Features]]</p>
<p style="margin-top: 2em;"><span style="line-height: 0.875em; font-size: 0.875em; font-weight: bold; padding: 0; margin: 0 0 0 0.4em;">HELPFUL RESOURCES</span>
* [[ASH For Beginners]]
* [[KoLmafia Properties]]
* [[Ash Functions|Master Function List]]
* [[CLI Reference|CLI Commands]]
* [[Helpful Scripts]]
* [[JavaScript Support]]
* [[Browser JSON API]]
</p>
</td>
</tr>
</table>

<table style="width: 90%; border: 2px solid black; margin: 5px 5px 15px 5px;" cellpadding="0" cellspacing="0">
<tr><td style="background-color: #b0ddb0; padding: 4px; border-bottom: 1px solid black">How Does KoLmafia Help?</td></tr>
<tr>
<td style="background-color: #c0ffc0; padding: 4px;">
* [[Automation]]
* [[Quests|Helping with Quests]]
* [[Basement|Basement Diving]]
</td>
</tr>
</table>

</div>

</center>
<div style="width: 50%; float: right;">

<table style="width: 90%; border: 2px solid black; margin: 5px 5px 15px 5px;" cellpadding="0" cellspacing="0">
<tr><td style="background-color: #aeaeee; padding: 4px; border-bottom: 1px solid black">New User Help</td></tr>
<tr>
<td style="background-color: #bfbfff; padding: 4px;">
* [[Installation]]
{{
Hidelist
|title=[[KoLmafia Guide]] by SinginSally
|1=[[KoLmafia Guide: Preface|Preface]]
|2=[[KoLmafia Guide: Basics (Relay Browser)|Lesson 1: Basics (Relay Browser)]]
|3=[[KoLmafia Guide: Java Interface|Lesson 2: Java Interface]]
|4=[[KoLmafia Guide: Stats-Checking|Lesson 3: Stats-Checking]]
|5=[[KoLmafia Guide: Attack Script|Lesson 4: Attack Script]]
|6=[[KoLmafia Guide: Custom Combat Script|Lesson 5: Custom Combat Script]]
|7=[[KoLmafia Guide: Auto-Adventuring|Lesson 6: Auto-Adventuring]]
|8=[[KoLmafia Guide: Automatic HP/MP Recovery|Lesson 7: Automatic HP/MP Recovery]]
|9=[[KoLmafia Guide: Goal-Oriented Adventuring|Lesson 8: Goal-Oriented Adventuring]]
|10=[[KoLmafia Guide: Setting Preferences|Lesson 9: Setting Preferences]]
|11=[[KoLmafia Guide: Setting Up Breakfast|Lesson 10: Setting Up Breakfast]]
|12=[[KoLmafia Guide: Eating & Drinking|Lesson 11: Eating & Drinking]]
|13=[[KoLmafia Guide: PvP (Beating Up People)|Lesson 12: PvP (Beating Up People)]]
|14=[[KoLmafia Guide: Running ASH Scripts|Lesson 13: Running ASH Scripts]]
|15=[[KoLmafia Guide: Useful Commands|Lesson 14: Useful Commands]]
|16=[[KoLmafia Guide: Closing Thoughts|Lesson 15: Closing Thoughts]]
}}
* [[SVN Primer]]
* [[Helpful Links]]
* [[Help:Frequently Asked Questions|KoLmafia FAQ]]
</td>
</tr>
</table>

<table style="width: 90%; border: 2px solid black; margin: 5px 5px 15px 5px;" cellpadding="0" cellspacing="0">
<tr><td style="background-color: #aeaeee; padding: 4px; border-bottom: 1px solid black">Advanced Features</td></tr>
<tr>
<td style="background-color: #bfbfff; padding: 4px;">
* [[Modifier Maximizer]]
* [[Daily Deeds]]
* [[Hidden Features]]
</td>
</tr>
</table>

<table style="width: 90%; border: 2px solid black; margin: 5px 5px 15px 5px;" cellpadding="0" cellspacing="0">
<tr><td style="background-color: #aeaeee; padding: 4px; border-bottom: 1px solid black">Contributing to the KoLmafia Project</td></tr>
<tr>
<td style="background-color: #bfbfff; padding: 4px;">
* [[Compiling from Source]]
* [[Development Environment Setup]]
* [[Mafia's Code]]
* [[Making a Patch]]
* [[Reporting a Bug/Requesting a Feature]]
* [[Help:Editing|Editing the Wiki Documentation]]
* [[Help:To Do List|Wiki "To Do" List]]
</td>
</tr>
</table>

</div>

Write ccs

2023-01-09T00:07:29Z

Ikzann: create

{{
#vardefine:name|write_ccs}}{{
#vardefine:return_type|boolean}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|buffer|text}}|
parameter2={{Param|string|name}}|
}}|

function_description=Writes the text of a given custom combat script to the given value. Returns success.|

needscode=yes|

see_also={{SeeAlso|set_ccs|read_ccs}}|
}}

[[Category:Adventuring]][[Category:Misc.]]

Read ccs

2023-01-09T00:06:42Z

Ikzann: Created page with "{{ #vardefine:name|read_ccs}}{{ #vardefine:return_type|buffer}}{{ FunctionPage| name={{#var:name}}| function1={{Function| name={{#var:name}}| aggregate={{#var:aggregate}}| r..."

{{
#vardefine:name|read_ccs}}{{
#vardefine:return_type|buffer}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|name}}|
}}|

function_description=Reads the text of a given custom combat script and returns a buffer with the result.|

needscode=yes|

see_also={{SeeAlso|set_ccs|write_ccs}}|
}}

[[Category:Adventuring]][[Category:Misc.]]

Set ccs

2023-01-09T00:06:04Z

Ikzann: param name

{{
#vardefine:name|set_ccs}}{{
#vardefine:return_type|boolean}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|name}}|
}}|

function_description=Sets your custom combat script. Returns success. Note that you will need to set the battleAction preference to "custom combat script" as well and possibly disable autoattack for custom combat scripts to be useful.|

needscode=yes|

see_also={{SeeAlso|read_ccs|write_ccs}}|
}}

[[Category:Adventuring]][[Category:Misc.]]

Set ccs

2023-01-09T00:05:31Z

Ikzann: create

{{
#vardefine:name|set_ccs}}{{
#vardefine:return_type|boolean}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|image}}|
}}|

function_description=Sets your custom combat script. Returns success. Note that you will need to set the battleAction preference to "custom combat script" as well and possibly disable autoattack for custom combat scripts to be useful.|

needscode=yes|

see_also={{SeeAlso|read_ccs|write_ccs}}|
}}

[[Category:Adventuring]][[Category:Misc.]]

Adventuring

2023-01-09T00:02:47Z

Ikzann: /* Misc. */

{{TOCright}}
==General Adventuring==
{{Flink|boolean| adventure|int|location|desc=Visits the desired location the the desired number of times.}}
{{Flink|boolean| adventure|int|location|string|desc=Visits the desired location a specified number of times, using a combat filter function defined elsewhere in your script.}}
{{Flink|boolean| adv1|location|int|string|desc=Adventure exactly once in the specified location (even if it uses no turns). Chained choice adventures '''are''' followed. Int overrides default settings, and string is a filter, same as in [[adventure|adventure()]]}}
{{FunctionEmbed|visit_url|format=signature|desc=yes}}
{{Flink|string|get_counters|string|int|int|desc=Determine if a counter will expire in a specified
period of time.}}
{{Flink|void|council|desc=Visits the Council of Loathing.}}
{{Flink|item|guardians|desc=Climbs the Naughty Sorceress' Tower and passes the challenges it can, returning the first item needed to pass a failed stage.}}
{{Flink|int|tavern|desc=Attempt to complete the tavern, and returns the number of squares visited}}
{{Flink|boolean|entryway}}
{{Flink|boolean|hedgemaze}}
{{Flink|boolean|chamber|desc=These three functions attempt to perform the associated tasks. The return value indicates the success.}}
{{Flink|location|my_location|desc=Returns the location where you last adventured.}}
{{Flink|void|set_location|location|desc=Changes the value returned by my_location().}}
{{Flink|void|refresh_status|desc=Refreshes the side-pane character info (health, effects, etc.).}}
{{Flink|buffer|run_combat|desc=Uses the current KoLmafia settings to run a combat (for use with [[visit_url|visit_url()]]).}}
{{Flink|buffer|run_choice|desc=Chooses an option in the current choice adventure.}}
{{Flink|buffer|run_turn|desc=Works as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.}}
{{Flink|boolean|change_mcd|int|desc=Tries to set your +ML device to a specified setting and reports on success.}}
{{Flink|boolean|hermit|int|item|desc=Trades worthless items (adventuring in the sewer if needed) to the hermit for specified items.}}
==Goals and Conditions==
{{FunctionEmbed|add_item_condition|format=signature|desc=yes}}
{{Flink|string [int]|get_goals|desc=Lists all current goals.}}
{{Flink|boolean| is_goal|item|desc=Checks if a given item is a goal.}}
{{Flink|boolean|goal_exists|string|desc=Checks if there is currently a given type of goal.}}
{{Flink|void| remove_item_condition|int|item|desc=Removes adventuring conditions.}}
==About Monsters==
For all of the below functions that accept an optional monster parameter, the default value is your most recently-encountered monster (that means your current monster if you're in combat).

{{flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}
{{flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}|desc=Returns the chance of successfully getting the jump against the monster or in the location.}}
{{Flink|monster|last_monster|desc=Returns last monster encountered.}}
{{Flink|monster [int]|get_monsters|location|desc=Returns a map of potential monsters at a given location.}}
{{Flink|float [monster]|appearance_rates|location|{{opt|boolean}}|desc=Returns a map of the expected frequency of each monster at the specified location.}}
{{Flink|int|monster_attack|{{opt|monster}}|desc=Returns the starting/current attack value of the specified monster.}}
{{Flink|int|monster_defense|{{opt|monster}}|desc=Returns the starting/current defense value of the specified monster.}}
{{Flink|int|monster_hp|{{opt|monster}}|desc=Returns the starting/current HP of the specified monster.}}
{{Flink|int|monster_initiative|{{opt|monster}}|desc=Returns the starting/current initiative of the specified monster.}}
{{Flink|phylum|monster_phylum|{{opt|monster}}|desc=Returns the phylum of the specified monster.}}
{{Flink|int|expected_damage|{{opt|monster}}|desc=Returns the amount of damage you are expected to take each round from the specified monster.}}
{{Flink|element|monster_element|{{opt|monster}}|desc=Returns the elemental alignment of the specified monster.}}
{{Flink|monster|image_to_monster|string|desc=Looks up monster by image name.}}
{{Flink|boolean|is_banished|monster|desc=Returns true if the specified monster is banished}}

==Choice Adventures==
{{FunctionEmbed|available_choice_options|format=signature|desc=yes}}
{{flink|boolean|choice_follows_fight|desc=Returns <code>true</code> if the last finished combat is about to lead into a choice adventure.}}
{{flink|boolean|handling_choice|desc=Returns <code>true</code> if you are currently in a choice.}}
{{flink|int|last_choice|desc=Returns the ID of the current (or last) choice adventure you encountered.}}
{{FunctionEmbed|run_choice|format=signature|desc=yes}}

==Misc.==
{{Flink|int|get_auto_attack|desc=Returns your current auto-attack setting.}}
{{Flink|void|set_auto_attack|int|desc=Sets your auto-attack setting.}}
{{Flink|boolean|set_ccs|string|desc=Sets your custom combat script.}}
{{Flink|buffer|read_ccs|string|desc=Reads the text of your custom combat script.}}
{{Flink|boolean|write_ccs|buffer|string|desc=Writes the text of your custom combat script.}}
[[Category:Scripting]]

JavaScript Support

2020-12-12T03:49:02Z

Ikzann: Added more docs

As of revision 20509, KoLmafia supports scripting in JavaScript! You can run JS code from the CLI using <code>js <nowiki><code></nowiki></code>, and you can call scripts through any of the normal methods. Consult and "lifecycle" scripts (e.g. <code>betweenBattleScript</code>) are supported as well as of revision 20519. '''This support is still experimental - you have been warned.'''

== Basics ==
* All the methods in the ASH runtime library are available, with names of methods converted to camelCase. So, for example, <code>print_html</code> in ASH becomes <code>printHtml</code> in JS.
* In scripts called from a file, you can access the runtime library by calling <code>require("kolmafia")</code>, so <code>const { printHtml } = require("kolmafia")</code>. If running from the command line via <code>js</code>, the runtime library functions are all available in the global scope (so you can do <code>js print("Hello world!");</code>).
* ASH maps are converted to plain JS objects, and ASH arrays are converted to JS arrays.
* You can look at the type reference for the JS version of the ASH runtime library with <code>jsref</code>, which works just like <code>ashref</code>.
* Objects like monsters and items can be constructed via the <code>Monster</code> and <code>Item</code> global objects, along with the rest of ASH's enumerated types (stat, phylum, location, etc.). <code>Monster.get</code> takes a number or a string, just like <code>$monster</code> in ASH, or an array of numbers and strings to construct an array of monsters. <code>Monster.all</code> works like <code>$monsters[]</code> in ASH; it takes no arguments and returns an array of all monsters.
* Mafia supports <code>require</code> for both ASH and JS scripts. For ASH scripts, it will execute top-level code but only export functions, not variables, in the top scope.
* If you want Mafia to run your <code>main</code> function, you '''<u>must</u>''' export it by adding it to module.exports, just as you would for a Node module. For the uninitiated, this just means adding <code>module.exports.main = main</code> to the end of your script. You will want to do the same with any function or value you want to be available to other scripts via require.

== Bundlers ==
Folks with experience doing JS web development are likely used to using a suite of tools such as Babel, Webpack, and potentially Typescript to write more modern code that transpiles down to a dialect of JS that is supported by browsers or an engine. That approach works well with Rhino. As of r20558, you will still need to apply several patches to Babel in order to get babel-preset-env to work. See [https://github.com/phulin/bean-casual/tree/ts] for an example of a working Babel/Webpack/Typescript configuration; you'll need the configuration files and also the patches, which can be applied with patch-package.

JavaScript Support

2020-12-12T03:42:41Z

Ikzann:

As of revision 20509, KoLmafia supports scripting in JavaScript! You can run JS code from the CLI using <code>js <nowiki><code></nowiki></code>, and you can call scripts through any of the normal methods. Consult and "lifecycle" scripts (e.g. <code>betweenBattleScript</code>) are supported as well as of revision 20519. '''This support is still experimental - you have been warned.'''

* All the methods in the ASH runtime library are available, with names of methods converted to camelCase. So, for example, <code>print_html</code> in ASH becomes <code>printHtml</code> in JS.
* In scripts called from a file, you can access the runtime library by calling <code>require("kolmafia")</code>, so <code>const { printHtml } = require("kolmafia")</code>. If running from the command line via <code>js</code>, the runtime library functions are all available in the global scope (so you can do <code>js print("Hello world!");</code>).
* ASH maps are converted to plain JS objects, and ASH arrays are converted to JS arrays.
* You can look at the type reference for the JS version of the ASH runtime library with <code>jsref</code>, which works just like <code>ashref</code>.
* Objects like monsters and items can be constructed via the <code>Monster</code> and <code>Item</code> global objects, along with the rest of ASH's enumerated types (stat, phylum, location, etc.). <code>Monster.get</code> takes a number or a string, just like <code>$monster</code> in ASH, or an array of numbers and strings to construct an array of monsters. <code>Monster.all</code> works like <code>$monsters[]</code> in ASH; it takes no arguments and returns an array of all monsters.
* Mafia supports <code>require</code> for both ASH and JS scripts. For ASH scripts, it will execute top-level code but only export functions, not variables, in the top scope.
* If you want Mafia to run your <code>main</code> function, you '''<u>must</u>''' export it by adding it to module.exports, just as you would for a Node module. For the uninitiated, this just means adding <code>module.exports.main = main</code> to the end of your script. You will want to do the same with any function or value you want to be available to other scripts via require.

JavaScript Support

2020-11-27T15:19:04Z

Ikzann:

As of revision 20509, KoLmafia supports scripting in JavaScript! You can run JS code from the CLI using <code>js <nowiki><code></nowiki></code>, and you can call scripts through any of the normal methods. Consult and "lifecycle" scripts (e.g. <code>betweenBattleScript</code>) are supported as well as of revision 20519. '''This support is still experimental - you have been warned.'''

* All the methods in the ASH runtime library are available, with names of methods converted to camelCase. So, for example, <code>print_html</code> in ASH becomes <code>Lib.printHtml</code> in JS. In scripts called from a file, you can access the runtime library by calling <code>require("kolmafia")</code>. If running from the command line via <code>js</code>, the runtime library functions are all available in the global scope (so you can do <code>js print("hello world");</code>).
* ASH maps are converted to plain JS objects, and ASH arrays are converted to JS arrays.
* You can look at the type reference for the JS version of the ASH runtime library with <code>jsref</code>, which works just like <code>ashref</code>.
* Objects like monsters and items can be constructed via the <code>Monster</code> and <code>Item</code> global objects, along with the rest of ASH's enumerated types (stat, phylum, location, etc.). <code>Monster.get</code> takes a number or a string, just like <code>$monster</code> in ASH, or an array of numbers and strings to construct an array of monsters. <code>Monster.all</code> works like <code>$monsters[]</code> in ASH; it takes no arguments and returns an array of all monsters.
* Mafia supports <code>require</code> for both ASH and JS scripts. For ASH scripts, it will execute top-level code but only export functions, not variables, in the top scope.
* If you want Mafia to run your <code>main</code> function, you '''<u>must</u>''' export it by adding it to module.exports, just as you would for a Node module. For the uninitiated, this just means adding <code>module.exports.main = main</code> to the end of your script. You will want to do the same with any function or value you want to be available to other scripts via require.

JavaScript Support

2020-11-27T15:15:14Z

Ikzann:

JavaScript Support

2020-11-24T21:21:25Z

Ikzann:

JavaScript Support

2020-11-23T19:40:15Z

Ikzann: add revision

JavaScript Support

2020-11-22T15:20:29Z

Ikzann: Initial write. Some of this is premature.

JavaScript Support

2020-11-22T15:07:09Z

Ikzann: Page creation

As of revision 20509, KoLmafia supports scripting in JavaScript!

Main Page

2020-11-22T15:05:57Z

Ikzann: Added link for JS support in prep for writing docs

<center>
<div align="center" style="margin: 0 0 20px 0; text-align: center; border: none;">
<span style="font-size: 1.4em;">Welcome to the KoLmafia Wiki!</span><br />
<span style="font-size: 1em; line-height: 1.6em;">Progress level: [[Special:Statistics|{{NUMBEROFARTICLES}}]]</span>
</div>

<div style="width: 50%; float: left;">

<table style="width: 90%; border: 2px solid black; margin: 5px 5px 15px 5px;" cellpadding="0" cellspacing="0">
<tr><td colspan=2 style="background-color: #ffac62; padding: 4px; border-bottom: 1px solid black">Quick Links for ASH Scripters</td></tr>
<tr>
<td style="background-color: #ffc48e; padding: 4px; vertical-align: top;">
<span style="line-height: 0.875em; font-size: 0.875em; font-weight: bold; padding: 0; margin: 0 0 0 0.4em;">FUNCTION CATEGORIES</span><br />
* [[Your Character]]
* [[Item Management]]
* [[Equipment]]
* [[Skills and Effects]]
* [[Adventuring]]
* [[In-combat Consulting]]
* [[Math and Numbers]]
* [[String Handling Routines]]
* [[Money Making Game]]
* [[Datatype Conversions]]
* [[Modifier Functions]]
* [[Relay Browser Functions]]
* [[Miscellaneous Functions|Miscellaneous]]
</td>
<td style="background-color: #ffc48e; padding: 4px; vertical-align: top;">
<p><span style="line-height: 0.875em; font-size: 0.875em; font-weight: bold; padding: 0; margin: 0 0 0 0.4em;">LANGUAGE CONVENTIONS</span><br />
* [[Operators]]
* [[Data Types]]
* [[Control Structures]]
* [[Data Structures]]
* [[Proxy Records]]
* [[Miscellaneous ASH Features|Misc. ASH Features]]</p>
<p style="margin-top: 2em;"><span style="line-height: 0.875em; font-size: 0.875em; font-weight: bold; padding: 0; margin: 0 0 0 0.4em;">HELPFUL RESOURCES</span><br />
* [[ASH For Beginners]]
* [[KoLmafia Properties]]
* [[Ash Functions|Master Function List]]
* [[CLI Reference|CLI Commands]]
* [[Helpful Scripts]]
* [[JavaScript Support]]
</p>
</td>
</tr>
</table>

<table style="width: 90%; border: 2px solid black; margin: 5px 5px 15px 5px;" cellpadding="0" cellspacing="0">
<tr><td style="background-color: #b0ddb0; padding: 4px; border-bottom: 1px solid black">How Does KoLmafia Help?</td></tr>
<tr>
<td style="background-color: #c0ffc0; padding: 4px;">
* [[Automation]]
* [[Quests|Helping with Quests]]
* [[Basement|Basement Diving]]
</td>
</tr>
</table>

</div>

</center>
<div style="width: 50%; float: right;">

<table style="width: 90%; border: 2px solid black; margin: 5px 5px 15px 5px;" cellpadding="0" cellspacing="0">
<tr><td style="background-color: #aeaeee; padding: 4px; border-bottom: 1px solid black">New User Help</td></tr>
<tr>
<td style="background-color: #bfbfff; padding: 4px;">
* [[Installation]]
{{
Hidelist
|title=[[KoLmafia Guide]] by SinginSally
|1=[[KoLmafia Guide: Preface|Preface]]
|2=[[KoLmafia Guide: Basics (Relay Browser)|Lesson 1: Basics (Relay Browser)]]
|3=[[KoLmafia Guide: Java Interface|Lesson 2: Java Interface]]
|4=[[KoLmafia Guide: Stats-Checking|Lesson 3: Stats-Checking]]
|5=[[KoLmafia Guide: Attack Script|Lesson 4: Attack Script]]
|6=[[KoLmafia Guide: Custom Combat Script|Lesson 5: Custom Combat Script]]
|7=[[KoLmafia Guide: Auto-Adventuring|Lesson 6: Auto-Adventuring]]
|8=[[KoLmafia Guide: Automatic HP/MP Recovery|Lesson 7: Automatic HP/MP Recovery]]
|9=[[KoLmafia Guide: Goal-Oriented Adventuring|Lesson 8: Goal-Oriented Adventuring]]
|10=[[KoLmafia Guide: Setting Preferences|Lesson 9: Setting Preferences]]
|11=[[KoLmafia Guide: Setting Up Breakfast|Lesson 10: Setting Up Breakfast]]
|12=[[KoLmafia Guide: Eating & Drinking|Lesson 11: Eating & Drinking]]
|13=[[KoLmafia Guide: PvP (Beating Up People)|Lesson 12: PvP (Beating Up People)]]
|14=[[KoLmafia Guide: Running ASH Scripts|Lesson 13: Running ASH Scripts]]
|15=[[KoLmafia Guide: Useful Commands|Lesson 14: Useful Commands]]
|16=[[KoLmafia Guide: Closing Thoughts|Lesson 15: Closing Thoughts]]
}}
* [[SVN Primer]]
* [[Helpful Links]]
* [[Help:Frequently Asked Questions|KoLmafia FAQ]]
</td>
</tr>
</table>

<table style="width: 90%; border: 2px solid black; margin: 5px 5px 15px 5px;" cellpadding="0" cellspacing="0">
<tr><td style="background-color: #aeaeee; padding: 4px; border-bottom: 1px solid black">Advanced Features</td></tr>
<tr>
<td style="background-color: #bfbfff; padding: 4px;">
* [[Modifier Maximizer]]
* [[Daily Deeds]]
* [[Hidden Features]]
</td>
</tr>
</table>

<table style="width: 90%; border: 2px solid black; margin: 5px 5px 15px 5px;" cellpadding="0" cellspacing="0">
<tr><td style="background-color: #aeaeee; padding: 4px; border-bottom: 1px solid black">Contributing to the KoLmafia Project</td></tr>
<tr>
<td style="background-color: #bfbfff; padding: 4px;">
* [[Compiling from Source]]
* [[Development Environment Setup]]
* [[Mafia's Code]]
* [[Making a Patch]]
* [[Reporting a Bug/Requesting a Feature]]
* [[Help:Editing|Editing the Wiki Documentation]]
* [[Help:To Do List|Wiki "To Do" List]]
</td>
</tr>
</table>

</div>

VS Code Setup

2020-11-19T01:29:00Z

Ikzann: fix formatting

This guide assumes that you have a recent enough version of the Java JDK, ANT, and VS Code. Completing [[Compiling from Source]] is a requirement for this guide, although experienced developers can skip to whatever step is appropriate.

=== Build and Config Project Setup ===
# Open the KoLmafia directory in VS Code.
# Install the Java Extension Pack, Language Support for Java, Project Manager for Java, and Debugger for Java VS Code extensions.
# Install the following files in .vscode:

===== launch.json: =====
{
"version": "0.2.0",
"configurations": [
{
"type": "java",
"name": "Debug (Launch)-KoLmafia<kolmafia>",
"request": "launch",
"mainClass": "net.sourceforge.kolmafia.KoLmafia",
"projectName": "kolmafia",
"args": "--CLI"
}
]
}

===== settings.json: =====
{
"files.exclude": {
"**/.classpath": true,
"**/.factorypath": true,
"**/.project": true,
"**/.settings": true,
"**/*.class": true
},
"java.project.referencedLibraries": [
"lib/**/*.jar",
"src/**/*.jar"
]
}
Test by pressing F5 to run KoLmafia.
====== Optional Steps ======
* For easier coding, download the [[:File:KoLMafia Style.xml|KoLMafia Style Definitions]] and figure out how to install them in VS Code.

VS Code Setup

2020-11-19T01:27:34Z

Ikzann: Created page with "This guide assumes that you have a recent enough version of the Java JDK, ANT, and VS Code. Completing Compiling from Source is a requirement for this guide, although exp..."

This guide assumes that you have a recent enough version of the Java JDK, ANT, and VS Code. Completing [[Compiling from Source]] is a requirement for this guide, although experienced developers can skip to whatever step is appropriate.

=== Build and Config Project Setup ===
# Open the KoLmafia directory in VS Code.
# Install the Java Extension Pack, Language Support for Java, Project Manager for Java, and Debugger for Java VS Code extensions.
# Install the following files in .vscode:

launch.json:
<nowiki>
{
"version": "0.2.0",
"configurations": [
{
"type": "java",
"name": "Debug (Launch)-KoLmafia<kolmafia>",
"request": "launch",
"mainClass": "net.sourceforge.kolmafia.KoLmafia",
"projectName": "kolmafia",
"args": "--CLI"
}
]
}
</nowiki>

settings.json:
<nowiki>
{
"files.exclude": {
"**/.classpath": true,
"**/.factorypath": true,
"**/.project": true,
"**/.settings": true,
"**/*.class": true
},
"java.project.referencedLibraries": [
"lib/**/*.jar",
"src/**/*.jar"
]
}
</nowiki>

Test by pressing F5 to run KoLmafia.
====== Optional Steps ======
* For easier coding, download the [[:File:KoLMafia Style.xml|KoLMafia Style Definitions]] and figure out how to install them in VS Code.

Development Environment Setup

2020-11-19T01:17:29Z

Ikzann:

After succeeding at [[Compiling from Source]] for your platform, you can add set up your KoLMafia source in an Integrated Development Environment (IDE) of your choice. It is entirely possible to build and change KoLMafia without and IDE and some of the developers do just that.
====Platform-specific Development Tools====
; Apple's OS X notes on development for Java, including the XCode Tools setup, can make command line work easier.
::[https://developer.apple.com/library/archive/documentation/Java/Conceptual/Java14Development/02-JavaDevTools/JavaDevTools.html Apple Developer Tools for Java]
====Developer Text Editors====
Choose your favorite, or add your favorite.
; [http://www.barebones.com BBEdit]
:: Mac OS X based text editor
; [https://macromates.com TextMate]
:: Another Mac based editor
; [https://www.ultraedit.com Ultra Edit]
:: cross-platform text editor

====IDEs====
This list will be out of date shortly after it's written, but can be updated as newer tools and versions are released.
; [https://www.jetbrains.com/idea/download/ IntelliJ IDEA]
:: [[IntelliJ Setup]]
; [http://www.eclipse.org Eclipse]
:: [[eclipse Setup]]
; [https://code.visualstudio.com/ VS Code]
:: [[VS Code Setup]]
; [https://www.jetbrains.com/idea/download/ NetBeans]
:: [[NetBeans Setup]]
; [http://developer.apple.com/tools/xcode/) Xcode] (Mac only)
:: [[XCode Setup]]

====Source Control Management tools====
; [http://path/to/something/ TortoiseSVN]
:: [[Tortoise Setup]]