This is a MUD built in Python that gives a web API
The URL is optional, it will default to localhost:5000
python main.py "http://localhost:5000"You must setup the mysql info in config.py
See below for schema required.
The IP will default to "localhost". use "0.0.0.0"
python main.py "localhost"| URL | Usage | Data | Returns | Notes |
|---|---|---|---|---|
| /api/user/register/ | Used to register new users. | 'username', 'password' and 'salt' | Either an 'error' field or 'result' field. | 'password' should contain the user's plaintext password and a 'uuid.uuid4.hex()' as the 'salt' appended and then be hashed using SHA256 |
| /api/user/login/ | Used to get a token from an existing user. | 'username' and 'password' | Either an 'error' field or 'result'. If 'result' is true a 'token' will be present | 'password' should contain the user's plaintext password with the 'salt' retrieved appended and then be hashed with SHA256 |
| /api/user/salt/ | ||||
| /api/user/location/ | ||||
| /api/user/move/ | ||||
| /api/user/inventory/ | ||||
| /api/quests/ |
Table: users
| Field | Type | Null | Key | Default | Extra |
|---|---|---|---|---|---|
| userID | int(11) | NO | PRI | NULL | auto_increment |
| username | varchar(255) | YES | NULL | ||
| password | varchar(512) | YES | NULL | ||
| salt | varchar(255) | YES | NULL | ||
| location | int(11) | YES | NULL | ||
| token | varchar(255) | YES | NULL | ||
| strength | int(11) | YES | NULL | ||
| fortitude | int(11) | YES | NULL | ||
| charisma | int(11) | YES | NULL | ||
| wisdom | int(11) | YES | NULL | ||
| dexterity | int(11) | YES | NULL |
- Multiple usernames are allowed
- The world movement is a bit messy