Welcome to the Unofficial Dominion Assistant, a React application designed to enhance your gameplay experience for the popular card game, Dominion! This tool provides comprehensive features for game management, scoring, and player interaction, allowing Dominion enthusiasts to focus on strategy and enjoyment.
Please note that the Unofficial Dominion Assistant is not affiliated with or endorsed by the makers of Dominion or Donald X Vaccarino. This application is a fan-built project created to enhance your gameplay experience and requires ownership of the physical Dominion game to use. It does not allow you to play without having the original game. The use of the Dominion logo is intended solely for personal use to support the Dominion community and should be considered under the Fair Use Doctrine.
Under 17 U.S.C. § 107, fair use allows limited use of copyrighted material without requiring permission from the rights holders. Factors to consider include:
- The purpose and character of the use (e.g., educational, non-commercial).
- The nature of the copyrighted work.
- The amount and substantiality of the portion used.
- The effect of the use on the potential market for the original work.
Case References:
- In Campbell v. Acuff-Rose Music, Inc., 510 U.S. 569 (1994), the U.S. Supreme Court emphasized that transformative uses of copyrighted material could qualify as fair use.
- In Lentz v. Morrow, 104 Cal.App.3d 392 (1980), the court upheld that using copyrighted material in a manner that requires the original for use is less likely to infringe on the copyright holder’s rights.
Our application, as a fan-built tool that does not replicate the game, could be argued as transformative.
- Player Management: Easily add, remove, and track multiple players
- Dynamic Scoring: Real-time score calculation and leaderboard
- Game Setup Wizard: Customizable options for various game modes and expansions
- Turn Tracking: Keep track of player turns and phases
- Detailed Game Log: Record and review game events and card plays
- Expansion Support: Compatibility with various Dominion expansions and game mats
- Save/Load Games: Ability to save game progress and resume later
- Intuitive UI: User-friendly interface with Material-UI components
This is an NX project created with create-nx-workspace.
- Node.js (version 20.9.0 or higher)
- yarn (version 1.22.22 or higher)
- NX CLI
-
Clone the repository:
git clone https://github.com/Digital-Defiance/DominionAssistant.git
From here you may follow the instructions below or jump to the section on Dev Container usage.
-
Install dependencies
yarn install
-
Start the app
yarn start
A popup should offer to open the application in a browser.
- Visual Studio Code
- Docker
- Remote - Containers extension for VS Code
-
Clone the repository:
git clone https://github.com/Digital-Defiance/DominionAssistant.git
-
Open the project folder in Visual Studio Code.
-
Set up .env:
- Copy the .env.example in the project root to .env
- Fill in the CODACY_PROJECT_TOKEN from https://app.codacy.com/gh/Digital-Defiance/DominionAssistant/settings/coverage
- Save the .env file
- When prompted, click "Reopen in Container" or use the command palette (F1) and select "Remote-Containers: Reopen in Container".
- VS Code will build the dev container and set up the environment. This may take a few minutes the first time.
- Once the container is ready, open a new terminal in VS Code and run:
yarn install
- Start the app:
yarn start
A popup should offer to open the application in a browser.
We highly recommend using Visual Studio Code Dev Containers/Docker for a consistent and isolated development environment. This ensures that all dependencies and configurations are standardized across different development setups.
The devcontainer.json postCreateCommand will run through setup of NVM to select a desired version of Node, perform the yarn install, and install the nx cli globals.
Once the application is started with yarn start-
The app consists of several main screens:
- Home Screen
- Dominion Assistant (main game screen)
- Game Log
- Load/Save Game
Navigate through these screens using the tab bar at the bottom of the app.
To start a new game:
- Add player names
- Set game options (including expansions and special rules)
- Start the game and use the interface to track scores, turns, and game events
Other commands available:
- yarn start: Starts the development server
- yarn build: Builds the app using NX
- yarn test:jest: Runs Jest tests
- yarn test:jest:single: Runs a single specified test (eg yarn test:jest:single src/game/tests/dominion-lib-load-save-saveGame.spec.ts)
- yarn test:playwright: Runs playwright e2e tests
- yarn test:playwright:report: Shows the playwright report
- yarn lint:eslint: Runs ESLint
- yarn lint:eslint:fix: Runs ESLint with auto-fix option
- yarn lint:prettier:fix: Runs Prettier to format various file types
- yarn clean: Removes dist/coverage directories
- yarn reset: Removes node_modules, dist, coverage, and runs yarn install again
We welcome contributions to Dominion Assistant! Please read our Contributing Guide for details on our code of conduct and the process for submitting pull requests.
This project is licensed under the MIT License.
- The creators of Dominion for inspiring this project
- React and NX for providing the development framework
- Material-UI for the component library
- Digital Defiance and Jessica Mulein for facilitating and creating this work
To learn more about developing your project, look at the following resources:
Join our community of developers.
- Digital Defiance: 501c3 Non Profit Open Source Engineering Guild, with our own Discord.