Kingdom Index

• Overview
• Running the “app”
  • Installation
  • Starting the server
  • Starting the client
• F.A.Q.

Overview

Kingdom Index is a board set-up "app" for the deck-building game Dominion featuring an "index system" designed to test play fan-created cards or community (unofficial) expansions.

Running the "app"

Installation

1. clone the repository: git clone https://github.com/polijan/KingdomIndex.git
2. call the ./install script, this will:
   1. git clone a fork/clone of blakevanlan's KingdomCreator project. Kingdom Creator is a randomizer for Dominion cards and we use it to get the graphics of most Dominion cards (and it's nice being able to use the randomizer also).
   2. set up the app directory.

Starting the server

Use the server script (check its usage), for example:

• $ ./server — run server locally on the default port (8888)
• $ ./server -w 1234 — run server on the network (-w), and specify the port 1234

Notes:

• Do NOT run this on a public network!!! Kingdom Index server is meant to be run locally on your machine or your private secure LAN.
• The server needs the classic Unix utilities and also uses either Python or busybox to start a CGI-capable HTTP server. I have tested it on my RaspberryPi (Debian-based Linux distro) and my tablet (Android with Termux), but it should run on other "Unix-like" systems too (e.g. Windows with WSL, MacOS, Chromebook with Linux support, etc.) with no or minor modifications.

Starting the client

Use a (modern) web browser to connect to the start.html page (it's important) on the server. For example, if you have launched the server with no option, that would be: http://localhost:8888/start.html

Notes:

• If you have qrencode installed on the server, it will display a QR code with the URL to connect to. This can be convenient to quickly run the client from a tablet (note: displaying the board from a phone doesn't make much sense given the size of the screen)
• in the interface, the indexes next to the cards are editable.

---

F.A.Q.

Q: Should I make my own "index" cards to play ? How?

Yes, that is the idea! Index cards are used as proxies to represent real cards. By watching the board generated by Kingdom Index, you can easily see what card each index card represents.

Index cards are divided into twelve-cards piles:

• Each pile has one index, which is either:
• a number (1 to 10). (numbers are assigned to kingdom cards piles)
• or a letter (A, B, C, ...) to be assigned to non-kindgom piles
• Each card in a pile also gets an individual number from 1 to 12. (this is useful for split piles, knights,etc.)

I designed my index cards piles from various medieval/fantasy-themed artwork I picked from the Internet (which is why I don't distribute a hi-res version of them). As I own the 1^st version of Intrigue (which used to be a 500-cards stand-alone game instead of a 300-cards expansion), I immediately found >200 unused cards to transform into my index cards deck. As my Dominion cards are sleeved, I used a regular inkjet printer to prepare papers (18 images with a 1-10/A-H "shield" + a 1-12 number) which, once inserted in the sleeves, looked exactly like regular Dominion cards.

Q: I want to play Dominion on my computer, not fiddle with cards!

You might want to use the official Dominion Online port of the game instead.

Q: Where to find fan-made cards and expansions?

Look online:

• Dominion Strategy has an active forum dedicated to Variants, Expansions, and Fan Cards where you can find many interesting expansions, cards ideas, and a fantastic weekly card contest.
• Redditors also post custom cards on the r/dominion sub-reddit.
• A few expansions can be found here on BoardGameGeek.

Q: How to include new cards / expansions into Kingdom Index ?

They should be added in the games directory. I included four fan-based expansions (Antiquities, Salvation, FairyTale, and a Christmas expansion) as examples so that you can see how they should be included... (todo: add more explanation)

Q: How can I design my own cards / expansion?

• First anf foremost, you should read the Fan Card Creation Guide: here and here.
• When it comes to graphics design, this free tool may help you.

Q: I made my own fan expansion! Could you include it in your project?

Hmmm... I could consider that if:

• your cards have been test-played, reviewed, and well-received (ideally from here)
• your cards have graphics, and you can provide them (ideally cards should be 293x473 jpeg images) along with a description, and also your expansion shoudn't infringe copyrights.

Q: Can I use index cards to map some of the (official) Dominion cards?

Kingdom Index can assign indexes to official Dominion cards (except for the basic treasure/victory/curse cards from the base game as those are needed for every game)... but if you do so, you must make sure you own the games that include those cards.

Q: I need help! I want Feature X,Y, or Z! I require this and that...

You're free to ask, however I make no promise to consider your request, respond to it, or even read it. I might consider correcting bad bugs or adding important features if I could use the change myself and it's easy to do. Please understand (and don't get mad at me): I hacked this project quickly for my personal use, and do not intend to spend much time polishing or maintaining it.