Author Topic: TI-Boy SE readme editing help  (Read 6125 times)

0 Members and 1 Guest are viewing this topic.

Offline calc84maniac

  • eZ80 Guru
  • Coder Of Tomorrow
  • LV11 Super Veteran (Next: 3000)
  • ***********
  • Posts: 2908
  • Rating: +470/-17
    • View Profile
    • TI-Boy CE
TI-Boy SE readme editing help
« on: February 22, 2013, 05:59:09 pm »
So, I've been planning on releasing the TI-Boy beta on ticalc for a while now, but I think the readme could be improved for "the masses", so to speak. Any input on this is much appreciated :)

Here's my first draft for beta 0.2.04:
Code: [Select]
TI-Boy SE Beta 0.2.04
by calc84maniac (Outside The Box Programming)

Table of Contents:
* Disclaimer
* Overview
* New features in the Beta version
* Creating APPs
* Sending APPs
* Controls
* Frequently Asked Questions (READ THESE BEFORE ASKING YOURSELF)
* Credits
* Version History

Disclaimer:
  This is a beta piece of software (though a well-tested one). The creator is not held responsible for any damages caused. Use at your own risk!
  TI-Boy will temporarily replace part of the TI-OS, for greater speed and more available RAM. An automatic recovery feature is included in the case of a crash.
  Nonetheless, this program is not likely to permanently brick your calculator. The most damage it might cause is a RAM clear and/or an OS reinstall.

Overview:
  TI-Boy SE is a Game Boy emulator (no Game Boy Color support) for the TI-83+SE, TI-84+, and TI-84+SE calculators. Do not expect incredible compatibility.
  This was rewritten from scratch since the Alpha version, specifically to support newer TI-84+/TI-84+SE calculators (which have smaller RAM chips).
  TI-83+ and TI-Nspire are not supported, and never will be.

New features in the Beta version:
  * Works on all black-and-white TI-84+ models
  * Better game compatibility
  * Significantly faster CPU emulation
  * Has four zoom levels (100%, 75%, 60%, 50%)
  * More intuitive zooming controls (pressing Plus and Minus!)
  * Black-and-white zoom modes use dithering to increase visual quality
  * Supports 4-channel sound output
  * Recovers RAM data in the case of a crash

Creating APPs:
  Note: Any warnings given about pages beginning with FFh can be safely ignored, because TI-Boy patches the defragmentation glitch in the TI-OS.

  Method 1: Drag-and-drop
    Open the TI-Boy folder, then drag a Game Boy ROM file onto tiboy_makeapp.exe. A command-line window should open.
    If the ROM opened successfully, the program will request a name for the APP. Type it in and press Enter.
    Watch the console output for any compatibility warnings.
  Method 2: Run the EXE
    Open the tiboy_makeapp.exe directly. A command-line window should open and ask for a ROM filename. You may have to enter the entire filepath.
    If the ROM opened successfully, the program will request a name for the APP. Type it in and press Enter.
    Watch the console output for any compatibility warnings.
  Method 3: Command-line arguments
    Open a command-line window and navigate to the TI-Boy folder.
    Enter in the following format: tiboy_makeapp romfilename.gb AppName
    Watch the console output for any compatibility warnings.

Sending APPs:
  Use TI-Connect or other compatible linking software. Note: Not all TI-Boy APPs can fit on non-Silver Edition calculators (see FAQ).
  People have reported problems sending some APPs over Direct USB (a solution is being looked into). Sending over Silverlink seems to work, though.

Running TI-Boy:
  Open the APPs menu, and start the APP.
  It should display the loading screen. Do not remove a battery while this is loading, or you will have to reinstall the TI-OS.
  Then, start playing! (See controls below.)
  To quit, press the ON button. Quitting takes a few seconds as it restores the TI-OS. Again, do not remove a battery during this step.
  If the emulator freezes and pressing ON does not cause it to quit (which does work in most cases), feel free to remove a battery.
  TI-Boy will automatically restore the TI-OS and your previous RAM contents if this happens.

