Introduction

This file documents the gtk version only, for general information check the README file.

Compiling instructions

The Gtk+ port of Yabause is written in C and depends on the Gtk+ library (thus the name). The recommended setup of the Gtk+ port is to link it against OpenGL and gtkglext libraries, but this is not mandatory; see "Full Software mode" for further instructions.

Yabause currently provides two build system, a legacy build process using the autotools and a newer build process using CMake.

Recommended setup

You need a working C compiler, such as gcc and the above libraries runtime and development packages :

• http://www.gtk.org
• http://gtkglext.sourceforge.net
• OpenGL should be included with your compiler, if it isn't, check on your distribution's website for links.
• http://www.cmake.org, you'll need a CMake version >= 2.8

With those libraries, you'll get a working Yabause, but with some restrictions :

• No sound
• No translations
• Depending on your OS, keyboard input only

You may want to install some optional dependencies for a better experience.

Optional libraries

Yabause can use a number of optional libraries :

• SDL : provides sound and joystick support http://www.libsdl.org/
• OpenAL : provides sound support
• mini18n : provides translation support

Compiling

For the build process, we recommend using two directories: one for the Yabause sources (SOURCES) and one for the build (BUILD)

Uncompress the Yabause source archive into the $SOURCES dir and create the $BUILD directory.

Move to the build directory and type "cmake $SOURCES" then "make" it will generate one program: "yabause" in the "src/gtk" directory.

You can even type "make install" to install that program on your system (in /usr/local/ by default), but we don't support desinstalling it.

Full Software mode

The Gtk+ supports building without OpenGL support.

cmake -DYAB_WANT_OPENGL=NO $SOURCES
make

How to use Yabause ?

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

First, set the BIOS path. Yabause can run some games without a BIOS, but most of them needs it. If you want to use the emulated BIOS, just let the BIOS entry blank.

Next, set the cdrom device. It can be a cd device, an iso or a cue file. Set the cd type accordingly.

The last thing you have to configure is the keys.

Once eveything is set, you can start emulation with the "Yabause>run" entry.

Command line arguments

-b (or --bios=)

Specify bios file.

-c (or --cdrom=)

Specify cd device. You can know which file is used as cd
device by looking in /etc/fstab. It is commonly something
like /dev/hdc or /dev/hdd for IDE devices and /dev/scd0
for SCSI devices.

-i (or --iso=)

Specify iso file.

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