Update README.md

This commit is contained in:
Jonas Weinz 2019-04-01 20:11:03 +02:00 committed by GitHub
parent 57f2686c67
commit 886700f2da
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,4 +1,4 @@
# ultimate_tictactoe_server # Ultimate TicTacToe Server
a python server backend for ultimate tic-tac-toe. a python server backend for ultimate tic-tac-toe.
@ -16,24 +16,32 @@ setup the database connection settings in `settings.py`. If files for a certific
```json ```json
{ {
'complete_field': '[[...],[...],...]', "complete_field": '[[...],[...],...]',
'global_field': '[[...],[...],...]', "global_field": '[[...],[...],...]',
'last_move': { "last_move": {
"sub_x": "...", "sub_x": <int: xcoord of subfield of last move>,
"sub_y": "...", "sub_y": <int: ycoord of subfield of last move>,
"x": "...", "x": <int: local xcoord in subfield of last move>,
"y": "..." "y": <int: local ycoord in subfield of last move>
} }
'game_over': <true | false>, "game_over": <true | false>,
'is_draw': <true | false>, "is_draw": <true | false>,
'player_won': <null | <player_name>>, "player_won": <null | <player_name>>,
'current_player': <null | <player_name>>, "current_player": <null | <player_name>>,
'player_a': "...", "player_a": "...",
'player_b': "..." "player_b": "..."
} }
``` ```
`complete_field` is of dimension 9x9, `global_field` of 3x3 (indicating the status of each subfield).
The possible values for a single field are
```
FIELD_EMPTY = 0
FIELD_USER_A = 1
FIELD_USER_B = 2
FIELD_DRAW = 3
```
**match**: **match**: