Help with MA new "readme" file...
 

I'm presently working on a new "readme.txt" file for the upcoming release of MA3.1. If you look at the current one, you'll see that it doesn't have a section describing the "Fish Settings" screen or the new "Background Colors" so I'm adding them.

I need a little help though regarding the "Display Settings" screens since I am not running a multi-monitor system. If someone could "screen capture" the appropriate menu screen(s) for a multi-monitor system and upload them to the Gallery so I can see what they look like, I'd appreciate it. If you are running Win 7 it is real easy (PM me if you need help).

Also, I am running a registered version of MA, so I don't know what the non-registered "registered" screen looks like, so If someone could upload it to the Gallery too, I'd appreciate it.

Thanks in advance.

I hope the following statement isn't taken as negativity, divisiveness, or complaining, I'm just stating an observation.

JohnWho, after reading about all the changes and additions to the NEW readme file you are working on, it sounds as though it is morphing into something else - a "user manual".

If that is what it is becoming, maybe it should be included as such, and a more traditional readme file (concise, focusing on last minute changes, etc.) could also be included.

Just my two-cents about the matter, and in closing I would like to say; your hard work and contibutions have not gone unnoticed.


Excuse me while I put my flame retardant suit on. :)

I'm just going to submit what I create to Jim, and then handle it as he wishes if he wants changes.

If the biggest complaint ultimately is that it is too detailed, the fact that MA doesn't have a User Manual would make that a complaint that I won't mind.

Otherwise, I expect that no matter what I, or anyone else, would write, there will always be some who aren't happy with it.

Your observation is probably the same that I might make were the situation between us reversed, so I understand completely.

Can you help with the images I've requested?

Uh, you don't need a camera to capture the screen images I requested.

Otherwise, sorry to hear your camera is no longer operable.

No flames intended:

Please take a look at the current readme.txt file, that you will find on your system at:

C:\Program Files\SereneScreen\Marine Aquarium 3\readme.txt

It runs 13KB, and about 4 printed pages.

To me, it looks very close to a "user manual" - and all that JohnWho is doing is making it more complete, including the latest features. I'm guessing it will run about 20 pages when he is done.

But anyhow - I'm interested in your opinion about whether he's starting with a classical "readme", or a "user manual", that was shipped (via download) with the software.

Yes, that would be a nice addition. Perhaps someone will volunteer to build that.

Not sure if this is what you had in mind. I have two tabs under the "Display settings". Selecting the second tab (monitor) brings up the second screen capture. depending on the radio button selection under Monitor usage the Display mode may be grayed out. Under General Monitor settings I can select to have the same on both monitors or have one large spanned MA3 where the fish swim from one to the other.

How much this screen varies depending on my Video card I do not know, there are settings associated with the card that can complicate the settings found here. Specifically where the second monitor is positioned.. Left of main, right, above below top left... etc. Each case changes how MA3 behaves and one can get some very ugly effects.

Dale,

After reading the whole file my conclusion is that it is currently a "hybrid". The file is named "readme.txt" and for about half way through it looks like a traditional readme file, but begins to resemble a "user manual" as it progresses, albeit a condensed one.

Since the file is named "readme" and the header for the file itself is titled "Marine Aquarium 3.0 User's Guide" the author may have intentionally meant for it to be a "hybrid". It would be more eloquent, but more time consuming to break it into to entities - a readme file and a seperate user's guide/manual.

My original post was making an observation, and wondering what direction the file would/should take during its renovation by JohnWho. I am not trying to distract Jim from his primary mission of completing the next phase, or increasing JohnWho's workload unless they believe the end resullts would justify the increased effort.

If this answer "morphed" into a long winded reply, I'm sorry. :)

@ Ralph -

Most excellent. That is exactly what I was looking for regarding the multi-monitor screens. At least now I know what they look like and can understand the descriptions better in the current readme.



It would still be helpful if someone can capture the screen that shows on an unregistered installation.

@ harris -

I patterning what I'm doing very much on the current readme. Why mess with time-tested perfection? :)

