finn/dominiontabs
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update readme to have markdown for github, new content

Browse Source
This commit is contained in:
Sumpfork 2015-04-24 15:00:51 -07:00
parent ae9c9b8da9
commit 9aeefba995
1 changed files with 16 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.txt
View File

@ -1,17 +1,23 @@
PREREQUISITES #Dominion Divider Generation
-Python Packages- ## Introduction
You need the python packages for reportlab (http://www.reportlab.com/software/opensource/rl-toolkit/download/) and PIL (http://www.pythonware.com/products/pil/) installed. You can install them manually or use the included setup.py via 'python setup.py install' (perhaps run via 'sudo') which should install everything for you.
-Fonts- This is a script to generate card dividers for storing cards for the game [Dominion](https://boardgamegeek.com/boardgame/36218/dominion). If you are just looking go generate some dominion dividers, there is no need to install this script as I host a [live version of this generator code](http://domtabs.sandflea.org). However, if you want to use arguments that I don't expose on that page, or change the code, or contribute to the project the full generation code (not the web interface or the fonts) is included here, and contributions are more than welcome.
I believe I cannot distribute one font (Minion Pro) dominion_tabs uses as they are commercially sold by Adobe. However, the font files are included with every install of the free Adobe Reader. For example, on Windows 7 they are in C:\Program Files (x86)\Adobe\Reader 9.0\Resource\Font called MinionPro-Regular.otf and MinionPro-Bold.otf. Copy these two files to the dominion_tabs directory.
Again, to generate tabs go to the ***[Online Generator](http://domtabs.sandflea.org)***.
## Prerequisites
#### Python Packages
You need the python packages for reportlab (http://www.reportlab.com/software/opensource/rl-toolkit/download/) and PIL (http://www.pythonware.com/products/pil/) installed. You can install them manually or use the included setup.py via 'python setup.py install' (perhaps run via 'sudo' if not in a virtual env) which should install everything for you.
#### Fonts
I believe I cannot distribute one font (Minion Pro) dominion\_tabs uses as they are commercially sold by Adobe. However, the font files are included with every install of the free Adobe Reader. For example, on Windows 7 they are in C:\Program Files (x86)\Adobe\Reader 9.0\Resource\Font called MinionPro-Regular.otf and MinionPro-Bold.otf. Copy these two files to the dominion_tabs directory.
Sadly, these fonts use features of the otf format that are not support by the reportlab package. Thus, they need to first be converted to ttf (TrueType) format. I used the open source package fontforge to do the conversion. Included as 'convert.ff' is a script for fontforge to do the conversion, on Mac OS X with fontforge installed through macports you can just run './convert.ff MinionPro-Regular.otf' and './convert.ff MinionPro-Bold.otf'. With other fontforge installations, you'll need to change the first line of convert.ff to point to your fontforge executable. I have not done this step under Windows - I imagine it may be possible with a cygwin install of fontforge or some such method. Sadly, these fonts use features of the otf format that are not support by the reportlab package. Thus, they need to first be converted to ttf (TrueType) format. I used the open source package fontforge to do the conversion. Included as 'convert.ff' is a script for fontforge to do the conversion, on Mac OS X with fontforge installed through macports you can just run './convert.ff MinionPro-Regular.otf' and './convert.ff MinionPro-Bold.otf'. With other fontforge installations, you'll need to change the first line of convert.ff to point to your fontforge executable. I have not done this step under Windows - I imagine it may be possible with a cygwin install of fontforge or some such method.
INSTALL/RUNNING ## Install/Running
There's no real install. Once the prerequisites exist, just run 'python dominiontabs.py <outfile>' to produce a pdf file of dominion tabs. You can use a '-h' flag to see various options, such as changing to vertical tabs. For any fine adjustment you'll actually need to edit the python file dominion_tabs.py for now - the card sizes, for example, are defined at the bottom, but there are some magic numbers throughout the code, still - I wrote this quickly and for my own purposes :). Once the prerequisites exist, just run 'python dominiontabs.py <outfile>' to produce a pdf file of dominion tabs. You can use a '-h' flag to see various options, such as changing to vertical tabs.
I'm largely providing this as-is and not promising any bug fixes or request fulfillments, but feel free to comment on boardgamegeek at http://boardgamegeek.com/filepage/59848/horizontal-double-sided-dominion-tabs-for-all-expa or the launchpad project at https://launchpad.net/dominiontabs. Feel free to comment on boardgamegeek at <http://boardgamegeek.com/filepage/59848/horizontal-double-sided-dominion-tabs-for-all-expa> or file issues on github (<https://github.com/sumpfork/dominiontabs/issues>).
Sumpfork