royalur / royalur.net-backend Goto Github PK

The server behind https://royalur.net!

License: MIT License

Java 99.92% Shell 0.08%

board-game royal-game-of-ur ur game game-server web-game java websockets

royalur.net-backend's Introduction

This is an archive from an old version of the website. We have since rewritten the website from the ground up using more modern technologies. However, we will keep this repository up for any who are interested! The new version of the website is no longer open-source.

🎲 RoyalUr.net Game Server

A website for playing the ancient Mesopotamian board game, The Royal Game of Ur!

This repository holds the server code for RoyalUr.net, https://royalur.net. The client code of RoyalUr.net can be found in the RoyalUrClient repository.

RoyalUr.net was created based upon the ancient Sumerian board game, The Royal Game of Ur, 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 can be used to chat about the game, find worthy opponents to challenge, discuss the development of RoyalUr.net, and it also contains a changelog with a summary of the changes being made to the website.

🖥️ Compilation

This project uses Maven, and so can be compiled using the command, mvn install.

This will produce a jar file containing the servers dependencies in the /target/ directory.

⚙️ Configuration

The RoyalUrServer uses a JSON config file for its settings. If you wish to use a config file, the ROYAL_UR_SERVER_CONFIG environment variable should be set with a file location in which to generate and read the config file from.

📝 License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero 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 Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.

royalur.net-backend's People

Contributors

Stargazers

Watchers

Forkers

fuzzymannerz flyarong

royalur.net-backend's Issues

Announcements

There should be a way to announce things to everyone playing an online game. This would be useful for when the server is being restarted a message such as "The server will be restarted in 30 minutes" can be displayed.

Option to create a link to play with friends.

There should be an option for users to generate a link that they can send to a friend so that they can play against them.

Serve smaller assets depending on screen size.

Improve loading times by serving smaller sized versions of assets when on smaller screen sizes.

Player connection status packet should be sent when reconnecting to a game

Currently if a player is disconnected and you reload the game, the player has no way to know if there opponent is still connected or not.

Persist games across restarts

Games should be saved to a database so that they can be persisted across restarts. This will make updating the game server not require aborting any games.

Let users select their names for online games

It would be really nice if users could select their names so that people can identify one another.

Add a version exchange while setting up the WebSocket connection

This way clients that are out of date can be notified. They can then reload the page.

Close users old games if they start a new online game

Currently a user is able to close out of one game, and then join another. This causes issues because although the packets sent by the user will be forwarded to their active game, they are able to receive packets from all their existing games. Once a user starts a new game, it probably makes the most sense to just stop their old games.

This needs to be tested as well though to make sure that starting multiple games across multiple tabs should still be possible.