Seriously, I'm being more detailed in some areas, so based on your impression of the current readme, what I produce will be even more "User Guide"- like. Is that a bad thing? I don't think so.

However, I'm not being self-centered on this. I'll pass it on to Jim, he'll look at it and make his decision on what to do with it. Even if he dumps the whole thing, I can still say I'm enjoying the time I'm spending on it. He is the "bottom line" on this and it isn't costing him a penny to allow me to do what I'm doing.

Plus, while I'm working on it, there is one less driver on the roads in Florida.

Win-win all around.

:TU:

Just had a look at the current read me file. I was wondering if there could be a glossary of frequently used terms? When I first got into virtual aquariums, I knew absolutely nothing about anti-aliasing, jaggies, integrated graphics etc. It took a lot of Googling and sifting through overly technical wikipedia pages for me to get an understanding of the basics.

Perhaps the next readme, Nicki, but not this time around (at least not from me).

In the interim, though, you'll get lots of information from Computer PC Glossary and Terminologies

Enjoy.

I would be surprised if there was a difference. My understanding is that Jim wants everyone to be able to "test" all aspects of the "simulation". Registering "only" adds the number of fish one can have and... removes the need to type in test fish.... I think:D

Well, on the Registered version, clicking the "Register" button gives a "Thank you for registering....etc." screen.

I suspect clicking on "Register" on an Unregistered version gives some information on the registration process and the advantages of registering.

I'd just like to see it in an effort to be thorough, that's all.

I removed my copy (via the registry) and then ran the "testfish" version. There is no difference in the "Display Settings" box. All the buttons and selections are exactly the same. As you mentioned some of the other tabs are different but nothing in the the display settings box.

And in the "Register" screen? Surely it doesn't say that the "testfish" version is a registered version, does it?

No the "register" screen brings up the testfish box.

OK, that's what I was looking for.

Thanks Ralph.

Not that it's vitally important, but for completeness it would be nice if the readme.txt said what the "unregistered" limits on the fish are. Did you happen to observe that?

Okay.. here are a few more

Ralph -

I've "captured" all of the screens that are part of the Registered product except for the mulit-monitor and "Unregistered" screen that I requested in this thread, which I now have thanks to your efforts.

I do appreciate the above ""Register Today" Fish menu, too. I had forgotten what that looked like.

Yes, I have a spot for that in my "draft" copy.

Limited to only the top line of fish, no more than 3 of each, and you need to learn how to type "testfish"?

Anything else?

Oddly, I can't find this in writing anywhere.

Perhaps I haven't searched in the right place(s)?

I fuzzily recall that there's some mention of some limit somewhere in this forum, but (like you) I couldn't figure out a good set of search parameters.

The only thing I can find is a discussion of why the limit isn't 3 fish (total).

I suspect that only Jim can provide a comprehensive list of the Testfish limitations (or perhaps Morgan, now that he does tech support).

I finally figured out how to deconvolve this:

Music can only be turned OFF using the Program Settings check box or toggling the M key.
Music can be turned ON using either of those, and also by using the Music Playlist Play control.

I'm not sure that helps your readme.txt efforts, but it "unconfused" me.

Yes, similar to the way Show Crystal can be turned on (but not off) in the Logo Playlist.

The (new) implementation on the Logo Playlist panel is elegant and clearly implemented.

Could the same general implementation be applied to the Music Playlist panel?

Maybe.

I'm not seeing this ability in the Logo Playlist.

Yeah, I'm less confused now, too.

Easiest to document would be if in the Music Playlist, "Play" and "Stop" only had an effect while in the Music Playlist screen.

This way, the master setting in Program Settings would not be altered either way.

However, once all the dust settles, and we have the final "this is how it will be" 11(x), I'll make the Readme reflect these things accordingly.

OK, I've implemented it the same way as the LogoList screen.

Have you found it yet? :)

Turn "show crystal" off in the Program Settings, and then open the Logo Playlist panel. Presto! It warns you that the crystal isn't going to be shown unless you (click here) turn it on.

If "show crystal" is on, there's no need to say anything in the Logo Playlist panel, so you can't see it.

