<commit_before># AberWebMUD
AberWebMUD is a university (Aberystwyth) final year Major Project.
Designed to be a MUD (themes and gameplay to be decided) thats main
focus is to be easy to play and available online without the need for
special clients.

## Build info, references, and licenses
Created with Python 3.6.0 and packaged with:
* [Pixi.js (MIT License)] (http://www.pixijs.com/)
* [Flask-SocketIO (MIT License)] (https://github.com/miguelgrinberg/Flask-SocketIO)
* [QUnit (JS Foundation License)] (http://qunitjs.com/)
* ["Zelda-like tilesets and sprites" by ArMM1998 (CC0 1.0)] (http://opengameart.org/content/zelda-like-tilesets-and-sprites)

Other technologies used:
* [Flask (BSD License)] (http://flask.pocoo.org/)
* [SocketsIO (MIT License)] (http://socket.io/)
* [PostgreSQL] (https://www.postgresql.org/)
* Texture atlas creation using ["Leshy SpriteSheet Tool - Online Sprite Sheet, Texture Atlas Packer"]
 (https://www.leshylabs.com/apps/sstool/)

Check the requirements.txt for dependancy version details
Check the LICENSE file for the project's license

## Running the project
1. Change your terminal directory to the server folder
2. To ensure the JavaScript files have been concatted into the client.js file, run build.sh in the scripts folder
3. Currently the project is run-dependant on a PostgreSQL database, so you must ensure the PostgreSQL database service is running (database.py should detail what is expected if automatic DB 
creation is not enabled)
4. Run main.py in Python
5. visit 'localhost:5000' in a browser


## Running client tests (QUnit)
Client tests are available once the server is running (main.py) at 'localhost:5000/test'

## Running server tests (unittest)<commit_msg>Added UI support for character details<commit_after># AberWebMUD
AberWebMUD is a university (Aberystwyth) final year Major Project.
Designed to be a MUD (themes and gameplay to be decided) thats main
focus is to be easy to play and available online without the need for
special clients.

## Build info, references, and licenses
Created with Python 3.6.0 and packaged with:
* [Pixi.js (MIT License)] (http://www.pixijs.com/)
* [Flask-SocketIO (MIT License)] (https://github.com/miguelgrinberg/Flask-SocketIO)
* [QUnit (JS Foundation License)] (http://qunitjs.com/)
* ["Zelda-like tilesets and sprites" by ArMM1998 (CC0 1.0)] (http://opengameart.org/content/zelda-like-tilesets-and-sprites)

Other technologies used:
* [Flask (BSD License)] (http://flask.pocoo.org/)
* [SocketsIO (MIT License)] (http://socket.io/)
* [PostgreSQL] (https://www.postgresql.org/)
* Texture atlas creation using ["Leshy SpriteSheet Tool - Online Sprite Sheet, Texture Atlas Packer"]
 (https://www.leshylabs.com/apps/sstool/)

Check the requirements.txt for dependancy version details
Check the LICENSE file for the project's license

## Running the project
1. Change your terminal directory to the server folder
2. You may have to ensure the JavaScript files have been concatted into the client.js file, run build.sh in the scripts folder (there's a good chance this has already been done before a Git 
commit) 
3. Run main.py in Python
4. visit 'localhost:5000' in a browser

## Postgres vs SQLite
The project currently uses an SQLite DB in-memory in order to run locally for development and demonstration.
The project can also be run with a PostgreSQL database for a scalable DB platform if deployed (adjusted in database.py), if so you must ensure the PostgreSQL database service 
is running (database.py should detail what is expected).

## Running client tests (QUnit)
Client tests are available once the server is running (main.py) at 'localhost:5000/test'

## Running server tests (unittest)
{'fraction_non_alphanumeric': 0.09401246274722297, 'fraction_numerical': 0.01219181793551883, 'mean_word_length': 4.688751926040061, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 6, 'lorem ipsum': 0, 'www.': 6, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6140416', 'n_tokens_mistral': 1115, 'n_tokens_neox': 1065, 'n_words': 466}