mirror of
https://github.com/shlomif/PySolFC.git
synced 2025-04-05 00:02:29 -04:00
Add FAQ to the in-app documentation
This commit is contained in:
parent
cadf8b2084
commit
ff9cc5e98c
5 changed files with 70 additions and 26 deletions
64
html-src/faq.html
Normal file
64
html-src/faq.html
Normal file
|
@ -0,0 +1,64 @@
|
||||||
|
<h1>FAQ</h1>
|
||||||
|
<h2>The animation is too slow...</h2>
|
||||||
|
<p>
|
||||||
|
Unfortunately the Tcl/Tk toolkit lacks a sprite concept, so
|
||||||
|
there is a lot of (invisible double-buffered) redraw going on
|
||||||
|
when dragging cards around.
|
||||||
|
<p>
|
||||||
|
Disabling <i>Card shadow</i>, <i>Shade legal moves</i>,
|
||||||
|
background table tiles and sound will somewhat improve the display speed.
|
||||||
|
|
||||||
|
<h2>The table tiles look strange</h2>
|
||||||
|
<p>
|
||||||
|
Background table tiles should only be enabled when using
|
||||||
|
a true-color video mode - otherwise they may look bad
|
||||||
|
because of dithering.
|
||||||
|
<p>
|
||||||
|
BTW, you can add your own background tiles by copying the images
|
||||||
|
to the main <i>data/tiles</i> or your home <i>~/.PySolFC/tiles</i> directory.
|
||||||
|
<!-- They must be in GIF or PPM format. -->
|
||||||
|
|
||||||
|
<h2>My antivirus app says the Windows installer contains a virus.</h2>
|
||||||
|
<p>
|
||||||
|
We have been asked about the fact that some anti viruses, including those
|
||||||
|
on <a href="https://www.virustotal.com/">VirusTotal</a>, have identified the Microsoft
|
||||||
|
Windows downloads as containing malware. What we know is that they are generated from
|
||||||
|
the <a href="https://en.wikipedia.org/wiki/Free_and_open-source_software">open source</a>
|
||||||
|
source code by <a href="https://www.appveyor.com/">AppVeyor</a>, are checked using
|
||||||
|
VirusTotal before they are uploaded, and at that point were considered to be malware clean.
|
||||||
|
<p>
|
||||||
|
However, as time passes, they seem to accumulate classifyings as containing malware
|
||||||
|
in what appears to be <a href="https://en.wikipedia.org/wiki/False_positives_and_false_negatives">false positives</a>. So we believe the downloads are nonetheless safe and free of
|
||||||
|
malware.
|
||||||
|
<p>
|
||||||
|
Furthermore, note that we believe that many anti-malware applications are harmful
|
||||||
|
by themselves, and that they are all an incomplete (non-)solution to an
|
||||||
|
issue that does not exist in <a href="https://en.wikipedia.org/wiki/Linux#Desktop">Linux</a> and the <a href="https://en.wikipedia.org/wiki/List_of_BSD_operating_systems">BSDs operating systems</a>.
|
||||||
|
<p>
|
||||||
|
For more information, see:
|
||||||
|
<ol>
|
||||||
|
<li><a href="https://sourceforge.net/p/pysolfc/discussion/503709/thread/d841b6a1/">Forum discussion</a></li>
|
||||||
|
<li><a href="http://linuxmafia.com/~rick/faq/">Viruses on Linux</a></li>
|
||||||
|
<li><a href="https://www.mail-archive.com/wikimedia-l@lists.wikimedia.org/msg30001.html">Discussion about anti-viruses.</a></li>
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
<h2>I received an error that there is no module named "formatter".</h2>
|
||||||
|
<p>
|
||||||
|
This error occurs if you're trying to run an older version of PySolFC
|
||||||
|
with Python 3.10. If you are using Python 3.10 or later, please upgrade your
|
||||||
|
version of PySolFC to 2.14.0 or later - older versions are not compatible with
|
||||||
|
Python 3.10.
|
||||||
|
<p>
|
||||||
|
If you are getting your copy from your Linux distribution's package manager,
|
||||||
|
please contact the people who maintain the packages for your distribution.
|
||||||
|
You can always get the latest version from the PySolFC website or from
|
||||||
|
Flathub.
|
||||||
|
|
||||||
|
<h2>It won't let me deal more cards in Spider.</h2>
|
||||||
|
<p>
|
||||||
|
When playing Spider, you are not allowed to deal more cards if there are any
|
||||||
|
empty piles. If there aren't enough cards left to put one in each pile, the
|
||||||
|
game is lost. Part of the game is planning ahead when to deal more cards to
|
||||||
|
avoid this situation.
|
||||||
|
<p>
|
||||||
|
If you want a variation without this rule, you can play Relaxed Spider instead.
|
|
@ -46,6 +46,7 @@ fix_gettext()
|
||||||
files = [
|
files = [
|
||||||
('credits.html', 'PySol Credits'),
|
('credits.html', 'PySol Credits'),
|
||||||
('credits_old.html', 'PySol Credits'),
|
('credits_old.html', 'PySol Credits'),
|
||||||
|
('faq.html', 'PySol - FAQ'),
|
||||||
('ganjifa.html', 'PySol - General Ganjifa Card Rules'),
|
('ganjifa.html', 'PySol - General Ganjifa Card Rules'),
|
||||||
('general_rules.html', 'PySol - General Rules'),
|
('general_rules.html', 'PySol - General Rules'),
|
||||||
('glossary.html', 'PySol - Glossary'),
|
('glossary.html', 'PySol - Glossary'),
|
||||||
|
|
|
@ -55,27 +55,6 @@ disable certain features as they would be trivial otherwise.
|
||||||
The logic involved is not too clever on purpose (i.e. it does not consult the hint system).
|
The logic involved is not too clever on purpose (i.e. it does not consult the hint system).
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h2>The animation is too slow...</h2>
|
|
||||||
<p>
|
|
||||||
Unfortunately the Tcl/Tk toolkit lacks a sprite concept, so
|
|
||||||
there is a lot of (invisible double-buffered) redraw going on
|
|
||||||
when dragging cards around.
|
|
||||||
<p>
|
|
||||||
Disabling <i>Card shadow</i>, <i>Shade legal moves</i>,
|
|
||||||
background table tiles and sound will somewhat improve the display speed.
|
|
||||||
|
|
||||||
|
|
||||||
<h2>The table tiles look strange</h2>
|
|
||||||
<p>
|
|
||||||
Background table tiles should only be enabled when using
|
|
||||||
a true-color video mode - otherwise they may look bad
|
|
||||||
because of dithering.
|
|
||||||
<p>
|
|
||||||
BTW, you can add your own background tiles by copying the images
|
|
||||||
to the main <i>data/tiles</i> or your home <i>~/.PySolFC/tiles</i> directory.
|
|
||||||
<!-- They must be in GIF or PPM format. -->
|
|
||||||
|
|
||||||
|
|
||||||
<h2>Some notes about scoring</h2>
|
<h2>Some notes about scoring</h2>
|
||||||
<p>
|
<p>
|
||||||
<ul type="disc">
|
<ul type="disc">
|
||||||
|
|
|
@ -19,9 +19,10 @@
|
||||||
<li> <a href="cardset_customization.html">Cardset Customization</a>
|
<li> <a href="cardset_customization.html">Cardset Customization</a>
|
||||||
<li> <a href="plugins.html">Plugins</a>
|
<li> <a href="plugins.html">Plugins</a>
|
||||||
</ul>
|
</ul>
|
||||||
<h2>Misc</h2>
|
<h2>About</h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li> <a href="news.html">What's new?</a>
|
<li> <a href="news.html">What's new?</a>
|
||||||
|
<li> <a href="faq.html">FAQ</a>
|
||||||
<li> <a href="report_bug.html">Report a Bug</a>
|
<li> <a href="report_bug.html">Report a Bug</a>
|
||||||
<li> <a href="license.html">PySol license terms</a>
|
<li> <a href="license.html">PySol license terms</a>
|
||||||
<li> <a href="credits.html">PySol credits</a>
|
<li> <a href="credits.html">PySol credits</a>
|
||||||
|
|
|
@ -1,10 +1,9 @@
|
||||||
<h1>Report a Bug</h1>
|
<h1>Report a Bug</h1>
|
||||||
<p>
|
<p>
|
||||||
Before you report a bug, please verify that you are running
|
Before you report a bug, please verify that you are running
|
||||||
the latest version of PySolFC, and also check the PySolFC site's
|
the latest version of PySolFC. Also, check the
|
||||||
<a href="https://pysolfc.sourceforge.io/faq.html">FAQ page</a>,
|
<a href="faq.html">FAQ</a>, and issues previously reported
|
||||||
and issues previously reported on GitHub, to ensure that the bug
|
on GitHub, to ensure that the bug was not previously reported.
|
||||||
was not previously reported.
|
|
||||||
<p>
|
<p>
|
||||||
If you found a bug in PySolFC, the best place to report it
|
If you found a bug in PySolFC, the best place to report it
|
||||||
is on GitHub. To do so, create an issue at
|
is on GitHub. To do so, create an issue at
|
||||||
|
|
Loading…
Add table
Reference in a new issue