Controls:
  Arrows: Game Boy D-Pad
  2ND: Game Boy "A"
  ALPHA: Game Boy "B"
  MODE: Game Boy "START"
  XT0n: Game Boy "SELECT"
  ON: Game Boy power switch (exit the emulator)

  CLEAR: Teacher Key or Battery Saver (suspends emulation and turns off the screen)
  STAT: Toggle sound emulation (default is off). See FAQ for more information.
  * (Times): Increase LCD contrast
  / (Divide): Decrease LCD contrast
  + (Plus): Zoom in
  - (Minus): Zoom out
  Numpad: Move view
  F2,F3,F4 (WINDOW,ZOOM,TRACE): Light,Normal,Dark monochrome modes (smooth zoom)
  F5 (GRAPH): Grayscale mode (rough zoom)
  . (Decimal): Follow next sprite in the internal list (selected sprite will flash for a few frames)
  5: Center view on selected sprite
  0: Turn off sprite follower
  (-): Set frameskip (hold the negation key and press a number 0-9 to set the value)

Frequently Asked Questions:
  Q. Sound emulation? What's up with that?
  A. When sound emulation is turned on, TI-Boy will to the best of its ability emulate the Game Boy sound hardware and output sound waves to the I/O data port.
     However, this comes at a performance cost. There are 4 channels that are emulated, and 2 are outputted to each ear. There is no volume control.

  Q. How do I listen to the sound?
  A. You will need a 2.5mm-male to 3.5mm-female adapter to plug in standard headphones/speakers to the I/O data port.
     It is recommended that you plug in the headphones after starting TI-Boy (because the homescreen responds very slowly when headphones are plugged in).

  Q. How big are the APPs?
  A. Generally, take the size of the ROM and add 16KB (16384 bytes). Sometimes you might get lucky and have a smaller APP if there is a lot of empty space in the ROM.
     Pay attention to the size displayed when tiboy_makeapp.exe finishes.

  Q. Will xxxx ROM fit on my calculator?
  A. If you have a Silver Edition, ROMs up to 1MB (1024KB) in size will fit. If you have a normal TI-84+, ROMs up to 256KB in size will fit.
     Make sure to delete useless APPs from your calculator if needed.

  Q. So the compatibility issues with newer calculators are fixed?
  A. Mostly. There is still not enough RAM to emulate cartridges which use 32KB RAM, added to all the RAM in the Game Boy itself.
     Thankfully, such cartridges are few and far between. Also, such games that do not use all of that RAM, such as Pokemon Red/Blue/Yellow, can run with no issues.

  Q. Which calculators have a large enough RAM chip for this RAM-hogging game I want to play?
  A. All TI-83+SE calculators have the larger RAM chips. TI-84+SE calculators have larger RAM chips if they were manufactured before around April 2007.
     To be more specific, check the back of your calculator. The last part of the serial number should be in the format X-MMYYR,
     where MM is the month, YY is the year, and R is the revision. For example, S-0207G means manufactured in February 2007 with revision G.
     Revisions G and earlier have the larger RAM chips, and revisions H and later have the smaller RAM chips.
     If the revision letter is missing, that means it is before revision A (and should work).

  Q. What exactly does TI-Boy do to my calculator when it runs? Why the warnings?
  A. TI-Boy needs part of the Flash (Archive) memory which is taken by the TI-OS. So, it backs up this section of the OS and puts its own data there.
     Also, this is where your RAM is backed up in the case of a crash. When TI-Boy exits, the OS is put completely back to normal.
     There are two reasons for doing this:
     1) The emulator becomes quite a bit faster and simpler if GameBoy data can be in the space normally taken by the OS.
     2) Having control of this memory space allows automatic recovery in the case of a crash.

  Q. Does tiboy_makeapp convert Game Boy ROMs into native TI code?
  A. No. The ROM is slightly rearranged to fit into an APP and bundled with the emulator code. Converting to native TI code is infeasible for many reasons.

  Q. My calculator died! It's all your fault!
  A. Don't panic! To send a new OS, hold DEL while inserting a battery to bring up the Send OS screen.
     And make sure to report the bug, because we don't want this sort of thing to happen, now do we? ;)

  Q. Where is xxxx feature?
  A. Be patient, there's a reason this is a beta. I'll probably get around to it (as long as it's within reason).

  Q. xxxx ROM doesn't work!
  A. Sorry, but specific game compatibility is at the bottom of my to-do list at the moment.

  Q. how do i tern on my caclulater
  A. ...

Credits:
  calc84maniac for coding/design
  thepenguin77 for clean flash unlock hack
  FloppusMaximus for Rabbitsign (app signer). Source code can be found at http://www.ticalc.org/archives/files/fileinfo/383/38392.html
  Omnimaga for all the awesome community support

Version History:
  Beta 0.2.04:
    * First official beta release on ticalc.
    * makeapp.exe updates:
      - Name changed to tiboy_makeapp.exe.
      - Compiled against librabbitsign, so it no longer requires a separate rabbitsign executable.
      - As a result, the program no longer calls the system() function which was making some users' antivirus software very angry.
      - The tiboy.bin file is also now baked into the executable.
  Beta 0.2.03:
    * Rearranged code and data to allow using 16KB of cartridge RAM on all calculators. This means that Pokemon Red/Blue/Yellow can be run on all calculators!
    * Games that have 32KB of cartridge RAM but only use the first 8KB, 16KB, or 24KB will now only save to 1, 2, or 3 appvars respectively.
    * Fixed a waitloop detection error, speeding up parts of some games like Kirby's Dream Land.
  Beta 0.2.02:
    * The STAT behavior is fixed for real, cycling through all 3 modes within each scanline.
  Beta 0.2.01:
    * Timer emulation is more accurate relative to emulation speed, fixes Super Mario Land freezing.
    * More STAT compatibility. Now it cycles through all 3 modes.
  Beta 0.2.00:
    * Rearranged some code/data, allowing TI-84 Pocket.fr compatibility and freeing some RAM.
    * Reimplemented waitloop detection, which should eat much less CPU time per frame now.
    * Rendering tricks are more reliably detected, fixing graphics in parts of some games.
    * Emulator control keys are checked more often, improving responsiveness. Also, sprite tracking selection improved.
    * Added custom frameskip settings.
    * GPU speed is more accurate when sound is enabled, speeding up parts of some games.
    * Timer emulation is more accurate, fixes music in Super Mario Land among other things.
    * Extremely high-pitched sounds are changed to a slightly lower pitch, which should prevent freezes.
    * Bit 1 of STAT is now toggled at every scanline from 0 to 143, which fixes some games.
    * makeapp.exe updates:
      - Allow manual special character entry in app names, by typing \XY (XY is a hexadecimal character value)
  Beta 0.1.07:
    * Fixed some small bugs introduced in Beta 0.1.06.
  Beta 0.1.06:
    * Added support for 4-channel sound.
  Beta 0.1.05:
    * Added some support for low-priority sprites, i.e. sprites can be displayed behind the background tilemap. Fixes quite a few graphical glitches!
    * Fixed a cartridge RAM mapping glitch, which fixes compatibility with TI-Boy Alpha 4-appvar saves. Breaks compatibility with TI-Boy Beta 4-appvar saves.
  Beta 0.1.04:
    * Added timer check in RET opcodes, which significantly increases framerate in Pokemon textboxes.
  Beta 0.1.03:
    * Added light and dark monochrome palettes
    * Reincluded the defragmentation OS glitch patch so APPs won't get corrupted if pages start with 0xFF.
    * makeapp.exe updates:
      - Internal appnames are padded with spaces instead of null bytes for better linking software compatibility.
      - Trailing pages filled with 0x00 or 0xFF bytes are now removed from ROMs. This saves a lot of space in certain ROMs (e.g. saves 304KB in Pokemon Red).
  Beta 0.1.02:
    * Save files are archived upon exit.
    * Fixed glitch in which only the first 8KB is loaded from a 32KB save.
    * Fixed very bad glitch in 32KB saving caused by bcall(_DelVarArc) trashing (OP1).
    * Pressing Select no longer causes a false press of B on some calculators.
    * makeapp.exe updates:
      - Output app is now always placed in the same folder as the exe.
      - APPs which have 32KB saves now have a maximum of 7 characters in their names (because the save data goes into 4 separate appvars which need unique names)
  Beta 0.1.01:
    * TI-Boy no longer makes a resident patch to the OS (so the OS stays valid and there are no conflicts with other patches).
    * Flash writing is now done in 6MHz mode so it works on slower flash chips.
    * makeapp.exe updates:
      - Spaces in ROM filename now handled correctly when program is run with no arguments.
      - Searches for tiboy.bin and rabbitsign in the same folder as the exe.
      - Displays number of pages in generated APP.
  Beta 0.1.00:
    * First public beta (on omnimaga.org)
"Most people ask, 'What does a thing do?' Hackers ask, 'What can I make it do?'" - Pablos Holman

Offline Darl181

  • «Yo buddy, you still alive?»
  • CoT Emeritus
  • LV12 Extreme Poster (Next: 5000)
  • *
  • Posts: 3408
  • Rating: +305/-13
  • VGhlIEdhbWU=
    • View Profile
    • darl181.webuda.com
Re: TI-Boy SE readme editing help
« Reply #1 on: February 22, 2013, 06:14:09 pm »
Little things that are coming to mind..
 - maybe make the faq more prominent, earlier in the file or something
 - clarify that the Nspire wouldn't work even if it did have the 84 keypad?
 - "Battery saver" before "teacher key"  not as outwardly promoting that kind of stuff <_< maybe
 - "TI-84+ and TI-84+SE calculators have larger RAM chips if they were manufactured before around April 2007 with revision G." you never know :P
Vy'o'us pleorsdti thl'e gjaemue

Offline DJ Omnimaga

  • Clacualters are teh gr33t
  • CoT Emeritus
  • LV15 Omnimagician (Next: --)
  • *
  • Posts: 55933
  • Rating: +3153/-232
  • CodeWalrus founder & retired Omnimaga founder
    • View Profile
    • DJ Omnimaga Music
Re: TI-Boy SE readme editing help
« Reply #2 on: February 22, 2013, 06:29:00 pm »
The last FAQ answer is too short. I myself often have troubles terning caclulater ON, because they don't exist. The answer should explain that in detail, but that on the other hand, there is something called a calculator, commonly refered to as calc and clac.

Also add a link to the TI-Boy SE sub-forum.
« Last Edit: February 22, 2013, 06:30:00 pm by DJ_O »

Offline Sorunome

  • Fox Fox Fox Fox Fox Fox Fox!
  • Support Staff
  • LV13 Extreme Addict (Next: 9001)
  • *************
  • Posts: 7920
  • Rating: +374/-13
  • Derpy Hooves
    • View Profile
    • My website! (You might lose the game)
Re: TI-Boy SE readme editing help
« Reply #3 on: February 23, 2013, 12:18:52 am »
tern on calc -> turn on calc
and say  [0n] - [2ND] - [+] - [7] - [left] - [ENTER] - [down] - [ENTER]
* Sorunome runs
« Last Edit: February 23, 2013, 12:19:12 am by Sorunome »

THE GAME
Also, check out my website
If OmnomIRC is screwed up, blame me!
Click here to give me an internet!