File	Date	Author	Commit
www	2022-12-08	Lee Harr	[a6a7f5] show correct time when extending time
.hgignore	2021-04-15	Lee Harr	[8c786c] fix permissions
.hgtags	2015-08-17	Lee Harr	[dc7e27] Added tag acromania-0.6 for changeset 49e749631a39
.tar-ignore	2021-04-15	Lee Harr	[8c786c] fix permissions
COPYING	2020-10-28	Lee Harr	[8557b2] fix file perms
HELP.irc	2021-05-14	Lee Harr	[033b3f] warn of shortened phase. allow requesting more ...
HELP.sa	2021-05-14	Lee Harr	[033b3f] warn of shortened phase. allow requesting more ...
MOTD	2020-10-28	Lee Harr	[8557b2] fix file perms
README	2022-12-05	Lee Harr	[f46463] add web info to readme
RULES	2020-10-28	Lee Harr	[8557b2] fix file perms
TODO	2022-12-08	Lee Harr	[1c8c5e] update todo
am.tac	2021-04-15	Lee Harr	[8c786c] fix permissions
amdb.py	2021-06-03	Lee Harr	[361070] fix possible crash
amgame.py	2022-12-08	Lee Harr	[a6a7f5] show correct time when extending time
amircprotocol.py	2021-04-15	Lee Harr	[8c786c] fix permissions
amplayer.py	2021-05-06	Lee Harr	[15d301] initial_name should have been marked classmethod
amplayer_ai.py	2021-06-03	Lee Harr	[69e42d] neaten test output
amprotocol.py	2021-06-03	Lee Harr	[26efbc] better user/nick styling on scoreboard
amserver.py	2022-12-05	Lee Harr	[124f9d] show endgame trigger score on scoreboard
amwsprotocol.py	2021-06-03	Lee Harr	[26efbc] better user/nick styling on scoreboard
amwuiprotocol.py	2021-06-03	Lee Harr	[26efbc] better user/nick styling on scoreboard
announce	2020-10-28	Lee Harr	[8557b2] fix file perms
colors.py	2021-04-15	Lee Harr	[8c786c] fix permissions
conf_defaults.py	2021-06-03	Lee Harr	[a76d48] allow restricting number of words with apostrop...
dbschema.sql	2020-10-28	Lee Harr	[8557b2] fix file perms
htcolors.py	2021-04-15	Lee Harr	[8c786c] fix permissions
util.py	2021-05-14	Lee Harr	[92b642] move closest5 to util
wordschema.sql	2021-06-03	Lee Harr	[a76d48] allow restricting number of words with apostrop...

Read Me

Acromania is a networked word game of acronyms.
This program is a computer moderator for the game.

Check for the latest updates at:
    https://sourceforge.net/projects/acromania/


INSTALLING

First install the requirements:
    Python3 (http://www.python.org/)
        [tested with Python-3.7.3]
    Twisted (http://twistedmatrix.com/)
        [tested with Twisted-20.3.0]
    Twisted-words (http://twistedmatrix.com/)
        [tested with Twisted-words-20.3.0]
    Sqlite3 (http://www.sqlite.org/)
        [tested with pysqlite-2.6.0]
        [tested with Sqlite3-3.27.2]

    If you want to run the (optional) web / websocket site,
        you will also need:
        Flask (https://flask.palletsprojects.com)
            [tested with Flask-1.1.4]
        Autobahn-Python (https://github.com/crossbario/autobahn-python)
            [tested with autobahn-20.7.1]

    If you want to run the (optional) player bots,
        you will also need:
        NLTK (http://www.nltk.org/)
            [tested with NLTK-3.7.3]



Unpack the Acromania distribution somewhere you can
find it, and run the program from the unpacked folder.


RUNNING

Start the server with:
    twistd -noy am.tac

The first time you start it, the configuration file
conf.py will be created. Check the defaults in
conf_defaults.py and make changes in conf.py


CONNECTING

Depending on how you have the system configured,
you will be able to connect either:

    Directly: to a standalone server which can be
        accessed using a standard MUD client, or

    Through IRC: on the server and channels given
        under the IRC section of the conf.py file, or

    Through the web: either on a console-like page or
        on an app specifically designed for Acromania.


BOTS

To build the bots, first load needed modules:
$ python
>>> import nltk
>>> nltk.download('gutenberg')
>>> nltk.download('punkt')

Then build:
$ python amdb.py build Alice

Add bots to the game from the client interface:
/bot Alice


DEVELOPING

Acromania is Free Software, released under the GPL.

If you make any changes or improvements, please
consider sharing your changes with the project.

For instructions on checking out the latest code see:
    https://sourceforge.net/projects/acromania/