Documentation Stuff

[Deathlike2]

I will list the current problems in the CVS Documentation files.. and edit/add to this post when I find something... feel free to comment and blah.

readme.htm

System Requirements -> Win Port

Windows NT doesn't support anything more than DX3... so NT should be out of the picture (unless someone manages to run ZSNES on it).

System Requirements -> DOS Port

- Video card that supports VESA 2 or better (you might need a Scitech Display Doctor for older cards)

It is suggested to remove the section in bold.

Things To Know -> General

- To use the cheat function, be sure to have the ROM which you want to patch loaded already.

The statement could be phrased better.

Suggestion:

To use the cheat function, be sure to have the ROM loaded into memory first.

Things To Know -> DOS Port Specific

- If your Sidewinder support doesn't work, a quick way of getting it to is to fully disable the Windows driver from the Control Panel.

I presume it is under the assumption that you are running the DOS version within Windows... which should preface this tip.

- To view 512 resolutions properly, use 640x480 mode. Only a few games use 512 resolution. One way to find out if a game has that feature is to look for text that looks squished.

This is not DOS specific. Instead of referring to these resolutions as 512.. it may be preferable to use the common term "hires". It may be a good idea to use Secret of Mana as an example.

Current Progress -> The following are implemented...

The ROM formats should link to a website that gives some info on it (I'm sure someone has a website explaining them)..

Current Progress -> What will not run (or play properly)

Isn't DSP-3 not emulated? It needs to be mentioned here...

Extra Features

JMA needs a link

Default Keys

The information that F1 and ESC are unchangable should be noted clearly in a separate statement.

There should be some consideration to group the default keys by the menus they correspond to... as the GUI has evolved a lot to accompany that.

Cheat Codes

It may be an idea to add a slight description between the different cheat code types... (who made them, etc.)

Note: Some cheat codes are meant to be for different versions of the game.

Suggested change
Note: Some cheat codes are meant to be for different versions of the same game.

Universal Switches

-y should be called interpolation (bilinear filtering)... blurring != anti-aliasing

DOS Only Switches

The modes that are tagged VESA1/VESA2 should have a special note to them. The lone VESA1 mode works with most video cards but is terribly slow. The VESA2 modes should reference Scitech Display Doctor (of course certain video cards already support it natively). It should be noted that the modes will fail to work if you do not have VESA2 support.

[Nach]

Windows NT doesn't support anything more than DX3... so NT should be out of the picture (unless someone manages to run ZSNES on it).

Wrong. Windows NT supports DX9c, in fact most people here I understand are using ZSNESW under Windows NT 5.1.

[Jipcy]

Windows NT doesn't support anything more than DX3... so NT should be out of the picture (unless someone manages to run ZSNES on it).

Wrong. Windows NT supports DX9c, in fact most people here I understand are using ZSNESW under Windows NT 5.1.

Nach, I'm always amazed at your love of specificity. It goes even beyond my own.

He was probably talking about "Windows NT 4", which is what most people mean when they say "Windows NT". Windows NT 5.1 has a much more common name: "Windows XP".

[Deathlike2]

Wrong. Windows NT supports DX9c, in fact most people here I understand are using ZSNESW under Windows NT 5.1.

NT when used by itself generally means NT 4. That OS only supports DX3.

2K is also referred to as NT5, XP is referred to NT5.1.

2K/XP are based off of NT, but they are different because they support future versions of DX (which the original NT was limited to only DX3)

http://www.ntcompatible.com/faq-2.html
http://www.computerhope.com/whow.htm

[Nach]

Nach, I'm always amazed at your love of specificity. It goes even beyond my own.

Thank you

He was probably talking about "Windows NT 4", which is what most people mean when they say "Windows NT". Windows NT 5.1 has a much more common name: "Windows XP".

Yes, but the docs don't say NT 4, they say NT.

[Nach]

Wrong. Windows NT supports DX9c, in fact most people here I understand are using ZSNESW under Windows NT 5.1.

NT when used by itself generally means NT 4. That OS only supports DX3.

2K is also referred to as NT5, XP is referred to NT5.1.

2K/XP are based off of NT, but they are different because they support future versions of DX (which the original NT was limited to only DX3)

http://www.ntcompatible.com/faq-2.html
http://www.computerhope.com/whow.htm

Windows NT is Windows NT, it's the Windows which use the NT kernel as opposed to the DOS kernel, you can see an official timeline here:
http://www.microsoft.com/windows/WinHis ... aphic.mspx

XP is not referred to as NT 5.1, it is NT 5.1.

[Deathlike2]

Wrong. Windows NT supports DX9c, in fact most people here I understand are using ZSNESW under Windows NT 5.1.

NT when used by itself generally means NT 4. That OS only supports DX3.

2K is also referred to as NT5, XP is referred to NT5.1.

2K/XP are based off of NT, but they are different because they support future versions of DX (which the original NT was limited to only DX3)

http://www.ntcompatible.com/faq-2.html
http://www.computerhope.com/whow.htm

Windows NT is Windows NT, it's the Windows which use the NT kernel as opposed to the DOS kernel, you can see an official timeline here:
http://www.microsoft.com/windows/WinHis ... aphic.mspx

XP is not referred to as NT 5.1, it is NT 5.1.

Fine. I'm only saying that using the term Windows NT as termed in the ZSNES doc requirements, is misleading. I'm not saying someone with Windows NT(4) will try to run ZSNES anytime soon, but it is best not to confuse people that it is able to run under the older varients of the NT kernel. Requirements for 2000/XP is universal to most people.

[Deathlike2]

Onto to next thing - most of the changes will probably be more user friendly and less technical:

gui.htm

GUI

Note: Pressing Esc when no window is active is equivalent to RUN. It will not function if no game is loaded.

Shouldn't it be phrased better? The use of RUN is kinda understood.. but not entirely clear.

Something like "Pressing ESC when no window is active will continue emulation if a ROM is loaded. It will do nothing otherwise."

Game Menu -> Load

Perform: Loads and runs a file.

It should just say "Loads a ROM into memory and starts emulation."

Note: Compressed files will not display the header name; it's not efficient for the program to uncompress every ROM in the directory just to get the header names.

This seems somewhat unclear. (Uncompress is not the correct word, it's decompress.)

Perhaps it should say something like..

Compressed files will not display a header name; it is inefficent for the program to decompress every ROM in any of the supported compressed file formats in order to get the header names.

Game Menu -> Save State

It should be noted that each savestate is 260kb. It currently sounds like the whole savestate collection is 260kb total.

Quick Menu -> Numbers

Don't use the title numbers.. change it to something like "Last 10 Loaded ROMs List" or something..

Config Menu -> Chip Cfg

A better description should be provided. Even I still don't know what to make of that feature. I would need to know what it is used for (developer tool?) and whether I should mess with such a feature.

Config Menu -> Options

New Graphics Engine - it should be noted that it should be on by default, and it should be toggled on/off if either mode produces visual problems
MMX Support - it should be noted that it also affect some audio filters as well.. When disabled, options that used MMX will also automatically be disabled and hidden from the GUI
FPS at Program Start - it should be noted it is only useful when combined with auto-frame skip enabled
Enable Game Clock - it should be noted that it eats up some "real-estate".. unless that can be reclaimed in the near future...
Enable Auto-Patch - it needs to reference/link to the FAQ to show how it works properly
Pause Emu in Background - I forget when this was introduced, it is currently missing in the docs... anyways, I'm guessing that when checked, the emulator stops running while running in the background... by default, the emulator continues to run if it's not in the menu.. this option allows for the emulator to be paused without the need of being in the menu (must've been some feature request)

Config Menu -> Video Options

Perform: Changes the current video mode and sets some options.

It should say that it allows you to change the current video mode and select video filters and other video options.

Interpolation and Bilinear filtering should be one and the same, unless there's some difference in the implementation (their names in the respective ports can still be stated, but their purpose is really the same).

Hi-Res Mode 7

In other words, it just doubles the mode 7 pixels.

It may be better to say, it doubles the number of pixels when Mode 7 is being used.

Triple Buffering - Uses an extra buffer for drawing. Thus, a buffer can be drawn on while one is pending Vsync, and another is being drawn. The primary use is to reduce the impact of Vsync on slower systems. This feature is not available in the SDL port.

Unless the SDL/DOS Port is different, Triple Buffering is not available under any of the Windowed mode.

Config Menu -> Sound

Enable Sound - note that this is enabled by default
Stereo Sound - note that this is also enabled by default.. the word slow should be used instead of "slower" due to grammar...
Sampling Rate - it should also be noted that there is a problem running a faster rate than the original SNES rate
Use Primary Buffer - it is suggested you remove the word Microsoft in it (DirectSound generally suggests M$ anyways)
Sound Interpolation - Gaussian - it needs to be noted that this is enabled by default
Sound Interpolation - 8-point Interpolation - it should be noted that it requires MMX to be available/used
Low Pass Filter - Hi Quality - it should be noted that it requires MMX to be available/used

Config Menu -> Paths
Usage -> Saves - it should be noted that it also loads saves/savestates from that directory as well

Config Menu -> Saves
Auto increment save slot - it should be noted that it is useful if it happens that you accidentally saved a savestate when you didn't want to and you can revert to an older savestate (I've seen some forum posts just on this very topic)

Cheat Menu -> Browse
Usage -> Actions -> Save/Load - it should be noted what the name of the cht file will be labeled as... now that I think of it, it should be explained for savestate files as well

Misc Menu -> GUI Options
Transparent messages -> It should be noted that this also affects the frame rate counter and that small text messages overrides this...

Misc Menu -> About
It should be noted that it now provides links to the ZSNES website and documentation...

[Deathlike2]

netplay.htm

Netplay -> System Recommendations for Smooth Netplay

The only issue I disagree with is the statement.

- Both users must use the same protocol setting (either UDP or TCP). It is recommended that both use UDP; without it, lost packets can cause lots of in-game pauses in your Netplay experience.

It should be recommended that both use TCP. UDP should be recommended on a LAN setting. TCP should be used for everything else.

TCP is the protocol used for guarenteeing delivery of packets to the other end (as much as possible)... retransmission is part of its protocol. UDP is the "dumb" protocol where you send a packet off into the wild and hope it gets picked up.

UDP:
http://en.wikipedia.org/wiki/User_Datagram_Protocol

TCP:
http://en.wikipedia.org/wiki/Transmissi ... l_Protocol

Unless ZSNES netplay is improved a lot, TCP is the best protocol in most cases.

[Deathlike2]

bugs.htm

Ah.. the good stuff.

For the bug reports section, it needs to be noted what chips (and the games that use them) are not emulated so you don't get those posts.

Note that when cheats are used whether they don't work (Game Genie codes for different ROM versions) or they are in effect, they cannot be used in a bug report. I remember a silly bug report in both Snes9x and ZSNES forums on a bug that didn't exist because a Game Genie code was in effect. This will also rid of those people that complain about the cheat codes that don't work (FF3 is a prime example).

IPS patches should be handled similarly to cheats. Sometimes IPS patches introduce bugs themselves and should be noted if used. One of the IPS patches I use is an awesome hack, but produces a visual bug in the game (very noticable) but it isn't visible when the patch is not applied.

The ROM's CRC32 is an 8-digit HEX number.

CVS should not be mentioned anymore I think.. I'm sure the transition from CVS to SVN is complete.

For the system specs section, you need to note that users should have installed the required components (DX, NASM, whatever) before reporting a bug (like someone using DX7 trying to run the current version of ZSNES).

Screenshots and savestates need to be linked to a relevent section of existing info.. Screenshots can be taken in two different methods (F1 - Screenshot function and Printscreen) and should be mentioned. The Printscreen function is more useful to take when running in hires mode (and filters).

Try suggesting the delete .cfg/.dat file option and not using older savestates (useful if backward compatibility in ZSNES is broken in the future.. it still affect us now.)

Edit: I'll get to dissecting the FAQ section shortly...

[Jipcy]

Deathlike2, just to let you know I've started adding these things to the docs. I'll let you know once I commit them to SVN. Please don't expect that the changes I make will be verbatim what you said, but you will see how I changed things according to your suggestions.

And thank you. The docs always need thorough proof-reading / editing to be the best they can.

[Deathlike2]

Deathlike2, just to let you know I've started adding these things to the docs. I'll let you know once I commit them to SVN. Please don't expect that the changes I make will be verbatim what you said, but you will see how I changed things according to your suggestions.

And thank you. The docs always need thorough proof-reading / editing to be the best they can.

Take your time.. when you finish all the changes, let me know and I'll relook at the sections you have changed.

[Jipcy]

Changes to Readme.htm and GUI.htm are done. The WIP docs at zsnes-docs.sf.net are updated to reflect changes. Also made a few of my own content updates/additions.

Please check out the new table format for Default Keys in Readme.htm.

Deathlike2, why is the FAQ evil?

[Deathlike2]

Looks good.

By the way, your current description of Scitech Display Doctor is off though.
http://www.scitechsoft.com/ftp/sdd/
That's currently a working link to download it. However, I doubt the key for registering it is available on their website anymore. Obviously we don't want them asking on our forum on how to get them. We could do one of two things:

1) Give a key ourselves.. since it's free, we can provide one of a keygen (I don't think there's any negative implications, but I'm only mentioning it just in case).
2) Tell them to go find it themselves.

