
SFO Vis 1.01   for Sonique                         created by Samuel Graenacher
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1. About/History
2. Requirements
3. Configuring Options
4. FAQ (Frequently Asked Questions)
5. Everything Else
_________________________________________________

1. About/History
~~~~~~~~~~~~~~~~~
	SFO was actually meant to be a really small project to test out a few Oscilloscope
	routines I was working with. It originally only contained one single line, and had
	been written in under 10 minutes. When I was writing on it, I had a few ideas which
	I wanted to try out. So I added Filling and Configuring. Since C++ isn't a language
	I know too well I was really surprised in what blazing speed it made the calculations.
	So I added a few other things, optimized a few routines and what came out was pretty
	useable. In the current state it is pretty much stable and can be released to the
	public. However since it was written in 100% pure C++ and in under 6 hours it's not
	as fast as it could be if I'd use ASM in a few routines. When this plugin actually
	gets popular (what I somewhat doubt) I might rewrite these routines and add other
	features.
	Ok, enough of me talking, let's go to the important things...
	
	(I apologize for my bad english)

2. Requirements
~~~~~~~~~~~~~~~~
	The plugin has been tested on a PentiumII-450Mhz (and 200Mhz) and uses max 80% CPU 
	with all features turned on in FullWindow (NOT FullScreen!) mode on the PII450.
	It looks best in bigger windows such as Navmode and Fullwindow mode.
	
	The following VisFX settings are my personal suggestions (for ANY vis by the way):
		blur fx	 x
		smoke fx o
		zoom fx  x	reverse  o
		[XXXXXXX_________]
		  effects level
		[XX______________]
		  zoom speed			x=checked	o=not_checked

3. Configuring Options
~~~~~~~~~~~~~~~~~~~~~~~
	If you have Sonique 1.0x+ the settings of the plugins get stored in the file called
	vis.ini in your Sonique directory each time you close Sonique.
	NOTE:	When you edit vis.ini while sonique is running be sure to save your changes
		AFTER you closed Sonique. SFO will save (and overwrite old ones!) the settings
		it currently uses each time Sonique is closed.
	Here are the descriptions of the Config keys:

	[SFO]
	
	LeftLineColorR=250
	LeftLineColorG=255
	LeftLineColorB=250
		; These three values edit the Red, Green and Blue color values of the 
		; (left) TOP Oscilloscope.
	
	LeftFilledLineColorR=37
	LeftFilledLineColorG=223
	LeftFilledLineColorB=32
		; These three Red/Green/Blue values tell the plugin what color to fill the 
		; (left) TOP Oscilloscope with.
	
	RightLineColorR=255
	RightLineColorG=255
	RightLineColorB=245
		; These three values edit the Red, Green and Blue color values of the 
		; (right) BOTTOM Oscilloscope.
	
	RightFilledLineColorR=209
	RightFilledLineColorG=219
	RightFilledLineColorB=21
		; These three Red/Green/Blue values tell the plugin what color to fill the 
		; (right) BOTTOM Oscilloscope with.
	
	LeftFilledLines=1
	RightFilledLines=1
		; Set these to 1 if you want the Left/Right Oscilloscope filled.
		; If set to 0, the osc. will only be simple pixel lines.
	
	LeftCSEnabled=1
	RightCSEnabled=1
		; Wether to use the Left and/or Right Circle Scope or not
		; (1=use it / 0=don't use it)
	
	CS_move_around=1
		; If you want the Circle Scopes to move around set this to 1, if not 0 is
		; your choice.

	CS_use_cycled=1
		; If this is set to 1 the plugin will continously change the colors of the
		; Circle Scopes. If 0 then it will use the color settings below.
	
	LeftCircleScopeR=0
	LeftCircleScopeG=0
	LeftCircleScopeB=255
		; These three values edit the Red, Green and Blue color values of the 
		; LEFT Circle Scope.
		; Note: These settings will be ignored is CS_use_cycled is set to 1!
	
	RightCircleScopeR=0
	RightCircleScopeG=0
	RightCircleScopeB=255
		; These three values edit the Red, Green and Blue color values of the 
		; RIGHT Circle Scope.
		; Note: These settings will be ignored is CS_use_cycled is set to 1!

4. FAQ
~~~~~~~
Q: How do I install this plugin?
A: Copy the file called "sfo.svp" into the Folder called "Vis" in your Sonique Folder.

Q: Why is it so slow on my Computer?
A: As I stated in the About this plugin was written in a very short time by a person 
   with very limited C++ knowledge ;>
   Also try to disable a few things like the Circle Scopes (set to 0) to speed the 
   plugin up.

Q: I don't have a vis.ini in my Sonique Folder?
A: You probably are running an old version of Sonique. In this case the settings are
   stored in c:\windows\sonique.ini

Q: Will there be new versions with more features?
A: Depends on how popular this one gets.

Q: My changes to vis.ini seem to be ignored. What do I do wrong?
A: Be sure to save your changes AFTER(!) you closed Sonique.

Q: Can I have the source??
A: No. Two reasons: 1) It's incredibely messy right now. 2) I just don't feel like it.

Q: What did you program this plugin in?
A: Microsoft Visual C++ 6

Q: I have a few ideas for the plugin. Can I tell them to you?
A: Yes. Feel free to email any comments, bug reports, ideas, suggestions to xplo@xploded.net

5. Everything Else
~~~~~~~~~~~~~~~~~~~
	Greetings to: the crews #sonique and #mp3 on irc.mircx.com,
	              SexoSonic (maybe one day i'll be as elite as you and program my own decoder),
	              pX and HB and Scirocco (for making such a kickass player),
	              shock (for your help with the settings),
		      everyone i forgot at the moment.

	Bug reports, questions, comments, ideas to xplo@xploded.net

	Wow that's it, nearly took me longer to write this readme than the whole plugin. ;p
