Settlers of Catan implemented in Lua
LuaCatan is an implementation of the famous board game "Settlers of Catan" in Lua. This repository is divided into the following directories:
catan: Lua modules for the back-end and front-end of the applicationimages: Images used by the front-endlayers: GIMP project files for the images used by the front-endstyle: CSS stylesheets for the HTML version of the documentationtest: Tests for the Lua modulesutil: Lua modules for utilities used incatan
If you'd like to learn more about the project, please go to ABOUT.md.
User Dependencies
If you have LuaRocks on your machine, you can install Serpent with the following command.
luarocks install serpent 0.30-2
Tutorial
Please go to TUTORIAL.md.
Developer Dependencies
If you have LuaRocks on your machine, you can install the Lua modules above with the following commands.
luarocks install ldoc 1.5.0-1 luarocks install argparse 0.7.1-1 luarocks install luacov 0.15.0-1 luarocks install luacov-html 1.0.0-1
Tests
The tests reside in the test/ folder, and can be run with the following command.
make test
If you want to check the test coverage, you may want to run the following command.
make test-coverage
This will generate a stats report. You may want an HTML page, so you can more easily inspect the coverage report. Simply run this command.
make html-coverage-report
You can also remove any output from the test coverage suite by running...
make clean
Documentation
Hosted
You can see the latest version of the documentation here.
Local
You can also build the documentation locally by running the following command.
make docs
This should load the configurations from the config.ld file. You can tinker with the configuration however you like.