| summaryrefslogtreecommitdiff |
diff options
| -rw-r--r-- | README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..4c36b59 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Tacticians Online - Server +This is the code for the back-end of Tacticians Online, an online +multiplayer turn-based strategy game. + +## Getting Started + +### Prerequisites +* Erlang +* GNU make +* Jiffy (JSON NIFs for Erlang) +* Tacticians Online - Data +* Yaws +* m4 + +### Installing +1. Go into the directory in which this repository was cloned. +2. Set the DATA\_DIR variable in `./Makefile` to match the "Tacticians Online - + Data" directory. +3. Copy Yaws's `yaws_api.hrl` file to the `./include/` directory. +4. Run `$ make`. +5. Run `$ make run_db_node`, and then `$ make run_query_node` in parallel. +6. You should be done. If Erlang complains about node addresses, you might need + to set the `ERL_NAME_VS_SNAME` variable in `./Makefile` to its other value. + +## Screenshot (of the Client) + + +## License +Apache License 2.0 (see `./LICENSE`) |