PyMUD is a fork of Mark Frimston's MUD Pi (see the project's Github page). This project is not really intending to produce a fully-fledged general purpose MUD, but is more of a learning exercise to help a group of friends who have limited experience with programming to collaborate together on a larger piece of work. To that end, if you would like to contribute this project please bear in mind:
- We will be working slow.
- Not everything will be perfect or sophisticated.
- We would like to avoid one person doing too much work so that there are enough tasks for everyone to have a chance to contribute.
You will need to install Python (3.6+) where you wish to run the server. Installers for Windows and Mac can be found at http://www.python.org/download/. There are also tarballs for Linux, although the best way to install on Linux would be via the package manager.
To allow players to connect remotely, the server will also need to be connected to the internet.
To connect to the server you will need a telnet client. On Mac, Linux, and versions of Windows prior to Windows Vista, the telnet client is usually installed by default. For Windows Vista, 7, 8 or later, you may need to follow this guide to install it.
Double click on simplemud.py - the file will be opened with the Python
interpreter. To stop the server, simply close the terminal window.
From the terminal, change to the directory containing the script and run
python simplemud.py
Note, if you are connected to the machine via SSH, you will find that the
script stops running when you quit the SSH session. A simple way to leave the
script running is to use a tool called screen. Connect via SSH as usual then
run screen. You will enter what looks like a normal shell prompt, but now you
can start the python script running and hit ctl+a followed by d to leave
screen running in the background. The next time you connect, you can
re-attach to your screen session using screen -r. Alternatively you could
create a daemon script
to run the script in the background every time the server starts.
If the server is running behind a NAT such as a home router, you will need to set up port 1234 to be forwarded to the machine running the server. See your router's instructions for how to set this up. There are a large number of setup guides for different models of router here: http://portforward.com/english/routers/port_forwarding/
You will need to know the external IP address of the machine running the server. This can be discovered by visiting http://www.whatsmyip.org from that machine.
To connect to the server, open your operating system's terminal or command prompt and start the telnet client by running:
telnet <ip address> 1234
where <ip address> is the external IP address of the server, as described
above. 1234 is the port number that the server listens on.
If you are using Windows Vista, 7, 8 or later and get the message:
'telnet' is not recognized as an internal or external command, operable
program or batch file.
then follow this guide to install the Windows telnet client.
If all goes well, you should be presented with the message
What is your name?
To quit the telnet client, press ctl + ] to go to the prompt, and then
type quit.
Telnet is simple text-based network communication protocol that was invented in 1969 and has since been superseded by other, more secure protocols. It does remain popular for a few specialised uses however, MUD games being one of these uses. A long (and boring) history of the telnet protocol can be found here: http://www.cs.utexas.edu/users/chris/think/ARPANET/Telnet/Telnet.shtml
MUD is short for Multi-User Dungeon. A MUD is a text-based online role-playing game. MUDs were popular in the early 80s and were the precursor to the graphical Massively-Multiplayer Online Role-Playing Games we have today, like World of Warcraft. http://www.mudconnect.com is a great site for learning more about MUDs.
MUD Pi was written by Mark Frimston see the project's Github page.
For feedback, please email [email protected] or add a comment on the project's Github page