From 993f6ef92784041f1f696ab79a003cca5e3a7dff Mon Sep 17 00:00:00 2001 From: Brandon Wright Date: Tue, 26 Feb 2019 16:36:05 -0600 Subject: [PATCH] Update some documents. --- LICENSE | 1 + gtk/src/snes9x.ui | 1 + win32/docs/faqs-windows.txt | 2 +- win32/docs/how2compile.txt | 26 +++++++++++++-------- win32/docs/readme-windows.txt | 44 ++++++++++++++++++++++------------- 5 files changed, 47 insertions(+), 27 deletions(-) diff --git a/LICENSE b/LICENSE index 1c929df4..59717e3a 100644 --- a/LICENSE +++ b/LICENSE @@ -164,6 +164,7 @@ Snes9x homepage: http://www.snes9x.com/ + Snes9x source code: https://github.com/snes9xgit/snes9x/ Permission to use, copy, modify and/or distribute Snes9x in both binary and source form, for non-commercial purposes, is hereby granted without diff --git a/gtk/src/snes9x.ui b/gtk/src/snes9x.ui index 202ba67d..e41564c8 100644 --- a/gtk/src/snes9x.ui +++ b/gtk/src/snes9x.ui @@ -9045,6 +9045,7 @@ Snes9x - Portable Super Nintendo Entertainment System (TM) emulator. Snes9x homepage: http://www.snes9x.com/ + Snes9x source code: https://github.com/snes9xgit/snes9x/ Permission to use, copy, modify and/or distribute Snes9x in both binary and source form, for non-commercial purposes, is hereby granted without diff --git a/win32/docs/faqs-windows.txt b/win32/docs/faqs-windows.txt index 1dac66cd..fe1b92c1 100644 --- a/win32/docs/faqs-windows.txt +++ b/win32/docs/faqs-windows.txt @@ -31,7 +31,7 @@ addressed. Being able to input the diagonals can help hinder that occurrence. It can also make keyboard usage a bit easier... assigning the directional controls to the number pad for instance. -Q: I gotsid me a translation patch (.ips) for my game. Now what do I do so I can +Q: I have a translation patch (.ips) for my game. Now what do I do so I can use it? A: Make sure both your ROM image and .ips file are in the same folder. Finally make sure they have the exact same name (minus file extensions, of course). As diff --git a/win32/docs/how2compile.txt b/win32/docs/how2compile.txt index dfecf9e0..05c3695a 100644 --- a/win32/docs/how2compile.txt +++ b/win32/docs/how2compile.txt @@ -9,18 +9,24 @@ NOTE: Unicode support requires a special zlib build - see the end of the zlib en - A recent DirectX SDK.. https://www.microsoft.com/en-us/download/details.aspx?id=23549 -- DirecXMath. The source files should reside in win32/DirectXMath, or you can download them - automatically with "git submodule update --init". +- The following modules can all be downloaded automatically by using: + git submodule update --init + in the cloned Snes9x git directory, or by using git GUI tools to do the same. + This is the recommended method of installing these dependencies. -- zlib (optional, ZLIB define, enabled by default) - the default solution includes a zlib - project that builds appropriately (force includes _tfwopen.h for unicode support in s9x). - The zlib source files should reside in win32/zlib/src, or you can download them automatically - with "git submodule update --init". + * DirectXMath. The source files should reside in win32/DirectXMath -- libpng (optional, HAVE_LIBPNG define, enabled by default) - the default solution includes - a libpng project that builds appropriately. - The libpng source files should reside in win32/libpng/src, or you can download them automatically - with "git submodule update --init". + * zlib (optional, ZLIB define, enabled by default) - the default solution includes a zlib + project that builds appropriately (force includes _tfwopen.h for unicode support in s9x). + The zlib source files should reside in win32/zlib/src + + * libpng (optional, HAVE_LIBPNG define, enabled by default) - the default solution includes + a libpng project that builds appropriately. + The libpng source files should reside in win32/libpng/src + + * glslang (optional, USE_SLANG define, enabled by default) - the default solution includes + a series of projects encompassing glslang that build appropriately. + The glslang source files should reside in win32/glslang/src - To compile Snes9x: Start up VS2017. diff --git a/win32/docs/readme-windows.txt b/win32/docs/readme-windows.txt index 1e1eadcf..11cf1785 100644 --- a/win32/docs/readme-windows.txt +++ b/win32/docs/readme-windows.txt @@ -9,7 +9,7 @@ Files included in the Snes9x archive: version 1.59 February, 2019 Home page: http://www.snes9x.com/ - +Source code: https://github.com/snes9xgit/snes9x/ Contents @@ -112,7 +112,7 @@ is displayed. This will help to find out what the problem is. These colors do NOT signify whether a game will work or not. It is just a means for reference so we can understand what may or may not be a problem. Most often -the problem with games that don't work is that they are corrupt or are a bad dump +the problem with games that don't work is that they are corrupt or are a bad dump and should be redumped. SNES Joypad Emulation @@ -171,10 +171,16 @@ https://github.com/libretro/common-shaders GLSL Shaders -------- -Support for GLSL shaders is available when using OpenGL. A number can be +Support for GLSL shaders is available when using OpenGL. A number can be obtained from the libretro glsl-shaders repository: https://github.com/libretro/glsl-shaders +Slang Shaders +-------- +Slang shaders may also be used with OpenGL. The primary location to get these +is the libretro slang-shaders repository: +https://github.com/libretro/slang-shaders + Controllers Support =================== @@ -608,8 +614,8 @@ the extension of the freeze files. Compatibility with Other SNES Emulators --------------------------------------- Cheat files (.cht) are common between Snes9x and higan/bsnes. higan stores -these as cheats.bml in the higan subdirectory of a game folder. -RTC files (.rtc) are common between Snes9x and bsnes. +these as cheats.bml in the higan subdirectory of a game folder. +RTC files (.rtc) are common between Snes9x and bsnes. SRAM files (.srm) should be common among all SNES emulators. @@ -647,22 +653,28 @@ Problems with Sound ------------------- No sound coming from any SNES game using Snes9x? Could be any or all of these: -- If all sound menu options are grayed out, or an error dialog about Snes9x not - being able to initialize DirectSound is displayed - then DirectSound could not - initialize itself. Make sure DirectX 6 or above is installed and your sound - card is supported by DirectX. Installing the latest drivers for your sound card might help. Another Windows - application might have opened DirectSound in exclusive mode or opened the - Windows WAVE device - WinAmp uses the Windows WAVE device by default - in - which case you will need to stop that application and then restart Snes9x. It - is possible to switch WinAmp to use DirectSound, in which case both Snes9x and - WinAmp output can be heard at the same time. + application might be holding exclusive access to the sound card - in + which case you will need to stop that application and then restart Snes9x. - The sound card's volume level might be set too low. Snes9x doesn't alter the card's master volume level so you might need to adjust it using the sound card's mixer/volume controls usually available from the task bar or start menu. - Make sure your speakers and turned on, plugged in and the volume controls are set to a suitable level. +- If experiencing crackling, try the following in the Sound Settings dialog: + * Ensure the "Synchronize with sound core" option is enabled. + * Increase the buffer size. + * Switch the sound driver from WaveOut to XAudio2 or vice-versa. + * If "Automatic Input Rate" option is disabled, enable it. Otherwise, + disable it and lower the "Input Rate" value in steps of 10 until the + crackling goes away. + * Enable the "Dynamic Rate Control" option. + * Change the "Playback Rate" to 48000Hz. Versions of Windows since Vista + have included a sound server that controls audio. It usually runs at + 48000Hz, and matching this means Windows doesn't try to convert it. + Contrary to other advice, running at 32000Hz does NOT provide any + benefits. @@ -824,6 +836,6 @@ Konami and Justifier are trademarks of Konami Corp. Hudson is a trademark of Husdon Soft Co., Ltd. Capcom is a trademark of Capcom Co., Ltd. -Gary Henderson +This document was originally authored by Gary Henderson -Updated most recently: 2018/11/8 +Updated most recently: 2019/2/26