<The Ultra Maze-O-Matic System>
VERSION 0.99

By Cyan Helkaraxe and Bane Singollo
(c) 1999 All Rights Reserved

An Underground Zone Production for the SSRG

THIS PROGRAM IS WAVWARE!!! SEE END FOR DETAILS!!!

Cyan Helkaraxe:
manic@emulationzone.org
ICQ: 46685484
Website: The Underground Zone -- http://www.emulationzone.org/projects/cyan/

Bane Singollo:
sephiroth281@hotmail.com



History
=======

0.99:
-----
* First final release of Maze Editor.
* Many bugfixes, including SVGA mouse problem, and "Causeway" error when using
  the ZOOM OUT function on early graphics cards.
* Title screen.
* Cleanups, including fade in/out.
* Improved engine for faster execution on some slower machines.
* Better crashproofing

0.99b:
------
* First Maze Editor program, beta release.




Introduction
============
The aim of this program is to aid the editing of the Sonic the Hedgehog 1
special stages.
Previously impossible, this program is the first to successfully edit such
mazes with a high degree of accuracy.
Editing is achieved by editing the savestate file. Future versions will allow
permanent editing of the ROM to take place.




System Requirements
===================

Minimum
-------
HD Space: 2MB
RAM: 4MB
Processor: 486-66
Graphics: VGA
Mouse Required (with MS-DOS compatible drivers)

Recommended
---------
HD Space: 8MB
RAM: 8MB
Processor: Pentium 133MHz
Graphics: SVGA (VESA 2 compliant) 1024x768 256 color
Mouse Required (with MS-DOS compatible drivers)





How to use it
=============
Firstly, SHUT DOWN INTO MS-DOS!!! You can run this program under the
ever-crude Microsoft Windows graphical user interface shell, but the
performance will be greatly reduced.

If you are running in pure MS-DOS, then you will need to load your DOS MOUSE
DRIVERS. If you are unsure where these are stored on your machine, type the
following command from the C:\> prompt:
DIR MOUSE.COM /S
This will show you where the file MOUSE.COM is on your C: drive. Run this
program to activate the mouse. On some machines, simply typing MOUSE is all
that's required to load these drivers.

Now, you need to create a save state file using either the KGEN98 or Genecyst
emulators. Save the game just as the special stage maze appears on the screen
-- no sooner, but don't leave it too late, otherwise the game will be hard to
play.

You need to load the maze editor using the command line. Using the MS-DOS
prompt (with the emulator closed) type:
MAZE c:\emu\genecyst\saves\sonic1.gs1
replacing the last part of that command with the path to the save file.
If the maze editor is in the same directory as your saves, you need only type
the name of the save file for this last part.

If you cannot handle the power of DOS, then in Windows, you can DRAG the
savestate file onto the MAZE.EXE program file. This is the pathetic beginner's
approach.

You will be presented with the maze editor after viewing any possible warnings
and the title screen, where you will be able to make changes to the maze.

When you have finished, save your work to the savestate file by pressing
CTRL+S. WARNING!!! There is no UNDO feature as of yet, nor is there any way
to get the savestate file back to its original condition. Although maze
editing is not thought to have any connection with the game itself, there is
no guarantee that your save will not be damaged.

You can now exit the program with the ESC key.

Load the emulator again, then load the save. Observe! You will note that the
maze edit is successful!




More Detail
===========
Of course, there is much more you can do with the maze editor when you learn
how it works.
Here are the keyboard functions:

 SPACE: Find and jump to nearest Chaos Emerald
   ESC: Exit the program (discard changes since last save)
CTRL+S: Save your work to the savestate file
CTRL+L: Revert to your last save (load)
CTRL+O: Same as above (open)
CTRL+C: Clear the maze (warning! no revert!)

ALT as well as CTRL will function for all these commands.

Here are the mouse button functions:
  LEFT: Use tool
MIDDLE: Find and jump to nearest Chaos Emerald
 RIGHT: Activate popup menu


The popup menu is activated by pressing RIGHT. Unlike some popup menus, this
kind of menu requires the user to press AND HOLD the right mouse button to
keep the menu open. Releasing the button closes the menu.
The tool that the mouse pointer was over when the button was released is the
tool that gets selected. If the button was released while the pointer was NOT
over the popup menu, MOVE mode is selected.

