ZSNES Documentation Thread - Current Version 2.0

xamenus · Post by **xamenus** » Thu Jan 13, 2005 6:01 pm

Nach or RichardC:

Is there any chance that you could add a new module to CVS? My progress is being hindered.

EDIT: NN, have you made any progress since I uploaded revision 4?

Noxious Ninja · Post by **Noxious Ninja** » Thu Jan 13, 2005 6:20 pm

IceFox wrote:Nach or RichardC:

Is there any chance that you could add a new module to CVS? My progress is being hindered.

EDIT: NN, have you made any progress since I uploaded revision 4?

I just recreated the zsnes-docs-dev module based on your rev-4. You'll have to check it out again.

I've made some modifications to the GUI page in the Windows docs, nothing else. Those aren't in CVS since I'm not quite done.

xamenus · Post by **xamenus** » Thu Jan 13, 2005 6:45 pm

Noxious Ninja wrote:I just recreated the zsnes-docs-dev module based on your rev-4. You'll have to check it out again.

Oh, I thought you had to be an admin to do that.

Thanks.

xamenus · Post by **xamenus** » Fri Jan 14, 2005 12:23 am

The following is what I believe to be the status of the docs so far:

win32

readme.htm - complete (except for any more what's news)
gui.htm - almost complete (NN is adding in new options in gui)
netplay.htm - complete
faq.htm - complete
bugs.htm - complete

sdl

readme.htm - complete (except for any more what's news)
gui.htm - almost complete (NN is adding in new options in gui)
netplay.htm - complete (I assume that the win32 netplay.htm is appropriate for it)
faq.htm - AFAIK, not even started yet.

bugs.htm - complete

dos

readme.htm - complete (except for any more what's news)
gui.htm - almost complete (NN is adding in new options in gui; is the netplay section still appropriate?)
faq.htm - not complete (we need to weed out any obsolete faqs, and add in any necessary new ones. I have grammar fixed the current faq, and have added in appropriate faqs from the win32 faq.htm)
bugs.htm - complete

We also need new images.

Just because something's complete, though, doesn't mean that we shouldn't look at it anymore. We need to scrutinize EVERYTHING and see if all info is accurate/up-to-date.

Post by **Nach** » Fri Jan 14, 2005 12:48 am

Guess I'll have to check it out.

You guys work on the merging at all?

Noxious Ninja · Post by **Noxious Ninja** » Fri Jan 14, 2005 1:11 am

Nach wrote:Guess I'll have to check it out.

You guys work on the merging at all?

We were planning on saving that for after 1.41.

xamenus · Post by **xamenus** » Sat Jan 15, 2005 1:04 am

Noxious Ninja, how are the gui updates going? I can help if you need me to; I'm running out of stuff to do!

Although the DOS and Linux FAQ still need updating. :/

Richard C. · Post by **Richard C.** » Sat Jan 15, 2005 7:16 am

sorry guys for not being around - it's been very hard to find the time lately.

the zsnes-docs and zsnes-docs-dev modules were deleted because of a screw up when i originally created them. since there are many versions of the docs, i had to find a better way of organizing the files, and the original way just wouldn't do. the new directory structure can be seen in module zsnes-docs. if we add a new format, just create a new directory under zsnes-docs, for example, txt, and place all files of that type within it -- pretty self-explainatory.

since NN was unaware of my idea for organizing the docs, we have the three OS directories in zsnes-docs-dev. These will eventually be removed, and all updates within them will be available in the zsnes-docs-dev/html directory.

just in case it isnt obvious, the zsnes-docs module is for FINAL releases of the docs (v1.0 in ZSNES v1.40, v2.0 in ZSNES v1.41.....), and the zsnes-docs-dev is for any updates we make, so that there is always a final and "bleeding-edge" version of the docs available.

there's something i'm forgetting, but that covers most of it. sorry i havent been online much, i'll try to be online more for the next few days if possible. also, im always available in #zsnes-docs if online.

Edit:
BE SURE TO NOT UPLOAD FILES INTO zsnes-docs-dev/DOS, zsnes-docs-dev/Windows, OR zsnes-docs-dev/Linux. THESE WILL BE DELETED SOON. Place all changes to these directories in their appropriate directory within zsnes-docs-dev/html. A nice cvs update should make that easier....

Noxious Ninja · Post by **Noxious Ninja** » Sat Jan 15, 2005 5:33 pm

Yeah, we seem to have a lack of communication, likely my fault. IceFox and I were working in the zsnes-docs-dev/os dirs.

EDIT: Never mind, I got it out of Attic using WebCVS.

xamenus · Post by **xamenus** » Sat Jan 15, 2005 8:31 pm

Why not just release the 1.0 docs as a zip file in the Files (Releases) section? We should keep them out of CVS to avoid confusion.

Richard C. · Post by **Richard C.** » Sun Jan 16, 2005 4:59 pm

a release doesnt remove anything from cvs, and removing the zsnes-docs module after making it a release would be pointless (IMO). Good example: after a release, do the ZSNES admins delete everything within CVS?

Richard C. · Post by **Richard C.** » Sun Jan 16, 2005 5:05 pm

before you begin work, MAKE SURE YOU DO A CVS UPDATE. There were several changes that I made when re-arranging everything that are no longer in cvs because an old version of the docs were committed. Please dont do this.

Post by **Nach** » Sun Jan 16, 2005 6:00 pm

Well, after each release, we tag the source in CVS.

xamenus · Post by **xamenus** » Sun Jan 16, 2005 7:20 pm

Everyone, please check http://www.geocities.com/icefox150/file ... dosfaq.txt for outdated stuff, for the DOS FAQ. Then, after that's updated, hopefully someone can convert it to HTML.

Post by **Nach** » Mon Jan 17, 2005 5:31 pm

You guys going to be fixing the Linux images any time soon?

And why aren't you updating this and instead starting from scratch for the DOS FAQ?
http://cvs.sourceforge.net/viewcvs.py/z ... iew=markup\

And in the contributors section, it's Overload, not Overlord.

xamenus · Post by **xamenus** » Mon Jan 17, 2005 5:51 pm

Nach wrote:You guys going to be fixing the Linux images any time soon?

I think NN might be taking care of that

Nach wrote:And why aren't you updating this and instead starting from scratch for the DOS FAQ?
http://cvs.sourceforge.net/viewcvs.py/z ... iew=markup\

RichardC has completely rewritten the HTML code. That code there is old. kevman is currently making the new HTML DOS FAQ be based on RichardC's newer style.

Nach wrote:And in the contributors section, it's Overload, not Overlord.

Thanks, I'll fix that. EDIT: Fixed.

I think that we'll be all done in a few days at the least, and a week at the most.

kevman · Post by **kevman** » Mon Jan 17, 2005 8:48 pm

About the DOS HTML FAQ... Its done! There may be some errors or something, but I'm sick of looking at it.

Anyway, here it is, served by my PC. I'm gonna try to get it on my Geocities account, becuase I will be installing Linux later and thus won't be able to serve the file.
EDIT: Here's the Geocities Mirror Of course, my PC mirror doesn't have ads, so use it if it works. Also, the geocities may be outdated at any time.

EDITII: Carmina on IRC error-checked it and pointed alot of errors out. Both mirrors have been updated.

AspiringSquire · Post by **AspiringSquire** » Mon Jan 17, 2005 11:44 pm

I have some suggestions for FAQs.

Q: Why does ZSNES crash when I try to change the video setting to a VESA2 mode?
A: Your computer probably does not support MMX. Uncheck "MMX Support" in the Options window.

Q: Why can't I use 2xSAI, Super 2xSAI, or Super Eagle video filters? I can't even check the boxes next to those options.
A: Those filters will only work with MMX Support enabled. If your computer does not support MMX, then you won't be able to use those filters.

[This question may only apply to DOS port]
Q: Why does ZSNES crash when I enable sound?
A: Try lowering the output frequency for sound. Your PC may not be able to handle ZSNES using sound frequency higher than a certain value (for example: 22050 Hz).

All of these questions come from my own experience.

Here's a variant of a question, to be used for Windows and Linux (the version above would then be for DOS):

Q: Why can't I use 2xSAI, Super 2xSAI, Super Eagle, or HQ2X/3X/4X video filters? I can't even check the boxes next to those options.
A: Those filters will only work with MMX Support enabled. If your computer does not support MMX, then you won't be able to use those filters.

Post by **Nach** » Mon Jan 17, 2005 11:59 pm

All those filters require MMX? I'm pretty sure I've seen MMX and non MMX versions of them in the source.

AspiringSquire · Post by **AspiringSquire** » Tue Jan 18, 2005 12:02 am

Nach wrote:All those filters require MMX? I'm pretty sure I've seen MMX and non MMX versions of them in the source.

When MMX Support is disabled, the filters can't be enabled within the GUI. That's all I know.

Noxious Ninja · Post by **Noxious Ninja** » Tue Jan 18, 2005 5:06 am

IceFox wrote:
Nach wrote:You guys going to be fixing the Linux images any time soon?
I think NN might be taking care of that

Yep. Fixed.

AspiringSquire · Post by **AspiringSquire** » Wed Jan 19, 2005 12:10 pm

AspiringSquire wrote:[This question may only apply to DOS port]
Q: Why does ZSNES crash when I enable sound?
A: Try lowering the output frequency for sound. Your PC may not be able to handle ZSNES using sound frequency higher than a certain value (for example: 22050 Hz).

This question would be better written this way:

Q: Why does ZSNES crash when I load a ROM with sound enabled? It works without sound...

I saw in the documentation that there is a question/answer that addresses this, but could my answer be included as a more specific possible solution?

And what about my MMX-related questions? Those aren't in the FAQ at all.

Aerdan · Post by **Aerdan** » Wed Jan 19, 2005 12:42 pm

install.txt points to an outdated zlib URL. Update to www.zlib.net, please.

xamenus · Post by **xamenus** » Thu Jan 20, 2005 4:00 am

Let's see, a couple of things that need to be fixed in the docs:

DOS gui.htm -- under the Game-->Load part, nothing is mentioned about displaying SNES header names, DOS filenames or whatever (they're in the 1.36 dos docs; be sure to grammar fix them!).

A new Linux gui.png is needed (currently, the windows gui.png is used. It's also smaller than the others, so an update for it will make things uniform

).

And are the Scitech Display Drivers still needed for the DOS port? I thought I remember reading somewhere that they are no longer necessary. If they're not needed, the dos faq needs to be updated.

Post by **Nach** » Thu Jan 20, 2005 4:04 am

Don't forget to take the 3 sets of docs from the v1.42 release and to upload them to zsnes-docs-dev.