summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBen Boeckel <MathStuf@gmail.com>2009-09-06 17:05:26 -0400
committerBen Boeckel <MathStuf@gmail.com>2009-09-06 17:05:26 -0400
commit1d668c894c851ade3eae96d75607ad56c79efc59 (patch)
tree8ca02a623d5a2b5efe45b68bdf63020a182d0653
parentc13850ce47851623dd3b4f69f543462785d00141 (diff)
downloadsigen-1d668c894c851ade3eae96d75607ad56c79efc59.tar.gz
sigen-1d668c894c851ade3eae96d75607ad56c79efc59.tar.xz
sigen-1d668c894c851ade3eae96d75607ad56c79efc59.zip
Add rudimentary rules documentation
-rw-r--r--sigmodr/doc/editing-rules.docbook170
-rw-r--r--sigmodr/doc/editing-rules.pngbin0 -> 42749 bytes
-rw-r--r--sigmodr/doc/index.docbook2
3 files changed, 172 insertions, 0 deletions
diff --git a/sigmodr/doc/editing-rules.docbook b/sigmodr/doc/editing-rules.docbook
new file mode 100644
index 00000000..c573a68f
--- /dev/null
+++ b/sigmodr/doc/editing-rules.docbook
@@ -0,0 +1,170 @@
+<chapter id="editing-rules">
+
+<chapterinfo>
+
+<authorgroup>
+
+<author>
+&Ben.Boeckel;
+&Ben.Boeckel.mail;
+</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<date>2009-08-08</date>
+
+</chapterinfo>
+
+<title>Rules</title>
+
+<sect1 id="rules-description">
+
+<title>Description</title>
+
+<para>The rules for a &sigmod; set limits on the values within the engine. These
+values include how many items may be stored in the computer and carried by the
+player, how much storage for creatures there are on the computer, the maximum
+number of creatures on a team, and ther similar values. These are importatnt to
+set early since many other values may become invalid if the limits change.
+</para>
+
+</sect1>
+
+<sect1 id="rules-values">
+
+<title>Values</title>
+
+<screenshot id="screen-rules">
+<screeninfo>Rules widget</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="editing-rules.png" format="PNG" />
+</imageobject>
+<textobject>
+<phrase>Rules widget</phrase>
+</textobject>
+</mediaobject>
+</screenshot>
+
+<para>Here is a list of the values and their description:</para>
+
+<variablelist>
+
+<varlistentry>
+<term>Genders</term>
+<listitem>
+<para>If checked, male and female versions of creatures may be distinguished
+from each other.</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>Breeding</term>
+<listitem>
+<para>If enabled, creatures will be able to generate an offspring with stats and
+moves determined from its parents. This flag only matters if creatures can have
+genders.</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>Critical domains</term>
+<listitem>
+<para>If enabled, critical hits will be based upon a random number being within
+a certain range based upon the circumstances. If not, the creature&apos;s Speed
+will be used.</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>Split special</term>
+<listitem>
+<para>If enabled, the Special stat will be split into physical and elemental
+stats.</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>Split special DV</term>
+<listitem>
+<para>If enabled, the base <quote>gene</quote> for the physical and elemental
+Special stats will be different. If not, one gene will control both stats. This
+flag only matters if the Special stat is split at all.</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term></term>
+<listitem>
+<para></para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term></term>
+<listitem>
+<para></para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term></term>
+<listitem>
+<para></para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term></term>
+<listitem>
+<para></para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term></term>
+<listitem>
+<para></para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term></term>
+<listitem>
+<para></para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term></term>
+<listitem>
+<para></para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term></term>
+<listitem>
+<para></para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term></term>
+<listitem>
+<para></para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term></term>
+<listitem>
+<para></para>
+</listitem>
+</varlistentry>
+
+</variablelist>
+
+</sect1>
+
+</chapter>
diff --git a/sigmodr/doc/editing-rules.png b/sigmodr/doc/editing-rules.png
new file mode 100644
index 00000000..d691866c
--- /dev/null
+++ b/sigmodr/doc/editing-rules.png
Binary files differ
diff --git a/sigmodr/doc/index.docbook b/sigmodr/doc/index.docbook
index 26249953..6b24e485 100644
--- a/sigmodr/doc/index.docbook
+++ b/sigmodr/doc/index.docbook
@@ -13,6 +13,7 @@
<!ENTITY sigmodr-validation SYSTEM "validation.docbook" >
<!ENTITY sigmodr-editing-beginning SYSTEM "editing-beginning.docbook" >
<!ENTITY sigmodr-editing-sigmod SYSTEM "editing-sigmod.docbook" >
+<!ENTITY sigmodr-editing-rules SYSTEM "editing-rules.docbook" >
<!ENTITY sigmodr-reporting-bugs SYSTEM "reporting-bugs.docbook" >
<!ENTITY sigmodr-glossary SYSTEM "glossary.docbook" >
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
@@ -63,6 +64,7 @@ engine.</para>
&sigmodr-validation;
&sigmodr-editing-beginning;
&sigmodr-editing-sigmod;
+&sigmodr-editing-rules;
&sigmodr-reporting-bugs;
&sigmodr-glossary;