Each tool has its own cursor. This is not the mouse pointer, but a small
box that follows the mouse pointer. This is used to highlight blocks on the
map in some way ready for modification.

Here are the different tools, with the cursor type, function and method of
obtaining it listed:

Tool:
MOVE

Cursor type:
Flickering green square that darkens blocks that it is moved over.

How to obtain:
From the popup menu, drag the pointer outside of the menu completely, and
release the right button.

Function:
Allows you to move blocks on the map from one place to another.
Left click and HOLD on the block you wish to move, then drag the block to the
new location, and release. If a block was already in your new location, it
will be overwritten by the new block.




Tool:
ERASE

Cursor type:
Flashing red square that hides blocks that it is moved over.

How to obtain:
From the popup menu, select the Robotnik (big round guy with a moustache) icon

Function:
Erases blocks from the map. LEFT click on the block you wish to erase.
By holding the mouse button down, you may "drag" the eraser across the map.
For ease of use and user safety, the screen is locked while this tool is in
use.




Tool:
DRAW

Cursor type:
Desired block flickering and merged with the background block.

How to obtain:
Select one of the three blocks from the viewing window on the popup menu.
Hold the mouse pointer over the arrows to scroll through all available blocks.

Function:
Draws blocks onto the map. LEFT click on the block / blank space you wish to
replace with the desired block. Like the eraser, this tool may also be dragged
and it also locks the screen while in use.




As well as the tools, there are also some other menu functions.

The eye icon next to the eraser tool is the ZOOM OUT function. This will
only work if your graphics card supports 1024x768 in 256 colors, otherwise
selecting this function just selects the move tool.
When selected, you are taken to another screen showing the entire maze.
You may exit this screen by pressing ESC or clicking the RIGHT mouse button.
If you click the LEFT mouse button on an area of the maze, then you will be
taken back to the editor with the view positioned over that area.

If your graphics card is not VESA 2.0 compliant, then due to the limitations
and bugs present in earlier graphics cards, the mouse pointer will be
disabled. However, the mouse buttons will still function correctly.

The F button will be used for the next version of this program, and in this
version its function is unknown, as not even the programmer has dared test
it.......

The icon next to the F button is also reserved for the next version of
this program, and selecting it here just selects the move tool.




Tips
====
There are many things that can make your maze editing career easier.
These are as follows:

* If using Windows, double click the save file, and from OPEN WITH, select
  the MAZE.EXE file. This will allow you to double-click that file type and
  automatically invoke the editor.

* To speed up scrolling through blocks, hold the LEFT mouse button down as
  well as the right. The speed will be vastly increased.

* Use the SPACE or MIDDLE button to jump to the Chaos Emerald if you get lost.
  Chaos Emeralds are often in the heart of a maze.

* By holding down CTRL or ALT while MOVING a block from one place to another,
  the block is not moved, but copied. Try it and see!

* By holding down CTRL or ALT while LEFT clicking with the DRAW tool, the
  block type you click is "picked up" and when you release the ALT/CTRL key,
  you will then be able to draw with that block!

* You'll note that if you try to bring the popup menu up off the edge of the
  screen, it will be scrolled on and your mouse pointer will also move.
  Learn not to resist this automatic movement to make maze editing easier.

* Save your work regularly!

* Saving a maze into a savestate doesn't affect the rest of the save.
  This can make possible many interesting features. Don't expect it to work
  with a save NOT from within the Sonic 1 special stage, though.

* If you save regularly, you can use the LOAD function as an UNDO.

* Use CLEAR to start fresh, but don't hit it accidentally!!!

* Use a batch file or shortcut to automate the command line process

* Use all the maze space! Sonic 1 originally had _huge_ mazes, but surveys
  suggested that this was too difficult to play. Therefore they cut the size
  down. However, the engine can still handle large mazes, so by all means
  re-create these huge mazes!

* Distribute your savestates!!! Let the world see what mazes you've created.
  The only condition is that you say that you used this editor to create it.






