python-kol / libkol

A Python package for interacting with The Kingdom of Loathing.

libkol

What is it?

The purpose of libkol is to create a Python package that makes it extremely easy to develop code that works with The Kingdom of Loathing. It can be used for anything from writing short scripts to complex bots.

It is based on pykol, on which both kBay and wadbot were built.

Who is it for?

libkol is for programmers who are interested in writing scripts and bots for KoL. If you do not feel comfortable writing code, then libkol is probably not for you.

Example

See examples/ for example uses of libkol.

Requirements

libkol requires Python 3.6+.

To install third-party libraries

$ make install

Running the Unit Tests

libkol includes a unittest suite, to showcase some of its functionality and to help ensure that new game changes don't break your existing code. Developers are strongly encouraged to add unit tests for new features that they create.

To run the test suite:

$ make test username=[username] password=[password]

How can I contribute?

1. Fork libkol
2. Clone your fork - git clone [e-mail]:your_username/libkol.git
3. Add a remote to this repository - git remote add upstream git://github.com/python-kol/libkol.git
4. Fetch the current libkol sources - git fetch upstream
5. Create a topic branch - git checkout -b my_branch upstream/master
6. Commit (or cherry-pick) your changes
7. Push your branch to github - git push origin my_branch
8. Create an Issue with a link to your branch
9. That's it!