File: README.LIN

package info (click to toggle)
yabause 0.9.13.1-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 7,468 kB
  • ctags: 15,918
  • sloc: ansic: 96,432; cpp: 7,056; asm: 5,796; objc: 1,007; java: 804; pascal: 609; xml: 96; makefile: 7
file content (135 lines) | stat: -rw-r--r-- 3,902 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
        _   _          
       / \_/ \            ___  _      ____ 
       \     /___  ___   /   || | __ /    \ ____
        \   //   ||   \ /    || | \ \\  \_//    \
        /  //    ||   //  _  || |__\ \\  \    __/
        \_//  _  ||   \\_/ \_||______/ \  \\  \__
           \_/ \_||___/              \____/ \____\
     Yet Another Buggy And Uncomplete Saturn Emulator

           ____________________________________
           Copyright (c) 2002-2011 Yabause team


1) Introduction.............................................19
2) Compiling instructions...................................25
3) How to use Yabause......................................102


1 Introduction________________________________________________

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


2 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.


2.1 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.


2.2 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


2.3 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.


2.4 Full Software mode________________________________________

The Gtk+ supports building without OpenGL support.

cmake -DYAB_WANT_OPENGL=NO $SOURCES
make


3 How to use Yabause__________________________________________

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


3.1 Configuration_____________________________________________

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.


3.2 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.