Author....: SEE BELOW UNDER CREDITS / LEGAL STUFF.
Date......: November 2, 2015
Platform..: TI-84+CSE

____________
: WARNING! |
-----------/
THE FOLLOWING SERIES OF DOTS MUST FIT ON ONE LINE.
.............................................................................
DO NOT VIEW THIS DOCUMENT USING WORD-WRAP.

______________________
: WHAT IS THIS GAME? |
---------------------/

It's a game about a frog jumping around on lilipads and other stuff.
The point of the game is to clear the game board by way of landing
on each lilipad.

Your frog may only move left, forward, or right.
You cannot move backwards. For example, if the frog is facing left,
it cannot move right. If it is facing up, it cannot move down.

______________
: INSTALLING |
-------------/

 Use your favorite computer to calculator link software
(TiLP or TI-Connect) to send scoggerc.8xk to the calculator.

The app "SCOGGERC" will appear on the calculator once
sending is finished.

_______________
: HOW TO PLAY |
--------------/

 To start the game, push the APPs button and then scroll
down to SCOGGERC. Push Enter to start the game.

______________
:: ANYWHERE ::
 ON        :  Quick exit from anywhere
______________
:: IN MENUS ::
 Arrow keys:  Move cursor around
 MODE      :  Go back/quit
 2nd       :  Select/choose option
 Del       :  (From main) Delete game progress
___________________
:: ON GAME FIELD ::
 Arrow keys:  Move frog around
 MODE      :  Quit
 DEL       :  Reset game board


In Scogger+ mode, additional game pieces come with the levels.
* The purple lilipads require the player to jump on them twice
  before they will disappear. They must be completely gone
  before you can win a level.
* The brown rocks last forever. They do not need to be cleared
  (since you cannot clear them) for you to win the level.
* In order to win, there must be exactly one green lilipad left,
  and it must be the one you are currently on.



____________
: CREDITS  |
-----------/

The original idea for this game came from Scognito.
http://scognito.drunkencoders.com/projects/scogger.php
The original level pack was also sourced from there.

This TI-84 Plus CSE port was programmed by Rodger "Iambian" Weisman.
So were most of the other python scripts in the tools folder, which
helped make the build possible.

Graphics were provided for by "Zera".

The TI-83 Plus version was written by Tim "Geekboy1011" Keller and was
also the major motivational force behind getting this program done.

The original build font (which should still be in the project) is
Trebuchet MS, which came with Windows 7.

The build font I'm (most likely) currently using is PF Tempestra Seven,
which came from http://www.dafont.com/pf-tempesta-seven.font

The included assembler, Brass, was made by Ben Ryves.

The version of apack.exe was ported by Dwedit.

The included app signer, rabbitsign.exe, was made by Benjamin Moody.

Special thanks for Tim "Geekboy1011" Keller for keeping me from
going absolutely insane while I was trying to code this app for
a calculator with such atrocious hardware. Programming a rotten
banana peel might be more appealing than that.

____________
: LICENSE  |
-----------/

For all software that I don't own the copyright for, you'll need
to find the licenses for those, but I'm pretty sure they won't
object to non-commercial use.

For the stuff I do own...

*snip*

The MIT License (MIT)

Copyright (c) 2015 Rodger Weisman

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.


____________________
: REVISION HISTORY |
-------------------/

0.00 20151021 - lol. I haven't even got the build environment put together.
0.01 20151022 - It builds. It turns the screen dark and exits.
0.0n  I dunno - Lots of work. Completely forgot to update this crap.
0.9  20151031 - Ten days. Almost done. Levels. Game. Frills. Saves progress.
1.0  20151031 - I think it's done?
1.1  20151013 - Fixed a display bug with regards to the splash animation
1.2  20151102 - Made the display bug fix cleaner and faster.
                Fixed the extra level pack so that there's 50, not 30.
                Fixed display oddities on fresh app execution.
                Cleaned up title redisplay and improved next level logic.
                You are now congratulated if you complete a level pack.



____________________
: BUILDING THE APP |
-------------------/
______________________
:: WHAT YOU'LL NEED ::

* Windows XP or higher (or something that can simulate that environment)
* Python 2.7
* Pillow (a fork of the Python Imaging Library)
________________
:: WHAT TO DO ::

* Double-click _MAKEALL.bat to compile all assets.
* Or double-click _MAKE.bat to compile just main.z80 if all the assets
  were already compiled (did you make sure to _MAKEALL first?)

__________________________
: MAKING YOUR OWN LEVELS |
-------------------------/

To run the level editor, you'll need a copy of AutoHotkey L installed.
That'll make the .ahk script executable. It has a full GUI, but it does
take a little bit of time to load.

Once you are done with all the levels and have save them, click the
"All => Clipboard" button, then open up
src\dat\lost_levels.z80
then overwrite the contents of that file by Ctrl+A then Ctrl+V
(select all and paste). Save, then run the _MAKEALL.bat file

Then you hope and pray it works.