[Deathlike2]

Changes to Readme.htm and GUI.htm are done. The WIP docs at zsnes-docs.sf.net are updated to reflect changes. Also made a few of my own content updates/additions.

Please check out the new table format for Default Keys in Readme.htm.

Deathlike2, why is the FAQ evil?

Small joke...

I looked over the FAQ for a small moment.. and I've realized some of the questions in the Snes9x FAQ can also be asked in ours... this is something to consider.

[Deathlike2]

Found the key:
http://web.archive.org/web/200407170840 ... itles.html

We can probably copy them.. or just copy that link (though, I dunno if the wayback machine will always be there).

It may be a good idea to insist using the Windows version.. to make it simpler for the user base. It would make it easier than telling them how to install the DOS specific version (to keep it simple for most people).

[Deathlike2]

Yay, now the codes are available on Scitech's website.
http://www.scitechsoft.com/ftp/sdd/regcodes.txt

[Agozer]

Oh yay, r3gged sci tech display d0ctor serial numbahZ

[Deathlike2]

Oh yay, r3gged sci tech display d0ctor serial numbahZ

Ahahahahahaha

[creaothceann]

Weren't they before? Or was that another VESA2 TSR...

[Jipcy]

I just finished adding a few last things from this thread. I didn't touch support.htm. It needs a complete overhaul.