diff --git a/contrib/customize_cardset.asciidoc b/contrib/customize_cardset.asciidoc index 723fcc11..e324c29d 100644 --- a/contrib/customize_cardset.asciidoc +++ b/contrib/customize_cardset.asciidoc @@ -1,27 +1,30 @@ -CARDSET CUSTOMIZATION TUTORIAL +Cardset Customization Tutorial ============================== :Author: Eric Rausch :Email: -CONFIG.TXT TEMPLATE +config.txt template ------------------- -PySolFC solitaire cardset;$A;$FTM;$B;$C;$D,$E;$F + -; + -X Y D + -XOFF YOFF SXOFF SYOFF + -back01.ext + +.... +PySolFC solitaire cardset;$A;$FMT;$B;$C;$D,$E;$F +; +X Y D +XOFF YOFF SXOFF SYOFF +back01.ext back01.ext;back02.ext;back03.ext +.... - -LINE 1 +Line 1 ------ -*$A:* The number of fields in first line (e.g. .gif;1;78;8,1016 -> $A=4) + -*TIP:* $D and $E are comma separated and count for one field +*$A:* The number of fields in first line (e.g. `.gif;1;78;8,1016` -> `$A=4`) + +( *NOTE:* $D and $E are comma separated and count for one field ) + +*$FMT:* The format of the images used; e.g. .gif, .png, .jpg (which types could exactly be used ?) -*$FMT:* The format of the images used; e.g. .gif, .png, .jpg (which types could exactly be used ?) + *$B:* The type of the cardset (see types below) Cardsets Types: @@ -37,7 +40,8 @@ Cardsets Types: * Dashavatara Ganjifa = 8 * Trumps Only = 9 -*$C:* The number of cards in the cardset, generally 42, 48, 52, 68, 78, 96 or 120 + +*$C:* The number of cards in the cardset, generally 42, 48, 52, 68, 78, 96 or 120 + *$D:* The Style of de cardset (this field can hold one or more comma separated values) Cardsets Styles: @@ -105,52 +109,56 @@ Cardsets Origins: *$F:* The Year the cardset was created (in the range 1000 to 2299) -LINE 2 +Line 2 ------ -: A name for PySolFC to identify your cardset (without spaces) + -*TIP:* You could add a number prefix (e.g. 123-cardset-name) +``: A name for PySolFC to identify your cardset (without spaces) -: Your cardset name as it should appear in the cardset manager +( *TIP:* You could add a number prefix (e.g. 123-cardset-name) ) +``: Your cardset name as it should appear in the cardset manager -LINE 3 +Line 3 ------ -*X:* The cards width (the card image width) + -*Y:* The cards height (the card image height) + -*D:* The color depth (mostly 8) +* *X:* The cards width (the card image width) +* *Y:* The cards height (the card image height) +* *D:* The color depth (mostly 8) - -LINE 4 +Line 4 ------ -*XOFF:* The horizontal offset of the cards + -*YOFF:* The vertical offset of the cards + -*SXOFF:* The offset of the horizontal shadow (mostly 7) + -*SYOFF:* The offset of the vertical shadow (mostly 7) +* *XOFF:* The horizontal offset of the cards +* *YOFF:* The vertical offset of the cards +* *SXOFF:* The offset of the horizontal shadow (mostly 7) +* *SYOFF:* The offset of the vertical shadow (mostly 7) - -LINE 5 +Line 5 ------ -back01.ext: The name of the default back image (where ext means the file extension) +`back01.ext`: The name of the default back image (where `ext` means the file extension +e.g: `png` or `gif`.) - -LINE 6 +Line 6 ------ -back01.ext;back02.ext;back03.ext;...: The name of the other back images, including the default one +`back01.ext;back02.ext;back03.ext;…``: The name of the other back images, including the default one. +About this document: +-------------------- *NOTE:* This tutorial may be incomplete. It is given as is, without any warranty, -to help players customizing their own cardsets. -You are welcome to send any suggestions or recommendations at: mailto:neelix570@gmail.com[] +to help players customize their own cardsets. +You are welcome to send any suggestions to: mailto:neelix570@gmail.com[the Author's E-mail], +https://github.com/shlomif/PySolFC/issues[PySol FC's GitHub issue tracker] or +https://sourceforge.net/p/pysolfc/_list/tickets[PySol FC's Sourceforge issue tracker]. -*LICENSE:* This tutorial was created under the terms of the GNU General Public License +License: +~~~~~~~~ + +This tutorial was created under the terms of the GNU General Public License version 3 or later. You can redistribute it as is and/or modify it. - - - +Shlomi Fish, hereby puts his modifications to this document under +https://github.com/shlomif/shlomif-computer-settings/blob/master/shlomif-settings/git/commit-messages/cc0-copyright-disclaimer.txt[CC0 / Public Domain / MIT License / GPL terms]