Skip to content

Commit

Permalink
add HTML documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasTheSpaceFox committed Jun 3, 2017
1 parent 8b55352 commit 26588a5
Show file tree
Hide file tree
Showing 14 changed files with 543 additions and 2 deletions.
209 changes: 209 additions & 0 deletions docs/coreobjects.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,209 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Desutezeoid HTML documentation</title>
</head>
<body>
<table width="100%" cellspacing="0" cellpadding="2" border="0">
<tbody>
<tr align="center">
<td valign="top" bgcolor="#000044">
<h1><font color="#ffffff">Desutezeoid</font></h1>
</td>
</tr>
<tr>
<td valign="top"><a href="index.html">Home</a> - <a
href="keyidsandforks.html">Keyids &amp; forking</a> - <b>Core
objects</b><br>
</td>
</tr>
<tr>
<td valign="top">core objects are the main way of showing
something on the screen.<br>
<br>
naturally they belong in the "core" section of pages.<br>
<br>
they come in two classes:<br>
<br>
clickable core objects like "img", "label", and "box"<br>
UNclickable core objects like "text"<br>
<br>
clickable core objects have a special child element called
"act" the act tag has 2 attributes: "type" and "ref"<br>
"type" referrs to what Desutzeoid should do when the item is
clicked:<br>
<i>type="none" </i>means do absolutely nothing. no sounds,
no onclick keyids.<br>
<i>type="key"</i> means do everything but parse page
switching.<br>
<i>type="iref" </i>does everything, including use the value
of "ref" as the page XML filename to switch to. <br>
<i>type="quit"</i> presents the quit dialog.<br>
<br>
<br>
clickable core objects also have some common attributes:<br>
("0" is used a as a placeholder. like it states in keyids
and forking, "0" is not a real keyid and is ignored by
Desutezeoid.)<br>
<i>keyid="0" </i>add a keyid on click<br>
<i>takekey="0" </i>take a keyid on click<br>
<i>onkey="0" </i>only activate this core object if a keyid
is present ("text" supports this)<br>
<i>offkey="0"</i> only activate this core object if a keyid
NOT present ("text" supports this)<br>
<i>hoverkey="onhov1"&nbsp; </i>This nifty keyid attribute
causes the specified keyid to be actively removed if the
mouse is not over the object, and vice versa if it is.<br>
<i>sfxclick="1"</i> set this to "1" if you want to use an
on-click sound.<br>
<i>sound="mip.ogg"</i> this is used to specify the on-click
sound when its enabled with the sfxclick attribute.<br>
List of core objects<br>
<table width="100%" cellspacing="0" cellpadding="2"
border="1">
<tbody>
<tr>
<td valign="top" bgcolor="#ccccff">XML code<br>
</td>
<td valign="top" bgcolor="#ccccff">Description<br>
</td>
</tr>
<tr>
<td width="60%" valign="top">&lt;label x="0" y="230"
size="24" BGCOLOR="#000088" FGCOLOR="#FFFFFF"
keyid="predelta"&gt;<br>
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp; &lt;con&gt;or
here!&lt;/con&gt;<br>
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp; &lt;act type="iref"
ref="test1.xml"/&gt;<br>
&lt;/label&gt;<br>
&lt;label x="300" y="200" size="24" transp="1"
FGCOLOR="#FFFFFF" onkey="delta"&gt;<br>
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp; &lt;con&gt;:o Where
did this come from? :)&lt;/con&gt;<br>
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp; &lt;act
type="none"/&gt;<br>
&lt;/label&gt;<br>
&lt;label x="0" y="0" size="16" sfxclick="1"
sound="mip.ogg"&gt;<br>
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp; &lt;con&gt;click me
for a sound fx!&lt;/con&gt;<br>
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp; &lt;act
type="key"/&gt;<br>
&lt;/label&gt;<br>
<br>
</td>
<td valign="top">Labels use pygame's builtin text
rendering capacity to, well, generate labels. Use
BGCOLOR and FGCOLOR to specify the colors, also set
transp="1" to have text with a transparent
background. also use "size" to specify text size<br>
<br>
the con child element is used to define the text to
be used as the label.<br>
</td>
</tr>
<tr>
<td width="60%" valign="top">&lt;text x="10" y="30"
size="20" transp="1" FGCOLOR="#000000"&gt;This is an<br>
example of the text core object.<br>
interesting eh?&lt;/text&gt;<br>
</td>
<td valign="top">this nifty text tag supports the
color, transparency, and text size of the label tag,
but is used to show paragraphs of text. though, it
does not support click events.<br>
</td>
</tr>
<tr>
<td width="60%" valign="top">&lt;img x="300" y="100"
onkey="timeloop1"&gt;<br>
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;
&lt;con&gt;no-tr-animtest1a.png&lt;/con&gt;<br>
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp; &lt;act
type="none"/&gt;<br>
&lt;/img&gt;<br>
</td>
<td valign="top">ahh the img tag. its by far the most
useful of the bunch, as any raster image on screen
is shown using it. <br>
<br>
the con attribute specifies the filename.<br>
<br>
speaking of filenames, if the filename is prefixed
with "no-tr", or the filettype is a jpeg image,
Desutezeoid will optimize the image with alpha
disabled, else it will optimize it with alpha
enabled.<br>
<br>
naturally there are some extra attributes:<br>
<br>
vscroll="1" scrolls the image vertically by the
specified number of pixels each frame. use negative
values for the opposing direction <br>
hscroll="1" scrolls the image horizontally by the
specified number of pixels each frame. use negative
values for the opposing direction.<br>
<br>
mouseh="2" and mousev="2":<br>
that nifty pair of horizontal and vertical
attributes allows an img tag to move based on mouse
coordinates. <br>
1= follow mouse, aligned to top left corner of image<br>
2= follow mouse, aligned to center of image,<br>
3= follow a "screen inversion" of the mouse
position, aligned to the center of the image. useful
for wide panoramic views (the test program has some
examples).<br>
<br>
hovpic="1"<br>
this nifty attribute enables a copy of the img con
child tag called altcon, and uses it when the mouse
is hovering over the img object.<br>
<br>
<br>
<br>
</td>
</tr>
<tr>
<td width="60%" valign="top">&lt;box x="300" y="200"
sizex="40" sizey="60" COLOR="#FF0000" alpha="60"
hovalpha="150" onhov="1" HOVCOLOR="#FF0000"&gt;<br>
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp; &lt;act
type="none"/&gt;<br>
&lt;/box&gt;<br>
&lt;box x="295" y="44" sizex="175" sizey="123"
alpha="0" hoverkey="sometip" keyid="someclick"&gt;<br>
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp; &lt;act
type="key"/&gt;<br>
&lt;/box&gt;<br>
</td>
<td valign="top">ahh the ever useful box. the primary
use of this is creating "invisible" clickable core
objects, but also has COLOR, alpha, hovalpha, and
HOVCOLOR, to have some basic highlighting action. <br>
set onhov="1" to enable the separate HOVCOLOR and
hovalpha attributes.<br>
<br>
setting alpha="0" disables COLOR altogether.<br>
<br>
use sizex and sizey, to specify size. <br>
<br>
tip: the image editor, gimp shows the position and
size of rectangle selections in the tool settings
tab. using this trick on your backdrop (if its at
0,0) can help in adding box objects.<br>
</td>
</tr>
</tbody>
</table>
<br>
<br>
</td>
</tr>
</tbody>
</table>
<br>
</body>
</html>
Binary file added docs/dzu-flashlight.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/dzu-pan.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/dzuscreenshot1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
76 changes: 76 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>

<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Desutezeoid HTML documentation - Home</title>
</head>
<body>
<table width="100%" cellspacing="0" cellpadding="0" border="0">
<tbody>
<tr align="center">
<td valign="top" bgcolor="#000044">
<h1><font color="#ffffff">Desutezeoid</font></h1>
<font color="#ffffff">An XML-driven python/pygame based
point and click game engine.</font><br>
</td>
</tr>
<tr>
<td valign="top"><b>Home</b> - <a href="keyidsandforks.html">Keyids
&amp; forking</a> - <a href="coreobjects.html">Core
objects</a><br>
</td>
</tr>
<tr>
<td valign="top">
<table width="100%" cellspacing="0" cellpadding="2"
border="0">
<tbody>
<tr>
<td width="50%" valign="top" bgcolor="#ccccff">What Is
Desutezeoid? Its an XML Driven, Point and click game
engine written in python and pygame.<br>
<br>
it features <br>
<ul>
<li>sound support</li>
<li>music support</li>
<li>image support</li>
<li>an XML "page-centric" design<br>
</li>
<li>an object oriented, xml-based logic system</li>
</ul>
<a
href="https://github.com/ThomasTheSpaceFox/Desutezeoid">Desutezeoid
on GitHub</a><br>
<br>
Notice: the test/example program included with
Desutezeoid has plenty of examples, as well as
detailed comments on various things not covered
here.<br>
</td>
<td valign="top">latest developments:<br>
<ul>
<li>v1.5.0 brings some speed improvements and a
unified rendering order allowing core objects of
different types to be layered in new ways.<br>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
<img src="dzu-pan.jpg" title="moving Panoramic example"
alt="moving Panoramic example" width="400" height="300"><img
src="dzuscreenshot1.jpg" title="Desutezeoid Welcome
screen" alt="Desutezeoid Welcome screen" width="400"
height="300"><img src="dzu-flashlight.jpg"
title="Flashlight effect" alt="Flashlight effect"
width="400" height="300"><br>
</td>
</tr>
</tbody>
</table>
<br>
</body>
</html>
Loading

0 comments on commit 26588a5

Please sign in to comment.