Copyrights and Credits
======================
This program is Copyright (c) 1999 Cyan Helkaraxe, all rights reserved.
You may NOT disassemble, reverse engineer, copy, modify, hack or otherwise
misuse this program.
You may NOT create a graphical maze editor even remotely based around this.
If your maze editor has one or more of the following features,
then you will have broken copyright laws and legal action shall be pursued:
1) uses a 320x200 or 320x240 graphics mode in 256 colors for editing
2) uses a 1024x768 graphics mode in 256 colors when in non-scroll mode
2) has a scrolling screen to move a small viewport around the maze
3) is mouse driven
4) edits the exact same address in the savestate as this program does
5) contains or copies this or part of this program in any way
6) has a popup menu activated by the RIGHT mouse button
7) has an interface like this program
8) contains or copies parts or all of the data from this program
9) runs in protected mode under the MS-DOS operating system, without the need
   for the Microsoft Windows graphical user interface shell, and complains if
   this is present
10) has the same number of blocks as this editor, or has the same block order
11) has a title screen that fades in and out at the start of the program
12) has the "block wobble" function
13) disables the mouse on < VESA 2.0 cards
14) requires MS-DOS mouse drivers
15) has the same version number as any version of this program

You MAY NOT insult this editor, or claim that your editor is better, safer,
or in any way superior to this editor.

You MAY NOT publish information about how to edit the Sonic 1 Special Stages
gained from examining how this program modifies the save, or any such method.

You MUST agree with the above terms if you use this program.





If you use this program for more than 2 minutes a week, then you are legally
required to REGISTER IT.
This program is WAVWARE. WAVWARE is copyright (c) 1999 Cyan Helkaraxe and
Bane Singollo, all rights reserved. You may NOT make your program WAVWARE
without permission from either Cyan Helkaraxe or Bane Singollo.

Registering THIS WAVWARE program is achieved by any of the following methods
(in order of preference: 1=most preferable):

1) Record a sound file (WAV, AIFF, RA, MP3, or whatever) of yourself saying
   "Whoa! Major Fender Bender!" in your best impersonation of Jaleel White
   (the voice artist for Sonic in the various cartoons).
   The file must be below 500K, so make sure it is short, and the sample
   rate isn't above 22050Hz. If you are not enthusiastic enough, then the
   registration is invalid.
   Send this file by either ICQ or E-Mail to Cyan Helkaraxe, or post it to
   your ISP and give me the URL. Alternatively, you should get in contact with
   me, and you should send me a floppy disk, CD, zip disk or ez-135 cartridge
   containing the audio file.

2) Record the above phrase onto CD, analogue audio cassette tape, minicassette
   minidisk, open reel 1/4" 3.5/7.2 IPS analogue 4-track tape, VHS / Betamax /
   HI-8 video tape (extra bonuses if you record a video of yourself saying it,
   too) and send it to me. Get in touch with me first for the address.

3) Dress up as an StH character (any universe) and send me a picture

4) Play the piano part from the Saturn version of Green Grove Zone by Richard
   Jacques, bar 78-86 (00:02:12:00 - 00:02:25:21) and send me a MIDI / MP3 /
   WAV. You must play it full speed to qualify, using a standard MIDI
   keyboard (no ARP function allowed).

5) Send me a copy of ALL SatAM episodes, or at a minimum 12 episodes picked
   by me. Same conditions as above apply.

6) Send me a Dreamcast and a copy of Sonic Adventure.

7) Send me a Knuckles plushie, or any other Sonic ones other than Sonic and
   Tails that exist.

8) Send me any other Sonic stuff.

9) Knit me a scarf in the shape of Robotnik's moustache.

10) Microwave a furbie, and record the sounds it makes. Send me the sounds,
    and optionally, the furbie.

11) DESTROY MICROSOFT!!!

12) Send me a Mario game that's been in the microwave for 25 minutes.

13) Destroy the Nintendo Headquarters.

14) Send me a 12" length of Bill Gates' large intestine

15) Kill someone for me. Contact me for details of who.

16) Kill a boy with a Fender guitar, and send me evidence
    (bonus marks if you are barely 17)

17) Delete Windows from your machine, and show me evidence.




Program
-------
Cyan Helkaraxe

Design
------
Cyan Helkaraxe
Bane Singollo

User interface program
----------------------
Cyan Helkaraxe

User interface design
---------------------
Cyan Helkaraxe
Bane Singollo

Graphics
--------
Bane Singollo
Cyan Helkaraxe
SEGA

Special Thanks
--------------
Cyan Helkaraxe
Bane Singollo
Andy Wolan
Rocket
Michael Devore
Richard Jacques






EOF
