This is an automated email from the git hooks/post-receive script. thansen pushed a commit to branch master in repository higan.
commit 36dc73ce6fde46a93e6a5b4907e435b6dca60815 Author: Tobias Hansen <[email protected]> Date: Sat Sep 2 19:16:30 2017 +0100 Remove old user guide. --- debian/changelog | 2 + debian/higan.6 | 4 +- debian/higan.doc-base | 9 - debian/higan.docs | 2 - debian/icarus.6 | 2 +- debian/userguide/higan_user_guide.html | 321 ---------------- debian/userguide/higan_user_guide_byuu.html | 417 --------------------- .../higan_user_guide_files/cheat-database.png | Bin 34017 -> 0 bytes .../higan_user_guide_files/cheat-editor.png | Bin 45115 -> 0 bytes .../userguide/higan_user_guide_files/favicon.png | Bin 579 -> 0 bytes .../higan_user_guide_files/load-library.png | Bin 35108 -> 0 bytes .../higan_user_guide_files/main-window-gaming.png | Bin 32695 -> 0 bytes .../higan_user_guide_files/main-window.png | Bin 6220 -> 0 bytes .../higan_user_guide_files/settings-drivers.png | Bin 32106 -> 0 bytes .../higan_user_guide_files/settings-hotkeys.png | Bin 35452 -> 0 bytes .../higan_user_guide_files/settings-input.png | Bin 30100 -> 0 bytes .../higan_user_guide_files/settings-timing.png | Bin 25387 -> 0 bytes .../higan_user_guide_files/state-manager.png | Bin 28853 -> 0 bytes .../higan_user_guide_files/style-default.css | 137 ------- .../higan_user_guide_files_byuu/cheat-database.png | Bin 29869 -> 0 bytes .../higan_user_guide_files_byuu/cheat-editor.png | Bin 36780 -> 0 bytes .../higan_user_guide_files_byuu/favicon.png | Bin 579 -> 0 bytes .../higan_user_guide_files_byuu/load-import.png | Bin 28258 -> 0 bytes .../higan_user_guide_files_byuu/load-library.png | Bin 14941 -> 0 bytes .../main-window-gaming.png | Bin 13205 -> 0 bytes .../higan_user_guide_files_byuu/main-window.png | Bin 5637 -> 0 bytes .../settings-drivers.png | Bin 14784 -> 0 bytes .../settings-hotkeys.png | Bin 26236 -> 0 bytes .../higan_user_guide_files_byuu/settings-input.png | Bin 32073 -> 0 bytes .../settings-timing.png | Bin 22840 -> 0 bytes .../higan_user_guide_files_byuu/state-manager.png | Bin 22627 -> 0 bytes .../higan_user_guide_files_byuu/style-default.css | 137 ------- 32 files changed, 5 insertions(+), 1026 deletions(-) diff --git a/debian/changelog b/debian/changelog index 9b7ac1d..6f530b4 100644 --- a/debian/changelog +++ b/debian/changelog @@ -2,6 +2,8 @@ higan (104-1) UNRELEASED; urgency=medium * New upstream release. * Remove sjlj-ftbfs.patch (applied upstream). + * Remove old user guide since there is now an official user guide + provided online and linked from the Help menu. -- Tobias Hansen <[email protected]> Sat, 02 Sep 2017 18:46:23 +0100 diff --git a/debian/higan.6 b/debian/higan.6 index cef47ab..4f758bd 100644 --- a/debian/higan.6 +++ b/debian/higan.6 @@ -15,11 +15,11 @@ Bandai (WonderSwan, WonderSwan Color). .SH CONFIGURATION -Consult the user guide (see below) for information about higans configuration. +Consult the documentation (see below) for information about higans configuration. .SH SEE ALSO -higan User Guide: /usr/share/doc/higan/higan_user_guide.html +Official documentation at https://doc.byuu.org/higan/ .SH MORE INFO Website: http://byuu.org/emulation/higan/ diff --git a/debian/higan.doc-base b/debian/higan.doc-base deleted file mode 100644 index 45207d3..0000000 --- a/debian/higan.doc-base +++ /dev/null @@ -1,9 +0,0 @@ -Document: higan -Title: higan User Guide -Abstract: This manual describes how to configure and use higan. -Section: Emulators - -Format: HTML -Index: /usr/share/doc/higan/higan_user_guide.html -Files: /usr/share/doc/higan/higan_user_guide.html - /usr/share/doc/higan/higan_user_guide_files/* diff --git a/debian/higan.docs b/debian/higan.docs deleted file mode 100644 index e26b794..0000000 --- a/debian/higan.docs +++ /dev/null @@ -1,2 +0,0 @@ -debian/userguide/higan_user_guide.html -debian/userguide/higan_user_guide_files/ diff --git a/debian/icarus.6 b/debian/icarus.6 index cfc773b..570df70 100644 --- a/debian/icarus.6 +++ b/debian/icarus.6 @@ -13,7 +13,7 @@ invoked from higans Library menu. .SH SEE ALSO -higan User Guide: /usr/share/doc/higan/higan_user_guide.html +Official documentation at https://doc.byuu.org/higan/ .SH MORE INFO Website: http://byuu.org/emulation/higan/ diff --git a/debian/userguide/higan_user_guide.html b/debian/userguide/higan_user_guide.html deleted file mode 100644 index 2b0493c..0000000 --- a/debian/userguide/higan_user_guide.html +++ /dev/null @@ -1,321 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd";> -<html><head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> - <!-- base href="http://byuu.org/"; --> - <link href="higan_user_guide_files/favicon.png" rel="icon" type="image/png"> - <link href="higan_user_guide_files/style-default.css" rel="stylesheet" type="text/css"> - <!--[if IE]><style type='text/css'>* { zoom: 1; }</style><![endif]--> - <title>higan User Guide</title> - </head> - <body> - <div id="container"> - <div id="body"> - <h2>higan User Guide<span>2014-01-21</span></h2> - -<p>higan is rather different from most emulators. Please use this guide to -familiarize yourself with higan's features.</p> - -<h3>Getting Started: Game Boy Advance</h3> - -<p>Game Boy Advance emulation requires the BIOS ROM, which is copyrighted and -cannot be distributed with higan. Until you obtain this file, you will not be -able to play any Game Boy Advance games with higan.</p> - -<p>Since higan focuses on accuracy, there is no high-level emulation of the BIOS -as you might find in other emulators. To install the GBA BIOS, first copy the -GBA system folder and its content to higans config directory:</p> - -<pre>cp -r /usr/share/higan/Game\ Boy\ Advance.sys/ ~/.config/higan/</pre> - -<p>Now obtain the GBA BIOS, which should be 16384 bytes in size. Rename it to -"bios.rom", and place it inside "~/.config/higan/Game Boy Advance.sys".</p> - -<h3>Getting Started: Key Assignments</h3> - -<p>There is no default key assignments for -emulated input. You must go to Settings->Configuration->Input, and assign keys -for each system you wish to emulate.</p> - -<h3>Getting Started: Driver Selection</h3> - -<p><img src="higan_user_guide_files/settings-drivers.png" alt=""></p> - -<p>higan supports many video, audio and input drivers. It defaults to the most -conservative options.</p> - -<p>Linux users will find the OpenGL and ALSA drivers active by default. The OpenGL -driver requires OpenGL 3.2, which is currently only supported by the official -binary drivers from nVidia and AMD and the Intel driver in Mesa >= 10.0. -Failing this, you might try the X-Video driver, but it's not as nice. -The SDL driver was a necessary evil to work on any Linux setup out of the box, -but its performance is absolutely terrible.</p> - -<p>You can change driver settings via Settings->Configuration->Drivers. Once -you have changed drivers, you must restart higan for the changes to take effect. -</p> - -<h3>Getting Started: Audiovisual Timing</h3> - -<p><img src="higan_user_guide_files/settings-timing.png" alt=""></p> - -<p>Most emulators offer simplistic synchronization of video and audio. Although -your PC monitor usually runs at ~60hz, video game systems usually run at -~60.09hz, or other similar values. This has to be compensated for. Emulators -typically duplicate or drop frames to handle this, which results in choppy -scrolling every ten seconds or so, usually.</p> - -<p>higan is more difficult to set up, but provides much finer grained control. -It never duplicates or drops video frames or audio samples. Instead, it very -slightly adjusts the audio pitch (by less than 1% usually) to match your -specific monitor, video card, and sound card.</p> - -<p>higan also lets you choose whether to synchronize to the video refresh rate, -the audio refresh rate, or both. Choosing video only will give you smooth video -but choppy audio. Choosing audio only will give you choppy video but smooth -audio. Choosing both will give you smooth video and audio, but this requires you -to use the audiovisual synchronization tool first, in order to work.</p> - -<p>Check both "Synchronize Video" and "Synchronize Audio" under Settings, and -then go to Settings->Configuration->Timing. Click on the video "Analyze" button, -and wait. This will count how many frames your video card outputs per second -when synchronized to the vertical refresh, and show you an average at the bottom -on the window's status bar. The idea is that the longer you wait, the more -precise the value will become. I'd recommend waiting 300 samples, or five -minutes. You can often get by with less, but the longer you wait, the more -precise the value, which will help prevent video tearing and audio crackling. -Once you are ready, hit the "Stop" button, copy the value from the status bar -into the video text box, and hit "Assign". Now repeat this process for audio, -and you are all set. This only ever has to be done once.</p> - -<h4>Troubleshooting</h4> - -<p>Disable any desktop compositing. You may also have to -mess with nvidia-settings and/or xvattr settings. Some setups simply never allow -smooth video and audio at the same time. Linux is very hit or miss, with wildly -differing video drivers. I've had great luck on Debian Squeeze, and terrible -luck on Xubuntu 12.10.</p> - -<h3>Getting Started: Input Configuration</h3> - -<p><img src="higan_user_guide_files/settings-input.png" alt=""></p> - -<p>higan supports keyboards, mice and gamepads for input. Often times, you will -want to switch between using a keyboard and gamepad to play games. You can -configure an emulated controller to use both, by assinging multiple physical -inputs to each emulated input.</p> - -<p>The way this works is you double-click an item, and press the key or button -you wish to assign. Or for mice, click the button at the bottom of the window. -Each time you do this, it adds another mapping. If you want to erase all -mappings for one input, click erase. If you want to erase all mappings for all -inputs, click reset.</p> - -<p>Use the first combo box to select the system whose inputs you wish to -configure. Then use the second combo box to select the controller port you wish -to configure input devices for. Finally, use the third combo box to configure a -specific controller.</p> - -<p>On this screen, you can also tell higan to pause the emulator when the main -emulator window loses focus. Or you can allow input when the window does not -have focus. Typically, you don't want to allow input if you plan on using a -keyboard, but if you are using a gamepad this option could work for some cases -of multi-tasking. It's up to you.</p> - -<h3>Getting Started: Hotkey Configuration</h3> - -<p><img src="higan_user_guide_files/settings-hotkeys.png" alt=""></p> - -<p>higan allows configuration of various hotkeys. Unlike emulated inputs, -hotkeys work a bit differently. Instead of allowing multiple keys to trigger the -same action, hotkeys take a list of keys that all have to pressed to trigger the -action. For instace, you can require Alt+Enter to trigger fullscreen if you -like. The mapping works the same way as with the input settings window -otherwise.</p> - -<h3>The Main Window</h3> - -<p>Now that higan is configured, we can move on to emulating.</p> - -<p><img src="higan_user_guide_files/main-window.png" alt=""></p> - -<p>Here, you have your menubar, your video output window, and your status bar. -</p> - -<p>All windows in higan can be resized and repositioned however you like. higan -will remember the geometry of each window, and restore it to how you left it the -last time you ran the emulator.</p> - -<h3>Menubar Options</h3> - -<p>Settings->Video lets you control the video scaling. Center will keep the -image centered in the screen. This will put black borders around the edges, but -will keep the video output an even multiple of the original resolution. Scale -will allow you to increase the size to non-even multiples, but will keep black -bars on one side to maintain the correct aspect ratio. Stretch will fill the -entire video window no matter what. These settings apply to both windowed mode -and fullscreen mode. Aspect Correction will stretch the video to mimic the ratio -that you would see when playing games on real hardware. It is highly recommended -you leave this option on. Mask Overscan will black out the edges of the screen, -much as older CRT televisions would. You can control the exact amount of -overscan masking in the Settings->Configuration->Video settings panel. This is -mostly useful for Famicom games, where there is frequently garbled graphics on -the screen edges due to hardware limitations of the time.</p> - -<p>Settings->Shader lets you control the video filtering applied to the final -output image. None will give you crisp pixels, but doesn't look so great with -aspect correction enabled. Blur will smooth out the pixels. If you have video -shaders installed, you will see more options that you can choose from.</p> - -<p>Settings->Synchronize Video and Settings->Synchronize Audio tell the emulator -to wait for vertical refresh and/or the audio buffer. You should use one or the -other. If you follow the audiovisual timing setup above, you can try using both -at the same time.</p> - -<p>Settings->Mute Audio does exactly what it says.</p> - -<p>When you load a game, you are given access to a Tools menu as well.</p> - -<p>Here you can choose to create save states, or to restore them. You are given -five temporary slots. To be honest, the hotkeys are a lot more convenient for -this, but it's there in the menu as well.</p> - -<p>Tools->Resize Window will shrink the window to eliminate any black space on -the sides. Note that since each emulated system has different resolutions, you -will often then end up with black borders on another system. There's no way -around this, sorry. Also note that this option does not work with the Scale -video mode, for obvious reasons.</p> - -<p>Tools->State Manager and Tools->Cheat Editor will be described later.</p> - -<h3>Loading Games</h3> - -<p>Finally, the good part.</p> - -<p>higan treats your collection of games as a library. The first time you use -higan, your library will be empty. Going to Library->Super Famicom will prove -fruitless, with no games for you to select.</p> - -<p>In order to add games to your library, you have to import them from your -collection first.</p> - -<h3>Importing Games</h3> - -<p>To import games into your library, choose Library->Load ROM File... to import a single -game or Library->Import ROM Files... to import multiple ROMs. -Here, you can navigate and select any game for any system. It can be game -file, or a ZIP file with the game inside of it.</p> - -<p>Once selected, it will be imported into your library.</p> - -<h3>Using the Library</h3> - -<p>Many people like to have every game ever released. Yet they only play a small -fraction of the actual library. It's best to treat higan's library as a way to -play the games you actually care about. Not as a game collecting tool where you -have to have a 100% complete collection.</p> - -<p>Once a game has been imported, you can load it by choosing -Library->{Name of System}, eg Library->Super Famicom.</p> - -<p><img src="higan_user_guide_files/load-library.png" alt=""></p> - -<p>One nice feature of the library is that you get separate paths -that are remembered for each emulated system.</p> - -<p>Please note that you cannot load game files or ZIP archives directly from -the library. You must import them to get games into your library.</p> - -<h3>Playing Games</h3> - -<p>At long last, we have the emulator configured, and our games imported into -our library. And now it's time to game!</p> - -<p><img src="higan_user_guide_files/main-window-gaming.png" alt=""></p> - -<p>The status bar lets you know the frames per second, the title bar shows you -the name of the game you are playing.</p> - -<p>And now you have a new menu option for the system you are playing. In this -case, we have Super Famicom. From this menu, you can power cycle the system, -or hotplug other gamepads, or even unload the system.</p> - -<p>There's not much point in unloading a cartridge. You can simply load another -cartridge directly and higan will automatically unload the current cartridge for -you. But if you want to save CPU resources, and leave higan open, you can.</p> - -<h3>Tools: State Manager</h3> - -<p><img src="higan_user_guide_files/state-manager.png" alt=""></p> - -<p>In addition to save states, higan also has a state manager. The idea is that -sometimes you want transitive states that you overwrite constantly, and -sometimes you want to keep states around for a long time, and keep them nice and -organized. The state manager lets you accomplish the latter.</p> - -<p>In this example, we are building an archive of states before each boss fight -in Actraiser. Once complete, we can easily skip to every boss fight at any time. -The possibilities are endless, use this tool however you like, or not at all. -</p> - -<h3>Tools: Cheat Editor</h3> - -<p><img src="higan_user_guide_files/cheat-editor.png" alt=""></p> - -<p>Here, you can enter cheat codes. Game Genie, Pro Action Replay, etc.</p> - -<p>As you can see from the selection, you can build cheats from one or more -codes, separated by the + symbol. This lets you quickly turn on and off -multi-part cheat codes.</p> - -<h3>Tools: Cheat Database</h3> - -<p>At the bottom left, there's a Find Codes button. After selecting it, higan -will use its internal database of cheat codes to see if it can find any for the -game you are currently playing. There's thousands of games in the database, but -not every game has known cheats for it. If it does find any, you will be -presented with a list, and you can import any cheats you want. Far more -convenient than searching the web for cheats that may be for the wrong revision, -or the wrong country, of the game.</p> - -<p><img src="higan_user_guide_files/cheat-database.png" alt=""></p> - -<p>Select the code(s) you want, hit Add Codes, and you're done!</p> - -<p>The cheat database is graciously developed by the wonderful mightymo from the -forums at http://board.byuu.org; so if you have codes you'd like to see in the -database, feel free to reach out to him there.</p> - -<h3>Extra Settings</h3> - -<p>Settings->Configuration->Video will allow you to control how much video the Mask Overscan -option crops off.</p> - -<p>Settings->Configuration->Audio will let you adjust the audio volume. This is -nice as Nintendo systems typically have very low volume output compared to other -things. A setting of 200% can prove useful with little to no clamping of sample -range. You can also increase the frequency for more resampling precision, lower -the latency for faster audio response to input, and control the resampling -algorithm used. The Sinc audio resampler is incredibly demanding, consuming more -than half of the CPU power when emulating the NES and Game Boy, however it is -necessary to prevent some buzzing that you'll get in games such as Mega Man II -for the Famicom otherwise. If you really need more performance, you can go with -another sampler instead.</p> - -<h3>Advanced Extra Settings</h3> - -<p>For the power user, you can edit the settings.bml file in ~/.config/higan -to control even more settings. -</p> - -<p>Set Video::StartFullScreen to true if you want to use higan with an HTPC, and -want to load games from a launcher. You will need to remember the hotkey to exit -fullscreen if you use this setting, so make note of it first.</p> - - </div> - <div id="footer"> - <small>Copyright © 2004–2013 byuu, 2013-2014 Tobias Hansen</small> - </div> - </div> - - -</body></html> diff --git a/debian/userguide/higan_user_guide_byuu.html b/debian/userguide/higan_user_guide_byuu.html deleted file mode 100644 index 9ed1185..0000000 --- a/debian/userguide/higan_user_guide_byuu.html +++ /dev/null @@ -1,417 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd";> -<html><head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> - <!-- base href="http://byuu.org/"; --> - <link href="higan_user_guide_files_byuu/favicon.png" rel="icon" type="image/png"> - <link href="higan_user_guide_files_byuu/style-default.css" rel="stylesheet" type="text/css"> - <!--[if IE]><style type='text/css'>* { zoom: 1; }</style><![endif]--> - <title>higan User Guide</title> - </head> - <body> - <div id="container"> - <div id="body"> - <h2>higan User Guide<span>2013-01-12</span></h2> - -<p>higan is rather different from most emulators. Please use this guide to -familiarize yourself with higan's features.</p> - -<h3>Getting Started: Bits and Profiles</h3> - -<p>Right off the bat, you have many options. First, you can use the 32-bit -release, or the 64-bit release. If you have a 64-bit operating system, please -use the 64-bit release. It is approximately 10-15% faster than the 32-bit -release. If you have a 64-bit processor, please consider upgrading to a 64-bit -operating system. Otherwise, the 32-bit release should work.</p> - -<p>Next, you have three options for profiles. These currently only affect the -speed of the Super Famicom emulation. The other systems are the same regardless -of profile used.</p> - -<p>The accuracy profile is my personal favorite. It is extremely accurate, but -it is also extremely slow. On my Core i7 @ 4.4GHz, I get ~135fps on Zelda 3 -(best case), and ~65fps on the most intensive parts of Mega Man X3 (worst case.) -If you have an incredibly powerful, top of the line computer, this is what you -should use.</p> - -<p>The balanced profile tries to strike a middle ground between accuracy and -performance. It's still extremely accurate, far above any other Super Famicom -emulator. In this case, I get up to ~295fps with Zelda 3 on my system. This -version should work great on any Core or Athlon processor.</p> - -<p>The performance profile is for slower systems. It sacrifices accuracy to run -on slower systems. It's still more accurate than any other Super Famicom -emulator, but just barely. In this case, I get up to ~495fps with Zelda 3. I've -been able to play Zelda 3 at 80fps on my 1.6GHz Intel Atom with this profile. -</p> - -<p>If your computer is slower than a $199 netbook from 2007, and you cannot -upgrade it, then I sincerely apologize, but higan is not the emulator for you. -Even in its fastest profile, higan still puts accuracy as a top priority. I -would have to make too many sacrifices to target even slower hardware, and at -this point, there are already great emulators that target lower performance -hardware.</p> - -<h4>Linux Users</h4> - -<p>higan will automatically compile in 32-bit or 64-bit mode, depending on your -system. It defaults to the accuracy profile. You can override this with the -following commands:</p> - -<pre>make clean && make profile=accuracy -make clean && make profile=balanced -make clean && make profile=performance -</pre> - -<h3>Getting Started: Game Boy Advance</h3> - -<p>Game Boy Advance emulation requires the BIOS ROM, which is copyrighted and -cannot be distributed with higan. Until you obtain this file, you will not be -able to play any Game Boy Advance games with higan.</p> - -<p>Since higan focuses on accuracy, there is no high-level emulation of the BIOS -as you might find in other emulators.</p> - -<p>Obtain the GBA BIOS, which should be 16384 bytes in size. Rename it to -"bios.rom", and place it inside the "Game Boy Advance.sys" folder. Windows users -will find this folder next to the binaries. Linux users will find this folder in -~/.config/higan</p> - -<h3>Getting Started: Linux Users</h3> - -<p>Windows users can skip this section. The Windows binary releases work out of -the box.</p> - -<p>For Linux, you first have to build the software with the make command. Then -you have to install it with the make install command. make install is not -optional: it places needed files into required locations for you. If you do not -run make install, none of the emulators will work.</p> - -<p>Furthermore, if you want ananke, which is necessary to load game files and -ZIP archives directly, you must make and make install ananke as well as higan. -</p> - -<p>Lastly, unlike with Windows, there is no default key assignments for -emulated input. You must go to Settings->Configuration->Input, and assign keys -for each system you wish to emulate.</p> - -<h3>Getting Started: Driver Selection</h3> - -<p><img src="higan_user_guide_files_byuu/settings-drivers.png" alt=""></p> - -<p>higan supports many video, audio and input drivers. It defaults to the most -conservative options.</p> - -<p>Windows users will find Direct3D and DirectSound selected by default. I would -highly recommend installing official video card drivers from nVidia and AMD to -get proper OpenGL hardware acceleration. Do not use the ones bundled with -Windows, these drivers have terrible OpenGL support. By using OpenGL, you gain -access to many pixel shaders to enhance the video. I would also recommend -installing the latest version of DirectX and using the XAudio2 driver. This is -only required for Windows Vista and earlier. The XAudio2 driver handles buffer -underruns much more gracefully than DirectSound, it will become silent instead -of repeating a short sample over and over.</p> - -<p>Linux users will find the SDL and ALSA drivers active by default. Again, I -highly recommend installing the official binary drivers from nVidia and AMD, if -at all possible. The open source drivers such as nouveau offer terrible OpenGL -acceleration and will decimate performance. Failing this, you might try the -X-Video driver, but it's not as nice. The SDL driver was a necessary evil to -work on any Linux setup out of the box, but its performance is absolutely -terrible.</p> - -<p>You can change driver settings via Settings->Configuration->Drivers. Once -you have changed drivers, you must restart higan for the changes to take effect. -</p> - -<h3>Getting Started: Audiovisual Timing</h3> - -<p><img src="higan_user_guide_files_byuu/settings-timing.png" alt=""></p> - -<p>Most emulators offer simplistic synchronization of video and audio. Although -your PC monitor usually runs at ~60hz, video game systems usually run at -~60.09hz, or other similar values. This has to be compensated for. Emulators -typically duplicate or drop frames to handle this, which results in choppy -scrolling every ten seconds or so, usually.</p> - -<p>higan is more difficult to set up, but provides much finer grained control. -It never duplicates or drops video frames or audio samples. Instead, it very -slightly adjusts the audio pitch (by less than 1% usually) to match your -specific monitor, video card, and sound card.</p> - -<p>higan also lets you choose whether to synchronize to the video refresh rate, -the audio refresh rate, or both. Choosing video only will give you smooth video -but choppy audio. Choosing audio only will give you choppy video but smooth -audio. Choosing both will give you smooth video and audio, but this requires you -to use the audiovisual synchronization tool first, in order to work.</p> - -<p>Check both "Synchronize Video" and "Synchronize Audio" under Settings, and -then go to Settings->Configuration->Timing. Click on the video "Analyze" button, -and wait. This will count how many frames your video card outputs per second -when synchronized to the vertical refresh, and show you an average at the bottom -on the window's status bar. The idea is that the longer you wait, the more -precise the value will become. I'd recommend waiting 300 samples, or five -minutes. You can often get by with less, but the longer you wait, the more -precise the value, which will help prevent video tearing and audio crackling. -Once you are ready, hit the "Stop" button, copy the value from the status bar -into the video text box, and hit "Assign". Now repeat this process for audio, -and you are all set. This only ever has to be done once.</p> - -<h4>Troubleshooting</h4> - -<p>If you are using Windows Vista or Windows 7, you will want to disable the -Aero compositor. Use Google for instructions on how to do this. Aero's -compositor makes it impossible to get smooth video refreshes. If you are using -Windows 8, consider upgrading to Windows 7. Or if you simply cannot or will not -disable Aero, then you should uncheck synchronize video, and deal with the video -tearing. There's nothing else I can do to help you.</p> - -<p>If you are using Linux, disable any desktop compositing. You may also have to -mess with nvidia-settings and/or xvattr settings. Some setups simply never allow -smooth video and audio at the same time. Linux is very hit or miss, with wildly -differing video drivers. I've had great luck on Debian Squeeze, and terrible -luck on Xubuntu 12.10.</p> - -<h3>Getting Started: Input Configuration</h3> - -<p><img src="higan_user_guide_files_byuu/settings-input.png" alt=""></p> - -<p>higan supports keyboards, mice and gamepads for input. Often times, you will -want to switch between using a keyboard and gamepad to play games. You can -configure an emulated controller to use both, by assinging multiple physical -inputs to each emulated input.</p> - -<p>The way this works is you double-click an item, and press the key or button -you wish to assign. Or for mice, click the button at the bottom of the window. -Each time you do this, it adds another mapping. If you want to erase all -mappings for one input, click erase. If you want to erase all mappings for all -inputs, click reset.</p> - -<p>Use the first combo box to select the system whose inputs you wish to -configure. Then use the second combo box to select the controller port you wish -to configure input devices for. Finally, use the third combo box to configure a -specific controller.</p> - -<p>On this screen, you can also tell higan to pause the emulator when the main -emulator window loses focus. Or you can allow input when the window does not -have focus. Typically, you don't want to allow input if you plan on using a -keyboard, but if you are using a gamepad this option could work for some cases -of multi-tasking. It's up to you.</p> - -<h3>Getting Started: Hotkey Configuration</h3> - -<p><img src="higan_user_guide_files_byuu/settings-hotkeys.png" alt=""></p> - -<p>higan allows configuration of various hotkeys. Unlike emulated inputs, -hotkeys work a bit differently. Instead of allowing multiple keys to trigger the -same action, hotkeys take a list of keys that all have to pressed to trigger the -action. For instace, you can require Alt+Enter to trigger fullscreen if you -like. The mapping works the same way as with the input settings window -otherwise.</p> - -<h3>The Main Window</h3> - -<p>Now that higan is configured, we can move on to emulating.</p> - -<p><img src="higan_user_guide_files_byuu/main-window.png" alt=""></p> - -<p>Here, you have your menubar, your video output window, and your status bar. -</p> - -<p>All windows in higan can be resized and repositioned however you like. higan -will remember the geometry of each window, and restore it to how you left it the -last time you ran the emulator.</p> - -<h3>Menubar Options</h3> - -<p>Settings->Video lets you control the video scaling. Center will keep the -image centered in the screen. This will put black borders around the edges, but -will keep the video output an even multiple of the original resolution. Scale -will allow you to increase the size to non-even multiples, but will keep black -bars on one side to maintain the correct aspect ratio. Stretch will fill the -entire video window no matter what. These settings apply to both windowed mode -and fullscreen mode. Aspect Correction will stretch the video to mimic the ratio -that you would see when playing games on real hardware. It is highly recommended -you leave this option on. Mask Overscan will black out the edges of the screen, -much as older CRT televisions would. You can control the exact amount of -overscan masking in the Settings->Configuration->Video settings panel. This is -mostly useful for Famicom games, where there is frequently garbled graphics on -the screen edges due to hardware limitations of the time.</p> - -<p>Settings->Shader lets you control the video filtering applied to the final -output image. None will give you crisp pixels, but doesn't look so great with -aspect correction enabled. Blur will smooth out the pixels. If you have video -shaders installed, you will see more options that you can choose from.</p> - -<p>Settings->Synchronize Video and Settings->Synchronize Audio tell the emulator -to wait for vertical refresh and/or the audio buffer. You should use one or the -other. If you follow the audiovisual timing setup above, you can try using both -at the same time.</p> - -<p>Settings->Mute Audio does exactly what it says.</p> - -<p>When you load a game, you are given access to a Tools menu as well.</p> - -<p>Here you can choose to create save states, or to restore them. You are given -five temporary slots. To be honest, the hotkeys are a lot more convenient for -this, but it's there in the menu as well.</p> - -<p>Tools->Resize Window will shrink the window to eliminate any black space on -the sides. Note that since each emulated system has different resolutions, you -will often then end up with black borders on another system. There's no way -around this, sorry. Also note that this option does not work with the Scale -video mode, for obvious reasons.</p> - -<p>Tools->State Manager and Tools->Cheat Editor will be described later.</p> - -<h3>Loading Games</h3> - -<p>Finally, the good part.</p> - -<p>higan treats your collection of games as a library. The first time you use -higan, your library will be empty. Going to Library->Super Famicom will prove -fruitless, with no games for you to select.</p> - -<p>In order to add games to your library, you have to import them from your -collection first.</p> - -<h3>Importing Games</h3> - -<p>To import games into your library, choose Library->Import Game.</p> - -<p><img src="higan_user_guide_files_byuu/load-import.png" alt=""></p> - -<p>Here, you can navigate and select any game for any system. It can be game -file, or a ZIP file with the game inside of it.</p> - -<p>Once selected, it will be imported into your library and the game will begin -to play.</p> - -<h3>Ignoring the Library</h3> - -<p>If you don't like the idea of the game library, then simply ignore it. Use -Load->Import Game every single time. The first time you use it, your save games -will be imported as well. Subsequent loads will not overwrite your existing save -files, so there's no need to worry.</p> - -<h3>Using the Library</h3> - -<p>Many people like to have every game ever released. Yet they only play a small -fraction of the actual library. It's best to treat higan's library as a way to -play the games you actually care about. Not as a game collecting tool where you -have to have a 100% complete collection.</p> - -<p>Once a game has been imported, you can load it again by choosing -Load->{Name of System}, eg Load->Super Famicom.</p> - -<p><img src="higan_user_guide_files_byuu/load-library.png" alt=""></p> - -<p>One nice feature of the library is that not only do you get separate paths -that are remembered for each emulated system, it also remembers the last game -you played and will select it automatically.</p> - -<p>Please note that you cannot load game files or ZIP archives directly from -the library. You must use Import Game to get games into your library.</p> - -<h3>Playing Games</h3> - -<p>At long last, we have the emulator configured, and our games imported into -our library. And now it's time to game!</p> - -<p><img src="higan_user_guide_files_byuu/main-window-gaming.png" alt=""></p> - -<p>The status bar lets you know the frames per second, the title bar shows you -the name of the game you are playing.</p> - -<p>And now you have a new menu option for the system you are playing. In this -case, we have Super Famicom. From this menu, you can power cycle the system, -or hotplug other gamepads, or even unload the system.</p> - -<p>There's not much point in unloading a cartridge. You can simply load another -cartridge directly and higan will automatically unload the current cartridge for -you. But if you want to save CPU resources, and leave higan open, you can.</p> - -<h3>Tools: State Manager</h3> - -<p><img src="higan_user_guide_files_byuu/state-manager.png" alt=""></p> - -<p>In addition to save states, higan also has a state manager. The idea is that -sometimes you want transitive states that you overwrite constantly, and -sometimes you want to keep states around for a long time, and keep them nice and -organized. The state manager lets you accomplish the latter.</p> - -<p>In this example, we are building an archive of states before each boss fight -in Actraiser. Once complete, we can easily skip to every boss fight at any time. -The possibilities are endless, use this tool however you like, or not at all. -</p> - -<h3>Tools: Cheat Editor</h3> - -<p><img src="higan_user_guide_files_byuu/cheat-editor.png" alt=""></p> - -<p>Here, you can enter cheat codes. Game Genie, Pro Action Replay, etc.</p> - -<p>As you can see from the selection, you can build cheats from one or more -codes, separated by the + symbol. This lets you quickly turn on and off -multi-part cheat codes.</p> - -<h3>Tools: Cheat Database</h3> - -<p>At the bottom left, there's a Find Codes button. After selecting it, higan -will use its internal database of cheat codes to see if it can find any for the -game you are currently playing. There's thousands of games in the database, but -not every game has known cheats for it. If it does find any, you will be -presented with a list, and you can import any cheats you want. Far more -convenient than searching the web for cheats that may be for the wrong revision, -or the wrong country, of the game.</p> - -<p><img src="higan_user_guide_files_byuu/cheat-database.png" alt=""></p> - -<p>Select the code(s) you want, hit Add Codes, and you're done!</p> - -<p>The cheat database is graciously developed by the wonderful mightymo from the -forums at http://board.byuu.org; so if you have codes you'd like to see in the -database, feel free to reach out to him there.</p> - -<h3>Extra Settings</h3> - -<p>Settings->Configuration->Video will allow you to adjust the image saturation, -gamma, and luminance. It also lets you control how much video the Mask Overscan -option crops off.</p> - -<p>Settings->Configuration->Audio will let you adjust the audio volume. This is -nice as Nintendo systems typically have very low volume output compared to other -things. A setting of 200% can prove useful with little to no clamping of sample -range. You can also increase the frequency for more resampling precision, lower -the latency for faster audio response to input, and control the resampling -algorithm used. The Sinc audio resampler is incredibly demanding, consuming more -than half of the CPU power when emulating the NES and Game Boy, however it is -necessary to prevent some buzzing that you'll get in games such as Mega Man II -for the Famicom otherwise. If you really need more performance, you can go with -another sampler instead.</p> - -<p>Settings->Configuration->Server can be used to allow patched games to -communicate with a server on the internet. This allows for cool features like -uploading your high scores automatically, special internet-based events, etc. -For right now, there are no available patches, but in the future this should -prove to be quite fun.</p> - -<h3>Advanced Extra Settings</h3> - -<p>For the power user, you can edit the settings.cfg file to control even more -settings. Windows users should press Win+R, and type "%APPDATA%/higan" and press -enter. Linux users should go to ~/.config/higan. Open the file named -settings.cfg with a text editor. Preferably Notepad2 or Notepad++ on Windows. -</p> - -<p>Set Video::StartFullScreen to true if you want to use higan with an HTPC, and -want to load games from a launcher. You will need to remember the hotkey to exit -fullscreen if you use this setting, so make note of it first.</p> - - </div> - <div id="footer"> - <small>Copyright © 2004–2013 byuu</small> - </div> - </div> - - -</body></html> diff --git a/debian/userguide/higan_user_guide_files/cheat-database.png b/debian/userguide/higan_user_guide_files/cheat-database.png deleted file mode 100644 index 4b9660a..0000000 Binary files a/debian/userguide/higan_user_guide_files/cheat-database.png and /dev/null differ diff --git a/debian/userguide/higan_user_guide_files/cheat-editor.png b/debian/userguide/higan_user_guide_files/cheat-editor.png deleted file mode 100644 index ae0715b..0000000 Binary files a/debian/userguide/higan_user_guide_files/cheat-editor.png and /dev/null differ diff --git a/debian/userguide/higan_user_guide_files/favicon.png b/debian/userguide/higan_user_guide_files/favicon.png deleted file mode 100644 index 235a9da..0000000 Binary files a/debian/userguide/higan_user_guide_files/favicon.png and /dev/null differ diff --git a/debian/userguide/higan_user_guide_files/load-library.png b/debian/userguide/higan_user_guide_files/load-library.png deleted file mode 100644 index a1bb28d..0000000 Binary files a/debian/userguide/higan_user_guide_files/load-library.png and /dev/null differ diff --git a/debian/userguide/higan_user_guide_files/main-window-gaming.png b/debian/userguide/higan_user_guide_files/main-window-gaming.png deleted file mode 100644 index c21d1ce..0000000 Binary files a/debian/userguide/higan_user_guide_files/main-window-gaming.png and /dev/null differ diff --git a/debian/userguide/higan_user_guide_files/main-window.png b/debian/userguide/higan_user_guide_files/main-window.png deleted file mode 100644 index 538e29c..0000000 Binary files a/debian/userguide/higan_user_guide_files/main-window.png and /dev/null differ diff --git a/debian/userguide/higan_user_guide_files/settings-drivers.png b/debian/userguide/higan_user_guide_files/settings-drivers.png deleted file mode 100644 index 22096c5..0000000 Binary files a/debian/userguide/higan_user_guide_files/settings-drivers.png and /dev/null differ diff --git a/debian/userguide/higan_user_guide_files/settings-hotkeys.png b/debian/userguide/higan_user_guide_files/settings-hotkeys.png deleted file mode 100644 index b6cd99a..0000000 Binary files a/debian/userguide/higan_user_guide_files/settings-hotkeys.png and /dev/null differ diff --git a/debian/userguide/higan_user_guide_files/settings-input.png b/debian/userguide/higan_user_guide_files/settings-input.png deleted file mode 100644 index d13cad7..0000000 Binary files a/debian/userguide/higan_user_guide_files/settings-input.png and /dev/null differ diff --git a/debian/userguide/higan_user_guide_files/settings-timing.png b/debian/userguide/higan_user_guide_files/settings-timing.png deleted file mode 100644 index 0e52503..0000000 Binary files a/debian/userguide/higan_user_guide_files/settings-timing.png and /dev/null differ diff --git a/debian/userguide/higan_user_guide_files/state-manager.png b/debian/userguide/higan_user_guide_files/state-manager.png deleted file mode 100644 index be7c484..0000000 Binary files a/debian/userguide/higan_user_guide_files/state-manager.png and /dev/null differ diff --git a/debian/userguide/higan_user_guide_files/style-default.css b/debian/userguide/higan_user_guide_files/style-default.css deleted file mode 100644 index 808bbaf..0000000 --- a/debian/userguide/higan_user_guide_files/style-default.css +++ /dev/null @@ -1,137 +0,0 @@ -a { - color: #000; - text-decoration: none; -} - -a[href] { - color: #00c; -} - -a[href*="://"] { - color: #082; -} - -a[href]:hover { - color: #f00; - text-decoration: underline; -} - -body { - height: 101%; - margin: 1.5em; -} - -h1, h2, h3, h4, h5, h6 { - font: 1.0em "Georgia", "Times New Roman", serif; - font-weight: bold; - margin: 0em; - position: relative; -} - -h1 span, h2 span, h3 span, h4 span, h5 span, h6 span { - bottom: 0em; - position: absolute; - right: 0em; -} - -h1 { - font-family: "Times New Roman", serif; - font-size: 3em; - font-weight: normal; - margin-bottom: 0.25em; -} - -h2 { - border-bottom: 3px double #aaa; - font-size: 1.9em; - margin-bottom: 0.5em; -} - -h3 { - border-bottom: 1px dotted #aaa; - font-size: 1.3em; - margin-bottom: 0.25em; -} - -h4 { - margin-bottom: 0.25em; -} - -p { - margin: 0em; - margin-bottom: 1em; -} - -pre { - background: #fee; - border: 1px dashed #888; - padding: 0.5em; -} - -table { - border-collapse: collapse; -} - -table tr th, table tr td { - border: 1px dashed #aaa; - padding: 0.35em; - text-align: left; -} - -ul { - list-style-position: outside; - list-style-type: circle; - margin: 0em 0em 1em 1.2em; - padding: 0em; -} - -ul li { - margin: 0em; - padding: 0em; -} - -#container { - border-radius: 1em; - -moz-border-radius: 1em; - -webkit-border-radius: 1em; - box-shadow: 0em 0em 1em #000; - -moz-box-shadow: 0em 0em 1em #000; - -webkit-box-shadow: 0em 0em 1em #000; - font: 0.8em / 1.3em "Verdana", sans-serif; - padding: 1em; -} - -#navigation { - background: -moz-linear-gradient(100% 100% 90deg, #f7f7f7, #ffffff); - background: -webkit-gradient(linear, left top, left bottom, from(#ffffff), to(#f7f7f7)); - border: 1px solid #ddd; - display: table; - margin-bottom: 1em; -} - -#navigation div { - border-right: 1px solid #ddd; - display: table-cell; - padding: 0.5em; - padding-right: 2em; -} - -#navigation div:last-of-type { - border-right: none; - width: 100%; -} - -#navigation div > a { - border-bottom: 1px solid #ddd; -} - -#navigation div ul { - list-style-type: none; - margin: 0em; - padding-left: 0.5em; -} - -#footer { - border-top: 1px solid #eee; - padding-top: 0.5em; -} diff --git a/debian/userguide/higan_user_guide_files_byuu/cheat-database.png b/debian/userguide/higan_user_guide_files_byuu/cheat-database.png deleted file mode 100644 index a2d7ed0..0000000 Binary files a/debian/userguide/higan_user_guide_files_byuu/cheat-database.png and /dev/null differ diff --git a/debian/userguide/higan_user_guide_files_byuu/cheat-editor.png b/debian/userguide/higan_user_guide_files_byuu/cheat-editor.png deleted file mode 100644 index d99fec9..0000000 Binary files a/debian/userguide/higan_user_guide_files_byuu/cheat-editor.png and /dev/null differ diff --git a/debian/userguide/higan_user_guide_files_byuu/favicon.png b/debian/userguide/higan_user_guide_files_byuu/favicon.png deleted file mode 100644 index 235a9da..0000000 Binary files a/debian/userguide/higan_user_guide_files_byuu/favicon.png and /dev/null differ diff --git a/debian/userguide/higan_user_guide_files_byuu/load-import.png b/debian/userguide/higan_user_guide_files_byuu/load-import.png deleted file mode 100644 index a89996a..0000000 Binary files a/debian/userguide/higan_user_guide_files_byuu/load-import.png and /dev/null differ diff --git a/debian/userguide/higan_user_guide_files_byuu/load-library.png b/debian/userguide/higan_user_guide_files_byuu/load-library.png deleted file mode 100644 index 7679cfc..0000000 Binary files a/debian/userguide/higan_user_guide_files_byuu/load-library.png and /dev/null differ diff --git a/debian/userguide/higan_user_guide_files_byuu/main-window-gaming.png b/debian/userguide/higan_user_guide_files_byuu/main-window-gaming.png deleted file mode 100644 index 0045836..0000000 Binary files a/debian/userguide/higan_user_guide_files_byuu/main-window-gaming.png and /dev/null differ diff --git a/debian/userguide/higan_user_guide_files_byuu/main-window.png b/debian/userguide/higan_user_guide_files_byuu/main-window.png deleted file mode 100644 index 9d97a2b..0000000 Binary files a/debian/userguide/higan_user_guide_files_byuu/main-window.png and /dev/null differ diff --git a/debian/userguide/higan_user_guide_files_byuu/settings-drivers.png b/debian/userguide/higan_user_guide_files_byuu/settings-drivers.png deleted file mode 100644 index 4717a37..0000000 Binary files a/debian/userguide/higan_user_guide_files_byuu/settings-drivers.png and /dev/null differ diff --git a/debian/userguide/higan_user_guide_files_byuu/settings-hotkeys.png b/debian/userguide/higan_user_guide_files_byuu/settings-hotkeys.png deleted file mode 100644 index 64b4ef5..0000000 Binary files a/debian/userguide/higan_user_guide_files_byuu/settings-hotkeys.png and /dev/null differ diff --git a/debian/userguide/higan_user_guide_files_byuu/settings-input.png b/debian/userguide/higan_user_guide_files_byuu/settings-input.png deleted file mode 100644 index 21c3933..0000000 Binary files a/debian/userguide/higan_user_guide_files_byuu/settings-input.png and /dev/null differ diff --git a/debian/userguide/higan_user_guide_files_byuu/settings-timing.png b/debian/userguide/higan_user_guide_files_byuu/settings-timing.png deleted file mode 100644 index bebf022..0000000 Binary files a/debian/userguide/higan_user_guide_files_byuu/settings-timing.png and /dev/null differ diff --git a/debian/userguide/higan_user_guide_files_byuu/state-manager.png b/debian/userguide/higan_user_guide_files_byuu/state-manager.png deleted file mode 100644 index b5970f1..0000000 Binary files a/debian/userguide/higan_user_guide_files_byuu/state-manager.png and /dev/null differ diff --git a/debian/userguide/higan_user_guide_files_byuu/style-default.css b/debian/userguide/higan_user_guide_files_byuu/style-default.css deleted file mode 100644 index 808bbaf..0000000 --- a/debian/userguide/higan_user_guide_files_byuu/style-default.css +++ /dev/null @@ -1,137 +0,0 @@ -a { - color: #000; - text-decoration: none; -} - -a[href] { - color: #00c; -} - -a[href*="://"] { - color: #082; -} - -a[href]:hover { - color: #f00; - text-decoration: underline; -} - -body { - height: 101%; - margin: 1.5em; -} - -h1, h2, h3, h4, h5, h6 { - font: 1.0em "Georgia", "Times New Roman", serif; - font-weight: bold; - margin: 0em; - position: relative; -} - -h1 span, h2 span, h3 span, h4 span, h5 span, h6 span { - bottom: 0em; - position: absolute; - right: 0em; -} - -h1 { - font-family: "Times New Roman", serif; - font-size: 3em; - font-weight: normal; - margin-bottom: 0.25em; -} - -h2 { - border-bottom: 3px double #aaa; - font-size: 1.9em; - margin-bottom: 0.5em; -} - -h3 { - border-bottom: 1px dotted #aaa; - font-size: 1.3em; - margin-bottom: 0.25em; -} - -h4 { - margin-bottom: 0.25em; -} - -p { - margin: 0em; - margin-bottom: 1em; -} - -pre { - background: #fee; - border: 1px dashed #888; - padding: 0.5em; -} - -table { - border-collapse: collapse; -} - -table tr th, table tr td { - border: 1px dashed #aaa; - padding: 0.35em; - text-align: left; -} - -ul { - list-style-position: outside; - list-style-type: circle; - margin: 0em 0em 1em 1.2em; - padding: 0em; -} - -ul li { - margin: 0em; - padding: 0em; -} - -#container { - border-radius: 1em; - -moz-border-radius: 1em; - -webkit-border-radius: 1em; - box-shadow: 0em 0em 1em #000; - -moz-box-shadow: 0em 0em 1em #000; - -webkit-box-shadow: 0em 0em 1em #000; - font: 0.8em / 1.3em "Verdana", sans-serif; - padding: 1em; -} - -#navigation { - background: -moz-linear-gradient(100% 100% 90deg, #f7f7f7, #ffffff); - background: -webkit-gradient(linear, left top, left bottom, from(#ffffff), to(#f7f7f7)); - border: 1px solid #ddd; - display: table; - margin-bottom: 1em; -} - -#navigation div { - border-right: 1px solid #ddd; - display: table-cell; - padding: 0.5em; - padding-right: 2em; -} - -#navigation div:last-of-type { - border-right: none; - width: 100%; -} - -#navigation div > a { - border-bottom: 1px solid #ddd; -} - -#navigation div ul { - list-style-type: none; - margin: 0em; - padding-left: 0.5em; -} - -#footer { - border-top: 1px solid #eee; - padding-top: 0.5em; -} -- Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-games/higan.git _______________________________________________ Pkg-games-commits mailing list [email protected] http://lists.alioth.debian.org/cgi-bin/mailman/listinfo/pkg-games-commits
