diff --git a/docs/about.md b/docs/about.md
index 0359a4b..cc47baa 100644
--- a/docs/about.md
+++ b/docs/about.md
@@ -1,6 +1,6 @@
-# About Project: Doodle
+# About _Sketchy Maze_
-Project: Doodle is a "drawing-based maze game" themed around hand-drawn mazes
+**Sketchy Maze** is a "drawing-based maze game" themed around hand-drawn maps
on paper.
@@ -10,8 +10,8 @@ and then drag and drop pre-made "[doodads](doodads.md)" into your level for
interactive things like keys, doors and buttons.
This is an **early alpha build** of the game. Longer term it will include a couple
-built-in "single player campaigns" of multiple themed levels, but for now it
-just includes a couple example levels and the editor itself.
+of built-in "single player campaigns" of multiple themed levels, but for now it
+just includes a few example levels and the editor itself.
## Inspiration
@@ -27,7 +27,7 @@ you've got!)
When you're drawing with a pen and paper, the level can be anything you want.
You can draw a castle or a cave, place little gizmos and traps throughout the
-level (doors, keys, buttons and things) to create puzzles. Do you want the red
+level (doors, keys, buttons and things) and create puzzles. Do you want the red
pixels to mean "fire" and burn the player? Or do you want to decorate the tops
of "bloody" spikes with red? Either way, the 'fire' attribute on that color will
do the job and you can draw whatever shape you want for your level hazards.
diff --git a/docs/controls.md b/docs/controls.md
new file mode 100644
index 0000000..fadf2ae
--- /dev/null
+++ b/docs/controls.md
@@ -0,0 +1,21 @@
+# Controls
+
+**Sketchy Maze** currently uses a mouse and keyboard for inputs, but eventually
+will be usable from gamepad controllers, especially if it branches out and
+targets platforms other than desktop computers in the future.
+
+## During Gameplay
+
+While playing a level, the following keys are used to control the player character:
+
+* **Left** and **Right** arrow keys move the player left or right.
+* **Up** arrow to make the player jump.
+* **Space Bar** is used to "activate" certain doodads. Currently, only the
+ [Warp Doors](doodads.md#warp-doors) require deliberate activation; Buttons and
+ Switches activate _automatically_ when the player character (or other mobile
+ doodad) touches them.
+
+## Hotkeys
+
+See the [Hotkeys](hotkeys.md) page for shortcut keys, especially around the
+Level Editor feature.
diff --git a/docs/custom-doodads/edit-in-game.md b/docs/custom-doodads/edit-in-game.md
index d25c276..78805ca 100644
--- a/docs/custom-doodads/edit-in-game.md
+++ b/docs/custom-doodads/edit-in-game.md
@@ -1,6 +1,6 @@
# Drawing a Doodad In-Game
-Project: Doodle has support for drawing your custom doodad sprites in-game,
+Sketchy Maze has support for drawing your custom doodad sprites in-game,
although for now you may find it more comfortable to use an
[external image editor](edit-external.md) instead.
diff --git a/docs/custom-doodads/index.md b/docs/custom-doodads/index.md
index 67fa6fc..ea86f9e 100644
--- a/docs/custom-doodads/index.md
+++ b/docs/custom-doodads/index.md
@@ -1,10 +1,10 @@
# Creating Custom Doodads
-Project: Doodle is designed to be modder friendly and provides tools to help
+Sketchy Maze is designed to be modder friendly and provides tools to help
you create your own custom doodads to use in your levels.
You can draw the sprites for the doodad either in-game or using an external
-image editor. Then, you can program their logic using JavaScript to make them
+image editor. Then, you can program their behavior using JavaScript to make them
"do" stuff in-game and interact with the player and other doodads.
* Drawing your Doodad's Sprites
@@ -17,7 +17,7 @@ image editor. Then, you can program their logic using JavaScript to make them
Your copy of the game should have shipped with a `doodad` command-line tool
bundled with it. On Windows it's called `doodad.exe` and should be in the same
-folder as the game executable. On Mac OS, it is inside the .app bundle.
+folder as the game executable. On Mac OS, it is located inside the .app bundle.
The `doodad` tool provides a command-line interface to create and inspect
doodad and level files from the game. You'll need to use this tool, at the very
@@ -40,4 +40,4 @@ $ doodad install-script index.js custom.doodad
$ doodad show --script custom.doodad
```
-More info on the [`doodad` tool](../doodad-tool.md) here.
+More info on the [`doodad` program](../doodad-tool.md) here.
diff --git a/docs/custom-levels/index.md b/docs/custom-levels/index.md
index 001c95b..79bb9c6 100644
--- a/docs/custom-levels/index.md
+++ b/docs/custom-levels/index.md
@@ -33,7 +33,7 @@ You can change these settings later if you change your mind.
### Wallpaper
-The wallpaper affects the "theme" of your level. Project: Doodle is themed around
+The wallpaper affects the "theme" of your level. Sketchy Maze is themed around
hand-drawn mazes on paper, so the built-in themes look like various kinds of
paper.
@@ -119,6 +119,10 @@ Levels are designed to have a limited color palette, and this is your selection
of colors for the level or doodad you're drawing. You can click on "Add Color"
to create more rows as needed.
+> **NOTICE:** Modifying the color of an existing swatch on your Palette will also
+> change any pixels _already on your level_ to the new color. Drawings in this
+> game use an indexed palette, similar to GIF and some PNG images!
+
### Color Attributes
The **Attributes** column toggles behaviors on or off for this color. In the default
@@ -143,11 +147,12 @@ or `#0099FF` for light blue . Colors can
be entered in the following formats (the # prefix is actually optional):
* 3-digit hexadecimal: `#F0F` or `#09F`
-* 6-digital hexadecimal: `#0099FF` or `#FC390E`
-* 8-digit RGBA: `#0000FF99`
+* 6-digit hexadecimal: `#0099FF` or `#FC390E`
+* 8-digit RGBA: `#0000FF99` - a color with semi-transparency!
-You can also set the color to be **semi-transparent** by providing an
-additional two hex characters for its alpha channel:
+You can set the color to be **semi-transparent** by providing the 8-digit RGBA
+color code; the extra two digits control the transparency between 00 (fully
+invisible) and FF (fully opaque).
@@ -163,17 +168,18 @@ pressing the `d` key, the Doodads window will appear in the level editor:
Doodads are objects you drag and drop into your level to add interactive elements
such as enemies and buttons. Mousing over a doodad will tell you its name, and
-the pager buttons at the bottom can show more options.
+the pager buttons at the bottom can show more options. See the
+[list of built-in doodads](../doodads.md) for details on what each one does.
Click and drag a doodad from the Doodads window onto your level to place it.
-When the **Doodad Tool** is active on the left toolbar, when you mouse over an
+While the **Doodad Tool** is active on the left toolbar, when you mouse over an
existing doodad on your level, and orange box will appear around it. You may
click and drag to move this doodad somewhere else. Right-click it to remove it
from your level.
-* Left click: move a doodad somewhere else on your level.
-* Right click: remove the doodad from your level.
+* Left click: **move a doodad** somewhere else on your level.
+* Right click: **removes the doodad** from your level.
Doodads provide various useful features to your level:
@@ -188,6 +194,14 @@ Doodads provide various useful features to your level:
To connect buttons to control doors, use the
```
-### Creating a Doodad from PNG images
+#### Creating a Doodad from PNG images
Suppose you have PNG images named "frame0.png" through "frame3.png" and want
to create a doodad from those images. This will convert them to the doodad
@@ -105,13 +110,13 @@ doodad convert frame0.png frame1.png frame2.png frame3.png custom.doodad
doodad convert --tag color=blue frame{0,1,2,3}.png custom.doodad
```
-### Convert a level to a PNG image
+#### Convert a level to a PNG image
```bash
doodad convert my.level output.png
```
-### Create a level from a PNG image
+#### Create a level from a PNG image
```bash
doodad convert level.png output.level
diff --git a/docs/doodads.md b/docs/doodads.md
index 384c8ac..1f08178 100644
--- a/docs/doodads.md
+++ b/docs/doodads.md
@@ -1,123 +1,287 @@
-# Doodads
+# Built-in Doodads
-Project:Doodle comes with several built-in doodads that you can use in your
+Sketchy Maze comes with several built-in doodads that you can use in your
levels. You may also [create your own](custom-doodads/index.md) custom doodads
and program them to do whatever you want!
+Doodads are available in the Level Editor by clicking on the
+
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+```
+
+### github.com/urfave/cli
+
+```
+MIT License
+
+Copyright (c) 2016 Jeremy Saenz & Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```
+
+### github.com/veandco/go-sdl2
+
+```
+Copyright (c) 2013, Go-SDL2 Authors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+ * Neither the name of Go-SDL2 nor the names of its contributors may be
+used to endorse or promote products derived from this software without specific
+prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+```
+
+### github.com/vmihailenco/msgpack
+
+```
+Copyright (c) 2013 The github.com/vmihailenco/msgpack Authors.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+ * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+```
diff --git a/docs/profile-directory.md b/docs/profile-directory.md
index a3cc9e8..ee331d5 100644
--- a/docs/profile-directory.md
+++ b/docs/profile-directory.md
@@ -1,6 +1,6 @@
# Profile Directory
-Project: Doodle stores your user-created levels and custom doodads in your
+Sketchy Maze stores your user-created levels and custom doodads in your
operating system's profile directory for your account.
This will typically be found at the following locations based on your platform:
diff --git a/mkdocs.yml b/mkdocs.yml
index a0c6dc0..f08d51b 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,16 +1,18 @@
-site_name: "Project: Doodle Guidebook"
+site_name: "Sketchy Maze: Guidebook"
use_directory_urls: false
nav:
- Home: index.md
- About: about.md
+ - Controls: controls.md
- "Creating Levels": custom-levels/index.md
- "Built-in Doodads": doodads.md
- "Creating Doodads": custom-doodads/index.md
- "Drawing Doodads": custom-doodads/edit-in-game.md
- "Doodad Scripts": custom-doodads/scripts.md
- "Shortcut Keys": hotkeys.md
- - "`doodad` Tool": doodad-tool.md
+ - "`doodad` Program": doodad-tool.md
- "Hacking": hacking.md
+ - "Open Source Licenses": licenses.md
theme: readthedocs
markdown_extensions:
- toc:
**Link Tool.**
+### How do I remove a doodad from my level?
+
+Select the 
**Doodad Tool**
+to adjust the doodads already on your level.
+
+To remove a doodad: either **right-click on it** or else drag it from your level
+back into the Doodads window and release, and it will be gone from your level.
+
## Link Tool
The