From b49dd96bc8212c497e022ae88ced6f7ed97e0846 Mon Sep 17 00:00:00 2001 From: Joe R Date: Sat, 14 Jan 2023 14:14:04 -0500 Subject: [PATCH] Ported cardset customization guide to HTML and added it to the main documentation. --- contrib/customize_cardset.asciidoc | 2 +- html-src/cardset_customization.html | 276 ++++++++++++++++++++++++++++ html-src/gen-html.py | 1 + html-src/index.html | 1 + pysollib/ui/tktile/tkhtml.py | 1 + 5 files changed, 280 insertions(+), 1 deletion(-) create mode 100644 html-src/cardset_customization.html diff --git a/contrib/customize_cardset.asciidoc b/contrib/customize_cardset.asciidoc index 52efdae5..91be8184 100644 --- a/contrib/customize_cardset.asciidoc +++ b/contrib/customize_cardset.asciidoc @@ -44,7 +44,7 @@ Cardsets Types: *$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) +*$D:* The Style of the cardset (this field can hold one or more comma separated values) Cardsets Styles: ~~~~~~~~~~~~~~~~ diff --git a/html-src/cardset_customization.html b/html-src/cardset_customization.html new file mode 100644 index 00000000..1f6ea6dd --- /dev/null +++ b/html-src/cardset_customization.html @@ -0,0 +1,276 @@ +

Cardset Customization Tutorial

+

config.txt template

+ 
PySolFC solitaire cardset;$A;$FMT;$B;$C;$D,$E;$F
+<internal_name>;<cardset_name>
+X Y D
+XOFF YOFF SXOFF SYOFF
+back01.ext
+back01.ext;back02.ext;back03.ext
+

Line 1

+

$A: The cardset version number that belongs to the number + of fields divided through ";" on the first line (e.g. .gif;1;78;8,1016 → $A=4)

+

(WARNING: For Mahjongg, $A must always be 6 and the $F + field must be included in the line; however, you can put 0 in $F if you wish, in that case.)

+

(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?)

+

$B: The type of the cardset (see types below)

+

Cardsets Types:

+ +

$C: The number of cards in the cardset, generally 42, + 48, 52, 68, 78, 96 or 120

+

$D: The Style of the cardset (this field can hold one + or more comma separated values)

+

Cardsets Styles:

+ +

$E: The origin (country) of the cardset

+

Cardsets Origins:

+ +

$F: The Year the cardset was created (in the range 1000 + to 2299)

+

Line 2

+

<internal_name>: A name for PySolFC to identify your + cardset (without spaces)

+

(TIP: You could add a number prefix (e.g. 123-cardset-name) + )

+

<cardset_name>: Your cardset name as it should appear + in the cardset manager

+

Line 3

+ +

Line 4

+ +

Line 5

+

back01.ext: The name of the default back image (where ext means the file extension e.g: png or gif.)

+

Line 6

+

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 customize their own cardsets. + You are welcome to send any suggestions to: the Author’s E-mail, + PySol FC’s GitHub issue tracker or + PySol FC’s Sourceforge issue tracker.

+

NOTE 2: You should also place a file called COPYRIGHT in the same directory as config.txt, containing the text + that can be accessed via Info/Settings.

+

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 + CC0/Public Domain/MIT License/GPL terms

+

Credits:

+

Credits go to:

+

Andreas Sauer for clarifying certain + points

+

Shlomi Fish for making some + improvements to this tutorial

diff --git a/html-src/gen-html.py b/html-src/gen-html.py index 00895b71..ea965f4a 100755 --- a/html-src/gen-html.py +++ b/html-src/gen-html.py @@ -63,6 +63,7 @@ files = [ # ('rules.html', 'PySol - a Solitaire Game Collection'), ('assist_options.html', 'PySol - Assist Options'), ('solitaire_wizard.html', 'PySol - Solitaire Wizard'), + ('cardset_customization.html', 'PySol - Cardset Customization'), ] rules_files = [ diff --git a/html-src/index.html b/html-src/index.html index 2dd9c9f8..8b0ce34c 100644 --- a/html-src/index.html +++ b/html-src/index.html @@ -15,6 +15,7 @@

Misc