ZSNES documentation needs updating before v1.40

Richard C. · Post by **Richard C.** » Mon Oct 18, 2004 2:40 am

The last step before the 1.4 release is to update ZSNES's documentation. That means, a new new format (HTML), a new changelog, and a new FAQ.

I've completely converted the Windows docs to html now, using the ZSNES homepage theme created by radio, and the Linux and DOS docs arent much different, so it shouldnt take too long.

LDAWG has taken the changelog into his own hands, and has done quite a good job of it i might add, but we still need a new FAQ, as well as any other edits you can think of.

Now, for the updated FAQ. Many new questions have become common-place on these boards since the docs were last updated, and most need to be added to the FAQ. Some questions also need to be removed, such as.... oops, its a secret. Either way, we need a new FAQ. If anyone is interested, PLEASE, PLEASE, PLEASE help. Since this is the last step before the release, every moment we waste delays it.

The FAQ shouldn't take too long to re-write; I just have other things, like converting the other ports' docs, to do, or i would re-write it myself.

Common ZSNES fans, lets get to it!

Edit:
To see the current progress of the docs, visit http://richardc.silohware.com/ or download them here.

funkyass · Post by **funkyass** » Mon Oct 18, 2004 3:46 am

sane way to do it would be to have a FAQ forum, and add stuff as questions come along

kevman · Post by **kevman** » Mon Oct 18, 2004 4:43 pm

Should the FAQ be in HTML or .txt?

I'll start looking over the boards and adding questions I can think of, but I'm sure I won't add everything needed. If anyone can think of good questions, I'm sure I can figure out good answers.

Problem is, many of the FAQs on the board are answered by "Get the latest WIP."

I'll help as much as I can, but I'll welcome someone more qualified to take over. I'm no n00b, though. I've been at the board since at was that really old black thing, just didn't post.

Also, should bugs be mentioned, such as Top Gear 3000 or ff6J?

Richard C. · Post by **Richard C.** » Mon Oct 18, 2004 11:09 pm

the faq can be in any common format you wish, preferrably txt, because i will have to convert it into the document anyways.

just put together some common questions, and send 'em my way. i'll be sure to add 'em, with all due credit, of course.

Post by **Nach** » Mon Oct 18, 2004 11:26 pm

The docs currently lack a decent credit section.

On top, add in an organized credit thingy, developers, contributors, doc writers etc...

kevman · Post by **kevman** » Tue Oct 19, 2004 12:12 am

I misunderstood what you wanted, and modified the FAQ directly.
My modified FAQ is at http://www.geocities.com/kevmanzsnes/ZSNESFAQ.TXT.

Here is a list of what I did:

Questions Added:

Q: Why don't my settings get saved after I close Zsnes?
Q: Why don't Street Fighter Alpha 2 and Star Ocean work right in ZSNES?
Q: How do I apply the Street Fighter Alpha 2 graphics pack in ZSNES?
Q: How do I apply the Star Ocean graphics pack in ZSNES?
Q: I used the auto .IPS patching feature, and now the game doesn't work.
Q: How do I convert .ZMV movies to AVI/DIVX/WMV/MPEG?
Q: Can you make a Mac/PocketPC/PS2/whatever port?

Questions that have had the answers changed:

Q: Can you guys get Pilotwings/Star Ocean/Street Fighter Alpha 2 to work?
Q: How come the game genie codes don't work?
Q: Why is ZSNES slow?
Q: Why do I get a black (or corrupted) box when I start up ZSNESw?

Hope it is of help anyway.

This post subject to change without notice.

Post by **badinsults** » Tue Oct 19, 2004 1:05 am

You should put in a section on how to report bugs.

Richard C. · Post by **Richard C.** » Tue Oct 19, 2004 9:19 pm

thanks kevman!

there is a section for bug reports: http://www.geocities.com/rchildress87/w ... eports.htm

keep in mind that little has been updated however.

Joe Camacho · Post by **Joe Camacho** » Wed Oct 20, 2004 5:12 am

I have an idea, It might be a good idea to gather some sort of "Zsnes dictionary" or Emulation dictionary, with stuff like WIP, Header, .ips patch, savestate, .srm file, etc.

It doesn't have to be something heavily technical, perhaps only a brief description about them.

kevman · Post by **kevman** » Mon Nov 01, 2004 4:11 am

Hey, a bit late, but I just remembered that I ddidn't give IceFox any credit, as the questions regarding the graphics packs are his.

Anything else you need me to do to the FAQ, let me know.

joe_devore · Post by **joe_devore** » Mon Nov 01, 2004 8:45 am

