🎲 The Royal Game of Ur
A website for playing the ancient Mesopatamian board game, the Royal Game of Ur!
This repository holds the client code for The Royal Game of Ur, https://royalur.net. The server code of The Royal Game of Ur can be found in the RoyalUrServer repository.
The Royal Game of Ur is based upon an ancient Sumerian board game in the British Museum. The original board game can be dated to 2600 BC, and was discovered in a royal tomb in the city-state of Ur in ancient Mesopotamia. Learn more about the game on Wikipedia, or watch a fun match between Tom Scott and Irving Finkel on YouTube!
The game also has a Discord and a Reddit that you might want to check out! The Discord contains a changelog with a summary of all the changes being made to the website, as well as discussion about RoyalUr development.
🖥️ Compilation
This project uses Babel to transpile all Javascript to a single ES5 compatible file, as well as a Python script to generate the resource files needed for the site.
The following commands will compile the site to ./compiled:
./compile.sh release -- Full clean compilation, with minified JS.
./compile.sh dev -- No minification, no cleaning of ./compiled folder.
If you run into ./res file related issues during compilation, try updating your ./res folder.
To update the contents of your ./res folder as the resources used by RoyalUrClient change, simply delete it and let the compilation script download it again for you.
🛠️ Project Architecture
A summary of the architecture of The Royal Game of Ur can be found in ARCHITECTURE.md.
💾 Resource Files
The image, audio, and annotation assets required by the project are not actually stored in git, due to git's poor handling of binary files. Instead, the script to compile the site will automatically download the resources for you from https://royalur.net/res.zip.
📝 License
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.