Compiling instructions

To compile the Qt port of Yabause you'll need at least:

Yabause also have some optional dependencies:

Once these libraries installed, you should be ready to compile Yabause

Compiling for Windows : using CMake

Follow the guide : Compiling Yabause under Windows with CMake

Compiling for Mac OS X : using CMake

Follow the guide : Compiling Yabause under MacOS X with CMake

Compiling for *Nix/Linux/BSD : using CMake

Follow the guide : Compiling Yabause under MacOS X with CMake

How to use Yabause ?

Before using Yabause, you need to configure a few things in the Preferences dialog (File>Settings).

Supported file formats

Menu

File Settings... : you can change lot of options (bios path, CD-ROM, video, sound, etc...).
Open ISO... choose the directory of your game.
Open CD Rom... : choose your CD-ROM drive (real saturn game) or a virtual CD-ROM (games mounted).
Save State To File... allow to save where you want.
Load State From File... allow to load a save state.
Screenshot : make a screenshot of your game.
Quit : quit Yabause.
Emulation Run : start a game.
Pause pause the game.
Reset reset a game.
Frame Skip / Limiter limit the speed.
Tools Backup Manager... Manage all your game saves
Cheat List... Show the current list of enabled cheats
Cheat Search... A search engine for cheats
Transfer Transfer data between disk and memory.
View FPS enable / disable the FPS counter.
Layer enable / disable layers : Vdp1, NGB0, NGB1, NGB2, NGB3 and RGB0.
Fullscreen switch between fullscreen mode and windowed mode.
Log enable / disable the log.
Debug Master SH2 : For programmers, allows you to debug SH2 code for Master SH2
Slave SH2 For programmers, allows you to debug SH2 code for Slave SH2
VDP1 For programmers, displays VDP1 sprites/polygons/etc. and debug information.
VDP2 For programmers, displays VDP2 screens and debug information.
M68K For programmers, allows you to debug code for 68000
SCU-DSP For programmers, allows you to debug code for SCU's DSP
SCSP For programmers, displays information on SCSP
Memory Editor For programmers, Hex Editor for editing Saturn memory.
Help Emu-Compatibility : website about yabause compatibility list.
About info about Yabause.

Getting Started

First, go into "File" menu, then into "Settings". First, set the Bios path. Please note Yabause can run some games without a BIOS, but most of them needs it. If you want to use the emulated BIOS, just leave the BIOS entry blank.

Next, set the emulated CD-ROM. It can be a CDROM device, or a support CD image file(See supported types ). First select the type from the drop list, then select the drive from the list if it's a CDROM device, or set the filename of the image file.

The last thing you have to configure is the game pad configuration. Click on the "Input" tab. Select the pad type for Port 1-1(most likely the one you want is Pad). Click on the wrench icon and a new window will open. Click on each of the buttons and press the key/button you want to use. When you're finished, press the close button.

If you want to adjust other settings, please refer to the Configuration section. Otherwise just press the "OK" button.

Once everything is set, you can start emulation with going into the "Emulation" menu, and then "Run".

Shortkeys :

Here are the default key mappings (they may be subject to change) :

CTRL + S Settings
CTRL + I Open ISO
CTRL + C Open CD-ROM
F9 Save State To File
ALT + 0 Save State to slot 0
ALT + 1 Save State to slot 1
ALT + 2 Save State to slot 2
ALT + 3 Save State to slot 3
ALT + 4 Save State to slot 4
ALT + 5 Save State to slot 5
ALT + 6 Save State to slot 6
ALT + 7 Save State to slot 7
ALT + 8 Save State to slot 8
ALT + 9 Save State to slot 9
F5 Load State From File
ALT + 0 Load State from slot 0
ALT + 1 Load State from slot 1
ALT + 2 Load State from slot 2
ALT + 3 Load State from slot 3
ALT + 4 Load State from slot 4
ALT + 5 Load State from slot 5
ALT + 6 Load State from slot 6
ALT + 7 Load State from slot 7
ALT + 8 Load State from slot 8
ALT + 9 Load State from slot 9
CTRL + P Screenshot
CTRL + Q Quit the emulator

Emulation :

F1 - Run
F2 - Pause
F3 - Reset
F4 - Frameskip / Limiter

Tools :

ALT + B - Backup Manage
ALT + L - Cheat List
ALT + S - Cheat Search
CTRL + T - Transfer

View :

CTRL + F12 - Enable / Disable FPS counter
1 - Enable / Disable VDP1 Layer
2 - Enable / Disable NBG0 Layer
3 - Enable / Disable NBG1 Layer
4 - Enable / Disable NBG2 Layer
5 - Enable / Disable NBG3 Layer
6 - Enable / Disable RGB01 Layer
ALT + RETURN - Switch between Fullscreen / Windowed Screen
CTRL + L - Enable / Disable The Log

You can now change any shortkeys that you want. Go to Settings --> Shortcuts.

Contact information

General inquiries should go to :

E-mail: guillaume.duhamel@gmail.com

E-mail: cwx@cyberwarriorx.com

Qt Port-related inquiries should go to:

E-mail: pasnox@yabause.org

Web: http://yabause.org

Please don't ask for roms, bios files or any other copyrighted stuff. Please use the forum when you have any questions if possible.

Disclaimer

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA