README-win.txt

   1 Welcome to VisualBoyAdvance version 1.8.0.
   2
   3 Compiling the sources
   4 ---------------------
   5
   6 See the INSTALL file for compiling instructions. Please note the following
   7 requisites to compile:
   8
   9 - GCC must be 3.x or greater in order to compile GBA.cpp with -O2. Earlier
  10   versions have a problem during optimization that requires an absurd
  11   ammount of memory and usually ends up crashing the compiler/computer
  12 - On Windows, Microsoft Visual C++ 6 or later is needed. Please note that
  13   some of the source code will not compile with the shipped header files.
  14   You will need to install the most recent Platform SDK from Microsoft.
  15
  16 Support
  17 -------
  18
  19 Please support VisualBoyAdvance by making a donation. You can donate money
  20 using PayPal (www.paypal.com). Use the contact form to find how you can
  21 send donations. Also, it is recommended that you use the VisualBoyAdvance
  22 forum on www.ngemu.com message board.
  23
  24 Default keys (can be edited in the Options menu)
  25 ------------------------------------------------
  26
  27 Arrow keys - direction
  28 Z          - Button A
  29 X          - Button B
  30 A          - Button L
  31 S          - Button R
  32 Enter      - Start
  33 Backspace  - Select
  34 Speedup    - Space
  35 Capture    - F12
  36
  37 You can change the configuration above to use a joystick. Go to
  38 Options->Joypad->Configure... menu.
  39
  40 The 1 thorugh 4 joypads allow you to have different settings which can be
  41 easily switched.
  42
  43 Recommended System Requirements
  44 -------------------------------
  45
  46 CPU: 800MHz with MMX & SSE
  47 RAM: 64MB free
  48 GPU: Graphics card with drivers supporting DirectX9
  49 OS:  Windows 2000 with DirectX9 runtime
  50
  51 Translations
  52 ------------
  53
  54 Translations can be done as long as you have Microsoft Visual VC++ on
  55 your computer.
  56
  57 If you just want to use a translation, place the translation .DLL on
  58 the same directory as the emulator. From the Options->Language menu,
  59 select Other... and type the three letter (or two) language name from
  60 .DLL. For example, VBA_PTB.DLL: type PTB on the dialog.
  61
  62 These translation files are only for VisualBoyAdvance GUI and messages.
  63 Games will not be translated and cannot be translated by the emulator.
  64
  65 Skins
  66 -----
  67
  68 Skins consist of a bitmap (.bmp), a region file (.rgn), a draw rectangle
  69 on the region and an INI file.
  70
  71 Once you have the bitmap, you the region creator which can be found at
  72 the downloads section of emulator website along with a sample skin.
  73 This allows for irregular skins with holes or any shape.
  74
  75 Create the INI file like this:
  76 [skin]
  77 image=<relative path from ini to image bitmap>
  78 region=<relative path from ini to image region>
  79 draw=<draw rectangle defined as x,y,width,height separated by commas>
  80 buttons=<number of buttons in the skin> (optional)
  81
  82 Then, for each button with n starting a 0:
  83
  84 [button-<n>]
  85 normal=<relative path to button normal bitmap>
  86 down=<relative path to button pressed bitmap>
  87 over=<relative path to button hover bitmap - mouse over the button> (optional)
  88 id=<id of button action, menu or emulator joypad button - see below)
  89 rect=<rectangle where the button is to be drawn>
  90 region=<region to create a non rectangular button> (optional)
  91
  92 The id member can be one of the values found under Tools->Customize to have an
  93 action button.
  94
  95 If the intended use for the button is to open a menu, it can be one of the
  96 following values:
  97
  98 MENUFILE    - The File Menu
  99 MENUOPTIONS - The Options Menu
 100 MENUCHEAT   - The Cheat Menu
 101 MENUTOOLS   - The Tools Menu
 102 MENUHELP    - The Help Menu
 103
 104 If the intended use for the button is to provide a joypad button, then the
 105 it can be one of the following values:
 106
 107 A        - A button
 108 B        - B button
 109 SEL      - SELECT button
 110 START    - START button
 111 R        - right
 112 L        - left
 113 U        - up
 114 D        - down
 115 BR       - RIGHT button (shoulder)
 116 BL       - LEFT button (shoulder)
 117 SPEED    - speed up button (emulator)
 118 CAPTURE  - screen capture (emulator)
 119 GS       - GS/AR button (cheating)
 120 UR       - up and right combination
 121 UL       - up and left combination
 122 DR       - down and right combination
 123 DL       - down and left combination
 124
 125 Example:
 126
 127 [skin]
 128 image=gbc.bmp
 129 regions=gbc.rgn
 130 draw=20,20,144,160
 131
 132 Skins are only supported in DirectDraw and GDI modes and are also not supported
 133 in fullscreen mode.
 134
 135 To avoid scaling problems, please not the following:
 136
 137 GBA screen size: 240x160
 138 GBC screen size without border: 160x144
 139 GBC screen size with border: 256x224
 140
 141 Not using multiples to these values will cause distortion on the image drawn
 142 by the emulator. This is not a BUG on the emulator and rather a problem of
 143 the skin size.
 144
 145 Per game settings
 146 -----------------
 147
 148 Version 1.5 introduced the support for per game settings for GBA games. You
 149 can defined the following settings on a per game basis by using an INI file
 150 called vba-over.ini in the same directory as the emulator:
 151
 152 comment=You can add any text you like here, for example the full name of the game, but not exceeding 255 characters
 153 rtcEnabled=<0 for false, anything else for true>
 154 flashSize=<65536 or 131072>
 155 saveType=<0 for automatic, 1 for EEPROM, 2 for SRAM, 3 for Flash or 4 for
 156 EEPROM+Sensor>
 157
 158 Use the 4 letter game code to separate settings for each game. Example:
 159
 160 [ABCD]
 161 rtcEnabled=0
 162 flashSize=65536
 163 saveType=0
 164
 165 [ABC2]
 166 rtcEnabled=1
 167 flashSize=131072
 168 saveType=0
 169
 170 An easier way to change the per game settings is to use the Game overrides dialog in the MFC version of VBA.
 171 Select Menu>Options>Emulator>Game Overrides... to open the dialog. Just make your changes and click OK.
 172
 173 FAQ
 174 ---
 175
 176 See online FAQ for more information: http://vba.ngemu.com/faq.shtml
 177
 178 Please don't email about what you think it is problem before consulting
 179 the FAQ.
 180
 181 Reporting a crash
 182 -----------------
 183
 184 If VisualBoyAdvance crashes, please do the following:
 185
 186 1. Win 95/98/ME: start DrWatson (drwatson.exe) and reproduce the crash.
 187 DrWatson will capture the crash information in a log file (.wlg) file that
 188 needs to be sent to me. Please also open the .wlg file on your machine by
 189 double-clicking and copy the details section into the email. Microsoft
 190 made life harder when you migrate to WinXP (or NT or 2000) by not allowing
 191 DrWatson to read its old file format.
 192
 193 2. Win NT/2000/XP: make sure DrWatson is the default debugger by executing
 194 drwtsn32.exe -i and then recreate the crash. DrWatson will generate a log file
 195 that needs to be sent to me (usually in c:\Documents and Settings\All Users\
 196 Documents\DrWatson). Depending on your system configuration, you may be asked
 197 if you want to generate a log file. If so, please click on yes.
 198
 199 LICENSE
 200 -------
 201
 202     VisualBoyAdvance - a Gameboy and GameboyAdvance emulator
 203     Copyright (C) 1999-2003 Forgotten
 204     Copyright (C) 2004 Forgotten and the VBA development team
 205
 206     This program is free software; you can redistribute it and/or modify
 207     it under the terms of the GNU General Public License as published by
 208     the Free Software Foundation; either version 2 of the License, or
 209     (at your option) any later version.
 210
 211     This program is distributed in the hope that it will be useful,
 212     but WITHOUT ANY WARRANTY; without even the implied warranty of
 213     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 214     GNU General Public License for more details.
 215
 216     You should have received a copy of the GNU General Public License
 217     along with this program; if not, write to the Free Software
 218     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 219
 220 Special Thanks
 221 --------------
 222
 223 PokemonHacker for all his help improving the emulator.
 224 Costis for his help fixing some of the graphics bugs.
 225 Snes9x developers for the great emulator and source code.
 226 Gollum for some help and tips.
 227 Kreed for his great graphic filters.
 228 And all users who kindly reported problems.
 229
 230 Contact
 231 -------
 232
 233 Please don't email unless you found some bug. Requests will be ignored and
 234 deleted. Also, be descriptive when emailing. You have to tell me what version
 235 of the emulator you are writing about and a good description of the problem.
 236 Remember, there are several interfaces (Windows, SDL and GTK+) and
 237 several systems (Windows, Linux, MacOS X and BeOS).
 238
 239 Also, there are still people writing about the old VisualBoy which is no longer
 240 supported. Also remember I am not paid to work on VisualBoyAdvance.
 241
 242 This is just a hobby.
 243
 244 Forgotten (http://vba.ngemu.com/contact.shtml)
 245 kxu <kxu@users.sourceforge.net>
 246
 247 http://vba.ngemu.com
 248 http://sourceforge.net/projects/vba