Joe Camacho wrote:I have an idea, It might be a good idea to gather some sort of "Zsnes dictionary" or Emulation dictionary, with stuff like WIP, Header, .ips patch, savestate, .srm file, etc.

It doesn't have to be something heavily technical, perhaps only a brief description about them.

I will second that, not that what I think matters to any one here.

But it should defintely include well detailed definitions and working
descriptions of what Interpolation and various otherconfusing things
like that, Plus ofcourse everthing else.

I would think that a Dictionary would be the best thing that could be
added to the Zsnes Documentation.

Now as for Format, Best to use a format that is acceptable
cross platforms.
HTML/XML, find a format that can hold all the files, images, text, etc,
that would come with the release documentation.

I cannot think of anthing else at this point,
Will post more if I can think of it.

The text files I get are generally all garbeled up.
I believe the Return Key is registering a "|" like Symbol,
but much darker.

What system was the Current Documentation
created on, Mac, Linux, Windows, Etc?

illegal eagle · Post by **illegal eagle** » Mon Nov 01, 2004 11:33 am

These text files (probably) use a shorter line break code (ASCII $0A) instead of the DOS/Win line break (ASCII $0A + $0C).

Just drag'n'drop these files into an Internet Explorer window, or use other programs.

LDAWG · Post by **LDAWG** » Mon Nov 01, 2004 11:35 pm

Update to the .txt Changelog for ZSNES v1.40 (November 01, 2004).

http://board.zsnes.com/phpBB2/viewtopic ... 9424#19424

xamenus · Post by **xamenus** » Tue Nov 02, 2004 2:51 am

kevman wrote:Hey, a bit late, but I just remembered that I ddidn't give IceFox any credit, as the questions regarding the graphics packs are his.

Anything else you need me to do to the FAQ, let me know.

You could probably unify the S-DD1 FAQ a little more (i.e. use less questions). IMO, that's kind of a lot of questions to have in the official FAQ concerning only 2 games. The reason is because I didn't design that FAQ with the official ZSNES FAQ in mind; I made that for the DeJap forum.

This is just my opinion, though.

P.S.--It's possible that 1.40 will not need the graphics packs. Real-time S-DD1 decompression might be implemented.

kevman · Post by **kevman** » Tue Nov 02, 2004 6:47 am

IceFox wrote:You could probably unify the S-DD1 FAQ a little more (i.e. use less questions). IMO, that's kind of a lot of questions to have in the official FAQ concerning only 2 games. The reason is because I didn't design that FAQ with the official ZSNES FAQ in mind; I made that for the DeJap forum.

Agreed; done. There was a typo that needed repaired anyway. I take it, then, that you don't mind.

P.S.--It's possible that 1.40 will not need the graphics packs. Real-time S-DD1 decompression might be implemented.

I realized that; but... what was I do to? If the compression shows up, I'll rip all those questions out, I guess. Which would lead to very little that I have done

Any other questions to add?

I just noticed that there are 2 FAQS, one for WIN and another one. They are pretty much the same. Since I modified the one no longer given out in the WIP's, I have some work to do tommorow, in adding the questions missing in mine back in.

Nightcrawler · Post by **Nightcrawler** » Tue Nov 02, 2004 2:04 pm

kevman wrote:
P.S.--It's possible that 1.40 will not need the graphics packs. Real-time S-DD1 decompression might be implemented.
I realized that; but... what was I do to? If the compression shows up, I'll rip all those questions out, I guess. Which would lead to very little that I have done Any other questions to add?

Sure, anything is possible, but in this case probably unlikely unless there is significant delay from now until 1.40. Of course.. that's probably likely. It's already been a few years. No one will even notice a few more months.

joe_devore · Post by **joe_devore** » Wed Nov 03, 2004 6:42 am

illegal eagle wrote:These text files (probably) use a shorter line break code (ASCII $0A) instead of the DOS/Win line break (ASCII $0A + $0C).

Just drag'n'drop these files into an Internet Explorer window, or use other programs.

Well, I figured it out.
Aparently, The text files where written from in Unix.
I found a Program called, NotePad2.
Notepad2

The original Notepad shipped with Windows is probably the handiest program of all times, small, fast, without frills! Notepad2 tries to follow this principle, it's a small, fast and free text editor with syntax highlighting for HTML and other common languages. More information: Notepad2 FAQ, Notepad2.txt.

This Program has an option under:

Code: Select all

File:-->Line Ending:-->Windows (CR+LF)
                                     Unix   (LF)        
                                     Mac    (CR)