Rather elegant implementation.

Got it, thanks.

In that case, having that same thing happen in the Logo Playlist makes perfect, and consistant, sense.

Per your request:

Did you lose the original "Guitar" music and want it back?

First, find your MA3 folder. It's usually (on Vista or Windows 7):
C:\Users\YOURACCOUNTNAME\AppData\Roaming\Marine Aquarium 3\

Find the file named MA3Playlist.lst

Now, you have two choices:

1. If you have other music in your Playlist that you want to keep, and just want to add the Guitar music, then:
Open the MAA3Playlist.lst file with an editor
Add one new line that contains just the name of the song, which is CanonGuitar.sgt
Save the results of your editing.
When MA3 next runs, it will play the Guitar music along with all of your other music.

2A. If you don't care to save anything that might have been in your playlist (or if it's empty), then:
Just delete the MA3Playlist.lst file
When MA3 next runs, it will play the Guitar music.

2B. Actually, if you have other things in your playlist, and you want to get rid of all of them and just have the Guitar music, there's an easier way. Just "Remove" all of the other music. An empty playlist tells MA3 to play the Guitar music.

[Editorial footnote: I tried to figure out how to get 2B before any of the other stuff, but couldn't make it read correctly. Perhaps you will have better luck.]

OK, thanks.

I'll rework it to match the format I'm using somewhat, and put it in the "Troubleshooting" section which remains mostly as it's been in the old "readme". I didn't feel that I should change this section and other than slight phrase changes or reference to Windows 7, I've left it alone.

I'm off to find the MA3Playlist.lst file.

I do notice that even with a totally empty Playlist, if you turn Music "on", CanonGuitar.sgt will play.

Dang, just noticed you can do it within the Music Playlist screen, too.

Just choose "add" and then navigate to:

(Win XP)

C:\Documents and Settings\"your account name"\Application Data\Marine Aquarium 3\

(Vista & Win 7)

C:\Users\"youraccountname"\AppData\Roaming\Marine Aquarium 3\


and it shows up "CanonGuitar.sgt" just like any other supported music file.

Much easier.

Probably better than explaining the "edit file" method, at least in the "readme".

I would suggest that the "edit file" method be added in the FAQ info on either or both the SereneScreen and this Forum's pages though as the FAQs should provide more detail and some of these behind the scenes "tricks", in my opinion.

See item 2B in my writeup.

It would be if that file existed. But it doesn't get created with recent versions. Not exactly sure when that happened, but if you have that file, it's a "leftover" from some previous version.

Yeah, now that you point it out, I checked my other PC and the file is not there. Drat.

Is a blank playlist that plays CanonGuitar a bug?

@ Jim -

if you would insure that "CanonGuitar.sgt" is installed in the same folder where MA3playlist.lst and MA3logolist.lst is, it would make life easier for folks to "recover" the CanonGuitar.sgt file.

I don't consider the "blank playlist" thing to be a bug, but only Jim can tell us for sure.

At one time, the presence of a CanonGuitar.sgt actual file was considered to be a bug.

For some (interesting?) historical background, start around post #32 in:

https://www.feldoncentral.com/forums...?t=4850&page=2

Yeah, I've now read through that.

The "CanonGuitar.sgt" playing when the playlist is blank and music is "on" is apparently a "design feature", or, as we used to call them when I worked with a software house - an "undocumented non-feature".

In any case, if that's the way it works, then that's the way I'll say it works in the readme.

In the words of some wiser-than-I man - "so shall it be, so it is written" (apologies to Yul Brenner in "The King and I").

I once had a vendor tell me that their buggy software was "working as coded".

That was before "Doh!" became a catchphrase, but I'm sure I said something similar.

The music playlist interface and the logo playlist interface are nearly identical internally. They both have a default file to play if the list is empty. If you delete everything in the list, exit Settings, then go back into Settings, both those interfaces should have their default filename listed. After a cursory look at the code, it's not obvious why the Logo list shows the default logo, but the Music list does not show the default music. I'll have to dig deeper, but I'm still working on the Framerate stuff.