Web based implementation of the Ashes Reborn card game
This is the respository for the code that runs ashteki.com, which allows people to play Ashes Reborn in their browser
Yep. This is a fork of the Keyteki source, with some retrofitting from ringteki.
Sure! The code is written in node.js(server) and react.js(client). Feel free to make suggestions, implement new cards, refactor bits of the code, raise pull requests or submit bug reports. If you are going to contribute code, try and follow the style of the existing code as much as possible and talk to dijon before engaging in any big refactors. Also bear in mind there is an .eslintrc file in the project so try to follow those rules.
There's some info that may help getting started in the /docs folder.
If you're not coding inclined, then just playing games on the site, and reporting bugs and issues that you find is a big help
If there's anything you can't do that you need to be able to do, let me know by raising an issue. Likewise if there's a bug, a crash, or anything amiss then let me know by raising an issue on github or visiting the Ashes discord server.
This is an overview that should work, but get in touch as soon as you run into any hiccups.
If you have docker installed, you can use the containerised version of the site. Clone the repository, then navigate to the repository and run the following commands:
npm install
docker-compose up
In another terminal, navigate to the repository and run the following commands:
docker-compose exec lobby node server/scripts/importdata
docker-compose exec lobby node server/scripts/importprecons
These commands import card data, and precons respectively. They can be run from the command line at any time to delete and recreate the data.
- Git
- Node.js 18
- mongodb
- Redis
The best way to install node is using nvm (node version manager)
Clone the repository, then run the following commands:
npm install
mkdir server/logs
Create config/local.json5 and put something like the following in it:
{
mongo: 'mongodb://127.0.0.1:27017/ashteki',
redisUrl: 'redis://127.0.0.1',
gameNode: {
hostname: 'localhost',
origin: '*'
}
}
Run the following commands:
node server/scripts/importdata
node server/scripts/importprecons
node .
node server/gamenode
There are two executable components and you'll need to configure/run both to run a local server. First is the lobby server and then there are game nodes. If you need to change any configurations, edit config/default.json5 or create a config/local.json5 configuration that overrides any desired settings.
If the above docker solution works for you then that's great, but I had a few troubles with hot reloading front end changes. I run mongodb and redis as docker containers, and then run the node services (lobby and gamenodes) locally in windows.
The game server should be accessible by browsing to localhost:4000.
You can register 2 or more users, to play against yourself. They can have fake email addresses. You can login as both users either from 2 different browsers, or by using an incognito window.
These users will be normal (non-admin) users. To escalate a user to the admin role you can run
node server/scripts/user/makeSuperuser <username>
This is not required for testing in-game functionality.
Before you run the unit tests, be sure all the necessary dependencies are installed
npm install
Then, to run the tests:
npm test
All JavaScript code included in Ashteki should pass (no errors, no warnings)
linting by ESLint, according to the rules defined in
.eslintrc at the root of this repo. To manually check that that is indeed the
case install ESLint and run
npm run lint
from repository's root.
All tests should also pass. To run these manually do:
npm test
If you are making any game engine changes, these will not be accepted without unit tests to cover them.