I this out when I thought to load the Zsnes txt files
into NotePad2, and found out when I checked the LineEnding Option.
I simply changed them to Windows, Saved, and loaded them into Regular,
notepad, and mess fixed.
This Notpad2 can load ANY type of source, and color code the Whole mess.
Under View-->SyntaxSchemes.
It has more option then I have seen in a Text editor.

Here is a Excerpt from the Readme

Code: Select all

Features

  - Customizable syntax highlighting:
    - HTML, XML, CSS, JavaScript, VBScript, ASP, PHP, CSS, Perl/CGI
    - C/C++, C#, Java, VB, Pascal, Assembler, SQL, Python, NSIS
    - INI, REG, INF, BAT, DIFF
  - Drag & drop text editing inside and outside Notepad2
  - Basic regular expression search and replace
  - Useful word, line and block editing shortcuts
  - Rectangular selection (Alt+Mouse)
  - Brace matching, auto indent, long line marker, zoom functions
  - Support for Unicode, UTF-8, Unix and Mac text files
  - Open shell links
  - Mostly adjustable


New in Version 1.0.12

  - Notepad2 source code now released under the GNU GPL
  - "Read Only" option handles file attributes
  - Enhanced find and replace dialogs with new options
  - Optionally auto close HTML/XML tags (Ctrl+Shift+H)
  - Improved tabify/untabify selection functions
  - New hotkey to select XML scheme (Shift+F11)

Source Code

  Notepad2 is based on the Scintilla source code editing component:
  http://www.scintilla.org

  The full Notepad2 source code is distributed under the terms of the
  GNU General Public License and can be found at:
  http://www.flos-freeware.ch

And it appears to be working.
Ofcourse I just got it a few days ago.
Sorry, I think I went on a tangent Again.
I am done, I think...

Noxious Ninja · Post by **Noxious Ninja** » Wed Nov 03, 2004 7:15 am

man page update.

I'm not quite sure what to do about the special chip / gfx pack sections, and I need more info for the contributor sections. Also, should it go in category 6, games, or be left in category 1, misc?

http://thecarpentersshop.com/ninja/zsne ... 4-11-02.gz

And yeah, Notepad2 is teh bomb for Windows. Small, fast, and does a nice job. I just wish it had a tabbed interface like UltraEdit-32.

EDIT: Hmm, I don't know which thread this should go in... I'll just double-post.

joe_devore · Post by **joe_devore** » Wed Nov 03, 2004 7:30 am

Noxious Ninja wrote:man page update.

I'm not quite sure what to do about the special chip / gfx pack sections, and I need more info for the contributor sections. Also, should it go in category 6, games, or be left in category 1, misc?

http://thecarpentersshop.com/ninja/zsne ... 4-11-02.gz

And yeah, Notepad2 is teh bomb for Windows. Small, fast, and does a nice job. I just wish it had a tabbed interface like UltraEdit-32.

EDIT: Hmm, I don't know which thread this should go in... I'll does double-post.

I am glad there is someone else that knows about the program.

UltraEdit-32, i think I tried it a few years ago, aren't they ShareWare?
I cannot afford anything

Noxious Ninja · Post by **Noxious Ninja** » Wed Nov 03, 2004 7:33 am

joe_devore wrote:I am glad there is someone else that knows about the program.
UltraEdit-32, i think I tried it a few years ago, aren't they ShareWare?
I cannot afford anything

It's sharewarez.

joe_devore · Post by **joe_devore** » Wed Nov 03, 2004 7:36 am

Yeah thats wehat I thought.
Do you know of editor programs better than UltraEdit32 or NotePad2
That are worth paying for or free.

Bent · Post by **Bent** » Wed Nov 03, 2004 7:43 am

I use TextPad, works really good. It's shareware, but it's only a nag screen, no restrictions on use.

joe_devore · Post by **joe_devore** » Wed Nov 03, 2004 8:44 am

Bent wrote:I use TextPad, works really good. It's shareware, but it's only a nag screen, no restrictions on use.

TextPad, that sound really famiilar.
I think that was a text editor a group of students found and got the CS
department to use up at the college, while I was there a few years back.
Do you hapen to have the linkS for their site.

Bent · Post by **Bent** » Wed Nov 03, 2004 5:05 pm

Yep, www.textpad.com

Bahamut_ZERO_Clue · Post by **Bahamut_ZERO_Clue** » Fri Nov 19, 2004 1:00 am

Looks great but a small detail:

Windows NT/2000/XP

ZSnesW doesn't support Windows NT 4.0 as Windows NT 4.0 only has DirectX 3.0a foundation support.

You should say it more as Windows 2000/XP/2003.