summaryrefslogtreecommitdiff
path: root/README.md
blob: 6a25cb2bc7e41c64b57bc4494571e8c1497d1a5c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# dwproxy

This is a client-agnostic proxy for the Discworld MUD, which adds new
commands:

- `speedwalk [from <location>] to <location>` or `sw <destination>`:
  find routes, walk if there's only one
- `<number>`: select a speedwalk route option
- `shop <item>`: search shops by items they sell

It uses the database from [Quow's Cow Bar and
Minimap](http://quow.co.uk/minimap.php), which should be available,
and the path to which should be provided as the first argument on
invocation, e.g.: `dwproxy _quowmap_database.db`.

The default port is 2000, `telnet localhost 2000` to connect.

Can be built with either cabal (`cabal install`) or plain GHC on
Debian 11 to 12, after installing the compiler and dependencies from
system repositories (`ghc libghc-fgl-dev
libghc-unordered-containers-dev libghc-network-dev libghc-async-dev
libghc-attoparsec-dev libghc-aeson-dev libghc-hdbc-sqlite3-dev`).


## Python version

There's a Python version, dwproxy.py. It runs on Python 3, and doesn't
have dependencies outside of the Python standard library.