================== Python-Talk Readme ================== Python-Talk version: 0.001 (Tenor Clef) Author: Rich "OwlofDoom" Daley Homepage: <http://talk.sf.net/> What is Python-Talk? -------------------- Python-Talk is a free open-source implementation of a talker (chat room) environment, in the command-driven style of ew-too, and written in Object-Oriented Python. Python-Talk is not supposed to be a replacement for ew-too, but is intended to be a new and innovative style of talker, with easily extended code, so coders old and new can make their talkers dramatically different from everyone else's. This version is a very early Alpha (hence the version number 0.001), and does not even implement player files (pfiles) yet. It can be used as a basic chat room and incorporates a few commands. Watch this space for updates. What do I need to run it? ------------------------- At the moment, Python-Talk requires a Python <http://www.python.org> installation of version 2.0 or above (versions below 2.0 didn't support some common operations such as +=), and this software is available for a number of platforms including the highly popular Windows, *nix (including Linux) and Mac OS platforms. Python-Talk should be platform independent, but has only so far been tested on Linux kernel 2.4.19. How do i run it? ---------------- *nix / Mac OS X ~~~~~~~~~~~~~~~ You should be able to run Python-Talk just by executing the "talk" file cd talk ./talk This will compile all the files, if not already done, and run the talker. If all is successful, you should get the message Server up and running! If you get an error about permission, try chmod +x talk Once up and running, follow the instructions in the section "Connections to the talker" Windows / Other OSs ~~~~~~~~~~~~~~~~~~~ Start a shell (in Windows this is called "MS-DOS Prompt" or "Command Prompt" depending on your version) and navigate to the talk directory. From there, type python -OO talk You should get the message Server up and running! Connections to the talker ------------------------- Once the server is running, users can connect to it by telnetting (preferably using a MUD client - good ones for *nix and Windows are at <http://www.muq.org/~hawkeye/tf/> and <http://simplemu.onlineroleplay.com/> respectively) to your IP address (or 0.0.0.0 if they are on the same machine as you) and port 4321 (or whichever port you have chosen in the "talk" script). Users should type a name which they'll be known by, and can then talk using the following commands: say (or ' or ") - say something to the room eg say hello emote (or ; or ::) - do an action ... "emote waves" if you are called "Owl" will let the room know that "Owl waves" think/sing - self explanatory who - lets the user know who is in the room, and how long it has been since they last typed. How do I report bugs? --------------------- There is a bug tracker at the sf.net project page <http://sf.net/projects/talk/>. File your bug report there and we'll get onto it as soon as possible. How can I contribute? --------------------- You can submit patches to the patch tracker, but even better than that, why not email the developer (owlofdoom@users.sourceforge.net) and ask to join in. The more the merrier! Enjoy Python-Talk and keep checking back for updates!