Difference between revisions of "Documentations"

From Yabause
Jump to: navigation, search
m (Using the main user interface)
(Artwork: removed request for new artwork, as this has been done.)
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<nowiki>        _  _         
+
Yabause is a cross-platform [https://en.wikipedia.org/wiki/Sega_Saturn Sega Saturn] emulator licensed under [https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html GPLv2+].
      / \_/ \            ___  _      ____
+
      \    /___  ___  /   || | __ /   \ ____
+
        \  //   ||  \ /   || | \ \\  \_//    \
+
        /  //    ||  //  _  || |__\ \\  \    __/
+
        \_//  _  ||  \\_/ \_||______/ \  \\  \__
+
          \_/ \_||___/              \____/ \____\
+
    Yet Another Buggy And Uncomplete Saturn Emulator
+
</nowiki>
+
  
Yabause is a Cross-Platform [https://en.wikipedia.org/wiki/Sega_Saturn Sega Saturn] emulator under [https://www.gnu.org GNU GPL]. Can boot Saturn bios and games, most of those games are playable.
+
==Getting Yabause==
 +
[https://yabause.org/download/ Release and development builds]
  
==Check runtime requeriments==
+
The source can also be acquired with Git:
  
To able to run Yabause, we need some software preinstalled ar the OS.
+
git clone https://github.com/Yabause/yabause
* SDL libs runtime for sound or OpenAL sould work.
+
* QT4 or QT5 libs runtime
+
* Lasted Video modules OS with OpenGL 3.X support if yabause > 0.9.13 its bein used.
+
* Cocoa runtime libs for MAC OS users
+
* LAsted updated Androit for androit port.
+
Note that some ports need more tune setting, such Dreamcast and older Androit devices, see specific info bellow in section '''''Specific Usage Documentation'''''
+
  
==From where to run==
+
==Compiling and Usage==
  
Depends of your system, yabause can run from a menu, from a terminal o simples way choosing from the main desktop.
+
Instructions on how to compile and use Yabause depends on the platform. Qt, Android, GTK, OS X Cocoa and Dreamcast ports are available. The Qt port is the most advanced desktop version and is recommended over the GTK and OS X ports. Visit the following pages for platform-specific information.
  
Once u locate the downloaded and installed yabause port (not downloade yet? oh no! go inmediatelly to http://yabause.org/download/ and then go here!).
+
* [[Readme QT | Qt]]
Yeah! now once u downloaded, installed a yabause binary port, launch and then will be show a GUI or user interface. Not lauched?
+
* Android
 +
* [[Readme LIN | GTK]]
 +
* [[Readme MAC | OS X Cocoa]]
 +
* [[Readme DC | Dreamcast]]
  
=== How to lauch yabause ===
+
==Getting Help==
 +
* [https://github.com/Yabause/yabause/issues GitHub issue tracker]
 +
* [http://webchat.freenode.net/?channels=yabause IRC] (freenode.net #yabause)
 +
** Users on IRC are often busy, away from their computers, or in different time zones, so it may take time for a question to be answered. It's recommended to stay logged in for at least a few hours.
 +
* [http://forums.yabause.org/ Forums]
  
Depending of your platform port, once downloaded the release, uncompress and then inside the uncompresed files lauch the product, for MAC users see ''yabause.app'', for Linux see ''yabause-qt'' or ''yabause-gtk'', for Androit see on installed apps, for M$cosoft user see ''yabause.exe''. More specific info are in the section '''''Specific Usage documentation''''' below.
+
== Contributing ==
  
The interface depending of your instalation can be two: a GTK or QT. The menus in both are very similar.
+
=== Feature Requests and Bug Reports ===
  
==Menu==
+
Let us know about feature requests and bug reports on our [https://github.com/Yabause/yabause/issues issue tracker] The more information you can provide about your settings and setup the easier it will be to solve your issue.
  
Theres two king of menus depending of the gui interface, a qt menu and the gtk menu.
+
=== Pull Requests ===
  
===Menu qt===
+
We accept pull requests through [https://github.com/Yabause/yabause/pulls GitHub]. See our [[Roadmap#Goals|development roadmap]] for potential ideas or take a look at the [https://github.com/Yabause/yabause/issues open issues].
  
* Ybause
+
=== Writing Documentation ===
** 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.
+
  
===Menu gtk===
+
Most of our documentation is contained on this wiki. Updating port usage and compiling instructions or the [[Compatibility list | compatibility list]] are great ways to help.
  
* Yabause
+
=== Issue Triage ===
** Settings... : you can change lot of options (bios path, CD-ROM, video, sound, etc...).
+
** Run : start a game if defined on the readers drivers.
+
** Pause pause the game.
+
** Reset reset a game.
+
** Transfer Transfer data between disk and memory.
+
** Screenshot : make a screenshot of your game.
+
** Frame Skip / Limiter limit the speed.
+
** Savestate: Saves/Restores the games state at current run.
+
** Quit : quit Yabause.
+
* View Backup Manager... Manage all your game saves
+
** 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.
+
** 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 dumper For programmers, dump Saturn memory.
+
* Help
+
** About info about Yabause.
+
  
=Getting Started=
+
Confirming and following up on bugs on the [https://github.com/Yabause/yabause/issues issue tracker] is another great way to help. This includes checking if older bugs are still valid or not. The [https://github.com/Yabause/yabause/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-asc least recently updated sort] makes it easy to see the bugs most in need of checking.
  
Now ''we know the menues'', we ''have the program downloaded'', and ''we have a disk "Saturn" game'' in a box full of dust.
+
=== Artwork ===
  
==Using the main user interface==
+
=== Translation ===
  
# First, go into "Yabause" menu, then into "Settings".
+
Yabause is translated at [https://www.transifex.com/yabause/public/ Transifex].
# Set the Bios path if u have it. 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).
+
# 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.
+
# Then go to video tab and select software render. Note that OpenGL render need modern support.
+
# Then push aAcept button to store the configured settings
+
# Then go to Yabause Menu and select Run or go to Emulation menu and choose Run.
+
  
Later you maybe want to configure is the game pad configuration. Currently theres some issues with GTK gui.
+
== Saturn Hardware Information ==
  
===Configuration controllers===
+
=== General ===
  
* Click on the "Input" tab. Select the pad type for Port 1-1(most likely the one you want is Pad).
+
* [[SH-2CPU]]
* Click on the wrench icon and a new window will open.
+
* [[SCU]]
* Click on each of the buttons and press the key/button you want to use.
+
* [[SEQFormat]]
* When you're finished, press the close button.
+
* [[GameHacking]]
* 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".
+
=== Cartridges ===
 +
* [[Backup RAM Cartridge]]
 +
* [[DRAM Cartridge]]
 +
* [[Netlink]]
 +
* [[X-Band]]
  
=Specific Usage Documentation=
+
=== CD Block ===
 +
* [[CDStatusData]]
 +
* [[MPEGStatusData]]
 +
* [[CDBlock]]
 +
* [[MPEGCard]]
 +
* [[CDCommands]]
 +
* [[MPEGCommands]]
 +
* [[OtherCommands]]
  
* [[Authors]]
+
=== Video ===
* [[Changelog]]
+
* [[VDP1]]
* [[Roadmap#Goals|Goals]]
+
* [[VDP2]]
* [[Readme]]
+
 
* [[Readme DC]]
+
=== Sound ===
* [[Readme LIN]]
+
* [[68000]]
* [[Readme MAC]]
+
* [[SCSP]]
* [[Readme QT]]
+
 
 +
=== Peripherals ===
 +
* [[SMPC INTBACK]]
 +
* [[SMPC]]

Latest revision as of 21:01, 14 February 2017

Yabause is a cross-platform Sega Saturn emulator licensed under GPLv2+.

Getting Yabause

Release and development builds

The source can also be acquired with Git:

git clone https://github.com/Yabause/yabause

Compiling and Usage

Instructions on how to compile and use Yabause depends on the platform. Qt, Android, GTK, OS X Cocoa and Dreamcast ports are available. The Qt port is the most advanced desktop version and is recommended over the GTK and OS X ports. Visit the following pages for platform-specific information.

Getting Help

  • GitHub issue tracker
  • IRC (freenode.net #yabause)
    • Users on IRC are often busy, away from their computers, or in different time zones, so it may take time for a question to be answered. It's recommended to stay logged in for at least a few hours.
  • Forums

Contributing

Feature Requests and Bug Reports

Let us know about feature requests and bug reports on our issue tracker The more information you can provide about your settings and setup the easier it will be to solve your issue.

Pull Requests

We accept pull requests through GitHub. See our development roadmap for potential ideas or take a look at the open issues.

Writing Documentation

Most of our documentation is contained on this wiki. Updating port usage and compiling instructions or the compatibility list are great ways to help.

Issue Triage

Confirming and following up on bugs on the issue tracker is another great way to help. This includes checking if older bugs are still valid or not. The least recently updated sort makes it easy to see the bugs most in need of checking.

Artwork

Translation

Yabause is translated at Transifex.

Saturn Hardware Information

General

Cartridges

CD Block

Video

Sound

Peripherals