src/carddecks/readme.contrib

0001 Dear Contributor,
0002
0003 This  simple How-To will help you get it right the first time around, should you wish to add your sparkling new card deck to our happy bunch.
0004
0005 1. Make a right directory.
0006
0007     1.1 Directory name is comprised of following parts: Technology[SVG/non SVG]-Actual-Name
0008         For example lets say your deck is called 'My Cards', and it's drawn in Inkscape thus making it SVG based. Then the directory you want to create is: svg-my-cards. I case your card deck is png(raster) based, the directory you wish to make is: my-cards
0009
0010     1.2 Once the directory is all set up you may move on to populating it with relevant files.
0011
0012 2. What files are there?
0013
0014     2.1 There are only three files that must be present in your directory. Those are:
0015             a) description file (.desktop)
0016             b) screenshot (.png)
0017             c) theme file(s) (.svg/.png)
0018         Let me elaborate on each of those.
0019
0020     2.2 Description file.
0021         The description file must be named index.desktop and populated as follows:
0022
0023 --------- index.desktop ---------
0024 [KDE Backdeck]
0025 Name=My Cards (or whatever name you want it to be)
0026 Comment=Some comment (This is in optional entry, waving to do with the description of the card deck)
0027 Preview= .png (your screenshot file)
0028 SVG= .svg/svgz (your svg deck.) <<<!!!!! FOR SVG BASED DECKS ONLY!!!!
0029 BackSize= [width]x[height] (the default size of your deck)
0030 Default=true/false (please set this to false, as it's up to the release team to decide)
0031 Back=back name (now this one is tricky; basicly this entry should correspond to the card back entry you will have to place into decks/ subdirectory, but we will get inot the details later)
0032 -------------------------------------
0033
0034 And you are done here! Simple huh? :P
0035
0036     2.3 Screenshot
0037         This is quite streight forward section. All you have to do is make a png file containing a pic of any single one of your cards (usually 120x70 in dimentions, but this are not limited). The only thing you have to make sure of is that the name of the file (screenshot.png) corresponds exactly to the .desktop entry.
0038
0039     2.4 The theme file(s)
0040         Now, this section changes depending on the format you choose, so:
0041             a) SVG
0042                 SVG works simple and quite straight forward. All you need is for your file to be named my theme.svg(svgz), place it into your dir, and make sure the name exactly corresponds to the SVG entry in your .desktop file.
0043             b) PNG
0044                 This here is a bit tricky. Basicly each of the cards from the deck in sorted by number. For instance Ace of Clubs is always 1.png, etc. Please refer to any existing deck for better refernces.
0045
0046 3. Card Backs
0047
0048     3.1 Because it's always a good idea to separate the actual deck from the back, we have done just that. So, all the card backs have to go into decks directory.
0049         So first and foremost check inside the decks directory to see what is the last number used there. Lets say it's 13 (all the backs are named currently deck1 to deck13), so next in line is 14, therefore you should name all your files deck14.*
0050
0051     3.2 The files you need are:
0052         a) deck[n].desktop (description file)
0053         b) deck[n].png (screenshot/card back)
0054         c) deck[n].svg/svgz (card back [optional])
0055
0056     3.3 Details
0057         3.3.1 deck[n].desktop is the main file describing the back of your deck. It should have the following structure:
0058
0059 ------------- deck[n].desktop --------------
0060 [KDE Cards]
0061 Name=My name (this must be the same as your card deck name)
0062 Comment=Some more detailed description of the card back
0063 SVG=deck[n].svg/svgz (this entry is optional, and only needed in case your deck is in SVG/SVGZ format)
0064 Default=true/false (please set this to false by default)
0065 ----------------------------------------------
0066
0067 That's all.
0068
0069         3.3.1 deck[n].png is the screenshot of the card back in case the format of your cards is svg/scgz, or an actual cardback if the format is PNG.
0070         3.3.2 deck[n].svg/svgz In case the format of your card deck is SVG this is an actuall file card games will use. Make sure it has a proper extention (svg, or svgz) and exactly matches your entry in .desktop file.
0071
0072 And this is it folks. Hope it works the first time around :)