Introduction

KoLmafia is a cross-platform desktop tool, written in Java (J2SE 1.4 compliant), which interfaces with the online adventure game, Kingdom of Loathing. Those who are looking to download the latest release: click here. More advanced users familiar with stand-alone Java applications are welcome to download an hourly build provided by the KoLmafia user script community: click here.

Is KoLmafia Safe?

To make things absolutely clear, open sourcing a program does not make it secure -- it strictly makes it easier to take advantage of work already done by other people, provided you are willing to act in accordance with the terms of the license under which the source code is provided. That said, I believe KoLmafia is safe. However, I'm the main developer of KoLmafia, and I only use a small fraction of its features, so my opinion of it should be taken with a grain of salt.

My personal belief is that running any program (including the web browser you are using to view this page) is about near-unconditional trust. If, for any reason, you don't trust the companies and individuals involved in the development of the program, I strongly suggest that you should never run the program, no matter what the promised benefits may be. I believe these same guidelines should be applied if you're thinking about using KoLmafia.

Getting Started

In order to use KoLmafia, you must have a Java Runtime Environment (JRE) installed for your system. If you are running Windows 2000/XP, Linux, or Solaris, the latest version of the JRE is available here: Java SE Downloads. Please be sure to install the JRE after downloading it!

If you are running Mac OS X 10.4.x or higher, you do not need to download or install a separate JRE. If you are running Mac OS X 10.3.9, then you will need to upgrade your Java to 1.4 by going here: Java Update for Mac OS X v10.3. If you are running Mac OS X 10.2.6, then you will need to upgrade your Java to 1.4 by going here: Java Update for Mac OS X v10.2.6. If you are running an older version of Mac OS, unfortunately, KoLmafia will likely not run on your system.

If you are using any operating system not listed here, you are welcome to try your favorite search engine for details. The applicable keywords are "Java 1.4" and the name of your operating system, though you may have more luck searching for "Java 1.6" (which is more generally known as Java 6).

Other helpful information related to getting started with KoLmafia is found (or will eventually be found) in the end-user manual and in the KoLmafia Guide on the KoLmafia user scripting wiki.

Mission and Scope

What problem does this project address?

Kingdom of Loathing is an online adventure game written in PHP. As players advance in level in this game, the tendency is for them to settle into routines where they repeat the same set of tasks over and over again, tasks which involve nothing more than senseless link-clicking. As these routines continue, players begin to grow bored and dissatisfied, causing them to depart from the game without having experienced the subtler details which make the game enjoyable.

What is the goal of this project?

The goal of this project is to create a cross-platform desktop tool, written in Java (J2SE 1.4 compliant), which interfaces with the online adventure game, Kingdom of Loathing. The project intends to provide all the user-friendliness of the KoLmelion graphical user interface while giving KoL CLI and other command-line users the scripting flexibility to which they have grown accustomed.

What is the scope of this project?

The project intends to eventually achieve all the goals listed above before the project closes.

Documentation