                                  SunEd V2.33
                                  -----------

SunEd is a save game editor for VOTI's game SunBurst. It allows you to change
almost everything about a saved game, so is the perfect tool for cheating at the
game ;)

Although it shouldn't corrupt save games, it's best to keep a backup of any
games you modify since there are many unknown bits of data in the files - I
won't accept any responsibility for any damage the program causes.


Using SunEd
-----------

First, make sure RISC OS has 'Seen' SunBurst, since SunEd reads the ship names
from the SunBurst directory. If SunBurst has not been seen, SunEd will still
work, but none of the ship names will be displayed.

Run SunEd, and its icon should appear on the iconbar. Drag any save game file
to the icon to begin editing. This should open the general settings window,
which, as its name suggests, allows you to edit the general settings. Starting
from the top-left, the fields are as follows:

Ship class: Click on either the text box or popup menu button to choose from 6
    ship classes (Shuttle, Sirius, Wing, Nova, Kosmos or Magnx). If 'Unknown or
    alien?' is displayed, then it's a ship type which the editor doesn't know
    about. In this case, it's best not to edit the ship type as it may corrupt
    the save game. Also changing to/from a Magnx has been known to cause
    problems...
Ship name: Click on either the text box or popup menu button to reveal a nice
    long list of ship names. Don't worry about the blank spaces near the bottom,
    they're meant to be there. As far as I know any name you select should work
    OK in SunBurst. For some strange reason though, 'SHARP END' and 'UNTIMELY
    END' are listed as 'SHARP    EN' and 'UNTIMELY    EN'...
Kills: Edit this to change the number of kills you have made
Level: Edit this to change your skill level.
Credits: Edit this to change how much money you have
Jump speed: This is how many sectors your ship moves when it performs a
            subspace jump.
S&D debt: This is how much money you owe Shotgun & Dribble
Shield charge: Enter the shield charge here (0-100)
Laser charge: Enter the laser charge here (0-30)
Location: Here you can select the system you are in (From the top box/button),
          and the location within the system. Selecting somewhere from the
          bottom box/button will allow you to dock your ship at a station in the
          current system. If either of the boxes read 'Unknown', then it might
          be best to leave them alone. Note that changing to/from the alien
          system won't infest the game with aliens - there is some unknown
          variable which controls that.
Missiles: Enter into these boxes how many of each missile you want. The buttons
          on the left allow you to change the currently selected missile
Ship systems: This allows you to upgrade your ships systems. The left most
              buttons provide the worst performance, the right most the best.
              For the ECM, the buttons provide the following (from left to
              right): No ECM, destroy all, destroy foe, seduce foe.
Misc: This selection of buttons allows you to equip your ship with the
      miscellaneous items.
Cargo button: This opens the cargo window. In the cargo window you can change
              the cargo hold size, and the amount of each type of cargo you
              have. You can over fill you hold if you want, but it may cause
              problems.
Messages: This opens the messages window, allowing you to add/remove messages to
          the list of ones you have received. Note that this will not always
          affect your mission status, available scanner targets, etc, so use at
          your own risk.
Ship damage: This opens the damage window. For each of the seven ship systems,
             a damage value and some status text will be displayed. The status
             text will change as you change the amount of damage; 0 is OK, below
             256 is repairable, below 640 is crippled, and anything else is dead

Pressing menu over anything will display the SunEd main menu, which has three
self explanatory options - Info, save or quit. If you have closed the general
settings window, just click on the SunEd icon on the iconbar to get it back.


History
-------

Note that this is in chronological order, meaning that the version numbers jump
around a bit...

< V1.00 (Sometime near Christmas 1998)
           Original single tasking BASIC version, with around 40 different
           values available to change. Had some nice colour coding to make
           editing simpler. No copies of this version are known to exist...
V1.00 (About 2nd January 1999)
           First numbered version of the editor, with 53 different values to
           change.
V2.00 (About 6th January 1999)
           First attempt at a WIMP version. I think it was based around V1.00,
           but I'm not sure. It used the EventShell BASIC library, but problems
           with the file save code in EventShell stopped progress :( There were
           49 values to edit
V1.20 (About 6th February 1999)
           Went back to the BASIC version, and found some more stuff to edit -
           now 61 values. First known version to allow ship name editing. A copy
           of it worked its way onto Acorn User CD 9.
V2.00 (2nd January 2002)
           Started work on my own WIMP library for C, and decided to do a
           desktop version of SunEd to test it out. No new data to edit though.
           Templates were heavily modified ones from the original V2.00, with
           extra fields added for the new data.
V2.10 (3rd January 2002)
           Improved on V2.00 a bit - added range checking for missiles, cargo
           and ship location. Also made the windows position themselves properly
           when opened, and made sure adjust-clicking on the ship systems icons
           wouldn't cause none to be selected. Improved file loading a bit so
           that corrupt ship system data wouldn't muck up the display, and
           corrected a template bug that stopped you from entering data in the
           missiles boxes. Also fiddled with the wimpslot a bit to bring it down
           from 640K.
V2.15 (5th January 2002)
           Made a small update to the WIMP library, so decided to add a few more
           features to SunEd as well. You can now change the shield charge,
           laser charge and the currently selected missile. Also fiddled with
           the 'general' window a bit to fit in the new data. It's getting quite
           cramped, so I may soon have to redesign it completely...
V2.30 (10th January 2002)
           Added the 'messages' window to allow you to change your
           mission/message status. Missions are not always directly related to
           messages, but I may soon have cracked how SunBurst stores the mission
           status...
V2.31 (9th February 2003)
           This is essentially the same as the (unreleased) 2.30, but it's been
           lying round on my hard disk for almost a year now; don't be surprised
           if there are a couple of bugs/misfeatures, since I can't remember
           what state of development I left it in.
V2.32 (10th July 2003)
           Recompiled it to be 32bit compatible, for no particular reason. Also
           fixed a bug in the WIMP library, to stop it letting the program start
           while outside the WIMP.
V2.33 (28th August 2018)
           Source dusted off and recompiled using GCC 4.7.4 r3. App repackaged
           for PackMan distribution.


Future developments...
----------------------

So far, I only know the definite meaning of about 26% of the save game file.
There are plenty of other values for me to fiddle with, some more useful than
others. If I can find any useful data, there may be a new version of SunEd out
soon. Most likely it will allow you to change your mission status, and hopefully
be able to switch to the Magnx & alien ship without any nasty crashes.


Legal
-----

SunEd is Copyright(c)2018, Jeffrey Lee
Allrightsreserved.

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 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.


Contact
-------

You can email me@phlamethrower.co.uk, or visit my website:
http://www.phlamethrower.co.uk/

- Jeffrey Lee
