@DATABASE Shoah Full Motion Video - Player
@(C) "Copyright © Shoah 1996"
@$VER: SFMV_Player.Guide V1.1 (09 June 1996)
@AUTHOR Squize
@REM Design by Vex
@REM Creation     (27 May 96)	- Basic text.
@REM Revision   1 (07 Jun 96)   - Styled and formatted.
@REM            2 (09 Jun 96)	- Added Index. Bad links fixed. Final Release.
@INDEX INDEXNODE
@WORDWRAP ON
@NODE MAIN "SFMV Player"
@{fg shine}  _____________________________   ____      @{FG FILL}@{"Main SFMV Guide" LINK SFMV:Guides/SFMV.Guide/MAIN}@{FG SHINE}
 /'  _____/\_   _____/'    \`  \ /'  /
 \_____ ~\  |'   __)/  \ /  \   X   /       @{fg text}Player@{fg shine}
 //       \ |     \/    Y    \     /
/_______  / \___  /\____|__  /\___/
~       \/      \/         \/@{fg text}
@{u}                                                                           @{uu}
  @{b}@{u}CONTENTS@{ub}@{uu}
    @{fg highlight}General@{fg text}
      @{" Introduction        " LINK OVERVIEW} - What this program does.
      @{" Distribution        " LINK SFMV:Guides/SFMV.Guide/DISTRIBUTION} - Legal Stuff
    @{fg highlight}Operation@{fg text}
      @{" Features            " LINK FEATURES} - Packed full of...
      @{" Usage               " LINK USAGE} - How to.
      @{" Tricks 'n Tips      " LINK TRICKS} - Pulling rabbits from hats.
      @{" Music Format        " LINK MUSIC} - Toons.
      @{" Packer Format       " LINK PACKER} - Crunching.
    @{fg highlight}Miscellaneous@{fg text}
      @{" Credits             " LINK CREDITS} - Who did what?
      @{" Future Plans        " LINK FUTURE} - What's coming next?
      @{" SHOAH               " LINK SFMV:Guides/SFMV.Guide/SHOAH} - Dedicated to quality software

	"I think I've reached that point
	 where giving up and going on
	 are both the same dead end to me
	 are both the same old song"

		- 'End', Robert Smith
@ENDNODE
@NODE OVERVIEW "Overview..."
@{fg shine}  _____________________________   ____      @{FG FILL}@{"Main SFMV Guide" LINK SFMV:Guides/SFMV.Guide/MAIN}@{FG SHINE}
 /'  _____/\_   _____/'    \`  \ /'  /
 \_____ ~\  |'   __)/  \ /  \   X   /       @{fg text}Player@{fg shine}
 //       \ |     \/    Y    \     /
/_______  / \___  /\____|__  /\___/
~       \/      \/         \/@{fg text}
@{u}                                                                           @{uu}
The  SFMV Player is the viewer utility for SFMV animations ( Please read the
@{"Convertor" LINK SFMV:Guides/SFMV_Convertor.Guide/MAIN} doc file for more info on the SFMV format ).
@ENDNODE
@NODE FEATURES "Features..."
@{fg shine}  _____________________________   ____      @{FG FILL}@{"Main SFMV Guide" LINK SFMV:Guides/SFMV.Guide/MAIN}@{FG SHINE}
 /'  _____/\_   _____/'    \`  \ /'  /
 \_____ ~\  |'   __)/  \ /  \   X   /       @{fg text}Player@{fg shine}
 //       \ |     \/    Y    \     /
/_______  / \___  /\____|__  /\___/
~       \/      \/         \/@{fg text}
@{u}                                                                           @{uu}
The SFMV Player include the following features...

- Two modes of operation, @{"Direct" link Usage 12} or @{"Script" link Usage 26}.
- Can handle @{"Stone Cracker" link Packer} packed files.
- Uses the @{"Player61a" link Music} to replay music mods.
- By using a @{"patch" link Tricks 14} you can also use PowerPacked/xpk files.
- From Script mode you can have multiload or normal single load files.
- The player can handle IFFs up to 32 colours in either low or high res.
- You don't have to play SFMV anims !  You could just use it as a simple
  slideshow player.
- Designed to run on a basic 1200, but with features for hardrive equipped
  machines with more RAM and faster CPUs.
@ENDNODE
@NODE USAGE "Usage..."
@{fg shine}  _____________________________   ____      @{FG FILL}@{"Main SFMV Guide" LINK SFMV:Guides/SFMV.Guide/MAIN}@{FG SHINE}
 /'  _____/\_   _____/'    \`  \ /'  /
 \_____ ~\  |'   __)/  \ /  \   X   /       @{fg text}Player@{fg shine}
 //       \ |     \/    Y    \     /
/_______  / \___  /\____|__  /\___/
~       \/      \/         \/@{fg text}
@{u}                                                                           @{uu}
SFMV Player Usage.

The SFMV Player can be used in two modes.

@{FG HIGHLIGHT}@{b}@{u}Direct mode@{ub}@{uu}@{FG TEXT}

With this mode just enter the filename of your animation, ie

@{FG SHINE}SFMV_Player @{i}filename@{ui}@{FG TEXT}

For  example, if you have an animation in your 'WORK:SFMV_Animations' drawer
called 'Test.SFMV' then enter,

@{FG SHINE}SFMV_Player Work:SFMV_Animations/Test.SFMV@{FG TEXT}

The  direct  mode is mainly for use as a preview mode.


@{FG HIGHLIGHT}@{b}@{u}Script mode@{ub}@{uu}@{FG TEXT}

This  mode will allow you to put together a full animation. The script is in
the  following  format  (  Please  note, all this is handled by the supplied
@{"Script Generator" LINK SFMV:Guides/SFMV_ScriptGen.Guide/MAIN} utility and is merely here for completeness ).

@{FG SHINE}SFMV Script File Format@{FG TEXT}
@{FG FILL}@{"SFMV. Copyright SHOAH 1996              " link Firstline}
@{"MultiLoad=Yes|No                        " link Secondline}
@{"Screen=Pal|NTSC                         " link Thirdline}
@{"Loop=Yes|No                             " link Fourthline}
@{"Mod=filename|No                         " link Fifthline}
@{";Enter the file names here... ( Max 64 )" link Sixthline}
@{i}filename@{ui}
@{"End.                                    " link Seventhline}
@{FG TEXT}
If  you  want  to  put the script together by hand then please note that the
script  commands  MUST  be placed in exactly the same order.
@{"View example script" LINK SFMV:Examples/Intro.Script/MAIN}

To  actually  use  the  Script mode make the current directory the animation
directory  and  then  enter  the script name, eg ( Using the above directory
names )

@{FG SHINE}cd Work:SFMV_Animations
SFMV_Player @{i}Scriptname@{ui}@{FG TEXT}
@ENDNODE
@NODE Firstline "SFMV. Copyright SHOAH 1996"
@{fg shine}  _____________________________   ____      @{FG FILL}@{"Main SFMV Guide" LINK SFMV:Guides/SFMV.Guide/MAIN}@{FG SHINE}
 /'  _____/\_   _____/'    \`  \ /'  /
 \_____ ~\  |'   __)/  \ /  \   X   /       @{fg text}Player@{fg shine}
 //       \ |     \/    Y    \     /
/_______  / \___  /\____|__  /\___/
~       \/      \/         \/@{fg text}
@{u}                                                                           @{uu}
@{FG SHINE}'SFMV. Copyright SHOAH 1996'@{FG TEXT}

This is simply our copyright message, please don't screw around with it !
@ENDNODE
@NODE Secondline "MultiLoad=Yes|No"
@{fg shine}  _____________________________   ____      @{FG FILL}@{"Main SFMV Guide" LINK SFMV:Guides/SFMV.Guide/MAIN}@{FG SHINE}
 /'  _____/\_   _____/'    \`  \ /'  /
 \_____ ~\  |'   __)/  \ /  \   X   /       @{fg text}Player@{fg shine}
 //       \ |     \/    Y    \     /
/_______  / \___  /\____|__  /\___/
~       \/      \/         \/@{fg text}
@{u}                                                                           @{uu}
@{FG SHINE}'MultiLoad=Yes|No'@{FG TEXT}

This  sets the mode of operation for your animation and depends on what kind
of anim you wish to produce.

@{FG HIGHLIGHT}Multiload=Yes@{FG TEXT}

This will load each file as soon as the previous one has finished.  Set this
to  Yes  for  making  hardrive  only  anims ( Using this from a floppy based
system  won't produce very good results due to the speed of floppy disks, ie
your anim will suffer long gaps between frames ).

@{FG HIGHLIGHT}Multiload=No@{FG TEXT}

For  making  floppy  based  demos.   All  the files are loaded in before the
Player starts displaying anything.
@ENDNODE
@NODE Thirdline "Screen=Pal|NTSC"
@{fg shine}  _____________________________   ____      @{FG FILL}@{"Main SFMV Guide" LINK SFMV:Guides/SFMV.Guide/MAIN}@{FG SHINE}
 /'  _____/\_   _____/'    \`  \ /'  /
 \_____ ~\  |'   __)/  \ /  \   X   /       @{fg text}Player@{fg shine}
 //       \ |     \/    Y    \     /
/_______  / \___  /\____|__  /\___/
~       \/      \/         \/@{fg text}
@{u}                                                                           @{uu}
@{FG SHINE}'Screen=Pal|NTSC'@{FG TEXT}

This  sets the screen mode for the player.  If your animation is designed to
run  purely  from  a  standard 2Meg 1200 then setting the NTSC flag may help
speed  the  playback  up.   Please  note,  due to the nature of NTSC mode an
animation which is 256 pixels high will be cropped.
@ENDNODE
@NODE Fourthline "Loop=Yes|No"
@{fg shine}  _____________________________   ____      @{FG FILL}@{"Main SFMV Guide" LINK SFMV:Guides/SFMV.Guide/MAIN}@{FG SHINE}
 /'  _____/\_   _____/'    \`  \ /'  /
 \_____ ~\  |'   __)/  \ /  \   X   /       @{fg text}Player@{fg shine}
 //       \ |     \/    Y    \     /
/_______  / \___  /\____|__  /\___/
~       \/      \/         \/@{fg text}
@{u}                                                                           @{uu}
@{FG SHINE}'Loop=Yes|No'@{FG TEXT}

This is a simple flag to make your animation loop forever or just quit after
the last frame has been displayed.

Please  note  this mode can be overridden, for example if you set the master
loop  flag to no but the last animation in your script has the loop flag set
with a counter of 0 then the last animation will loop forever.
( See the @{"Convertor" LINK SFMV:Guides/SFMV_Convertor.Guide/MAIN} Docs for more on the loop flag ).
@ENDNODE
@NODE Fifthline "Mod=filename|No"
@{fg shine}  _____________________________   ____      @{FG FILL}@{"Main SFMV Guide" LINK SFMV:Guides/SFMV.Guide/MAIN}@{FG SHINE}
 /'  _____/\_   _____/'    \`  \ /'  /
 \_____ ~\  |'   __)/  \ /  \   X   /       @{fg text}Player@{fg shine}
 //       \ |     \/    Y    \     /
/_______  / \___  /\____|__  /\___/
~       \/      \/         \/@{fg text}
@{u}                                                                           @{uu}
@{FG SHINE}'Mod=filename|No'@{FG TEXT}

A  flag  for  setting  the  mod ( Music Module ) you want running during the
animation, ie

@{FG HIGHLIGHT}Mod=@{i}filename@{ui}@{FG TEXT}

Will  play  the mod specified.  Please note, if you are designing a demo for
floppy  use  only  on  a basic machine then it may be better to not have any
music running ( Due to speed/memory required to actually play the music ).
@ENDNODE
@NODE Sixthline ";Enter the file names here... ( Max 64 )"
@{fg shine}  _____________________________   ____      @{FG FILL}@{"Main SFMV Guide" LINK SFMV:Guides/SFMV.Guide/MAIN}@{FG SHINE}
 /'  _____/\_   _____/'    \`  \ /'  /
 \_____ ~\  |'   __)/  \ /  \   X   /       @{fg text}Player@{fg shine}
 //       \ |     \/    Y    \     /
/_______  / \___  /\____|__  /\___/
~       \/      \/         \/@{fg text}
@{u}                                                                           @{uu}
@{FG SHINE}';Enter the file names here... ( Max 64 )'@{FG TEXT}

After  the  Mod option line you may enter your own comments by using a ";"
( ie the same way you would comment an assembler source ), eg

@{FG HIGHLIGHT};This demo was created by Squize/SHOAH

;You can enter as many comments as you like

;If testing a demo you may want to comment out a filename@{FG TEXT}
@ENDNODE
@NODE Seventhline "End."
@{fg shine}  _____________________________   ____      @{FG FILL}@{"Main SFMV Guide" LINK SFMV:Guides/SFMV.Guide/MAIN}@{FG SHINE}
 /'  _____/\_   _____/'    \`  \ /'  /
 \_____ ~\  |'   __)/  \ /  \   X   /       @{fg text}Player@{fg shine}
 //       \ |     \/    Y    \     /
/_______  / \___  /\____|__  /\___/
~       \/      \/         \/@{fg text}
@{u}                                                                           @{uu}
@{FG SHINE}'End.'@{FG TEXT}

Make sure that this is your very last line in your script file.
@ENDNODE
@NODE TRICKS "Tricks 'n Tips..."
@{fg shine}  _____________________________   ____      @{FG FILL}@{"Main SFMV Guide" LINK SFMV:Guides/SFMV.Guide/MAIN}@{FG SHINE}
 /'  _____/\_   _____/'    \`  \ /'  /
 \_____ ~\  |'   __)/  \ /  \   X   /       @{fg text}Player@{fg shine}
 //       \ |     \/    Y    \     /
/_______  / \___  /\____|__  /\___/
~       \/      \/         \/@{fg text}
@{u}                                                                           @{uu}
@{FG HIGHLIGHT}@{u}Packing Files.@{uu}@{FG TEXT}

It  may  not always be the best thing to pack all the files.  On a multiload
demo running from Hardisk you may want to keep the demo running smoothly and
unpacking a file will cause a slight delay on slower machines.

As  stated  in  the  @{"Features" link Features}  section,  you  can  use PowerPacked files by
using some form of patch utility, ie Powerpacker Patcher ( Copyright © 1991,
Michael  Berg ).  This WILL slow your demo down a lot when unpacking, but it
may be helpful to those of you who don't have stc ( Stone Cracker ).

You  can  also  pack the mod and the IFF's to save even more space, although
please don't pack the actual script file.

@{FG HIGHLIGHT}@{u}Cutting and Loops.@{uu}@{FG TEXT}

To  really pad out an animation it may be better to cut your usual animation
up  into smaller parts and use the loop flags ( For example, this would work
well with an animation of flying down a tunnel ).

@{FG HIGHLIGHT}@{u}Ending on a static Image.@{uu}@{FG TEXT}

You  may  want  your  animation to end by just displaying the last frame and
waiting for the user to quit with the Left Mouse button.  To do this, create
your  animation  as  usual,  then  make another animation only 2 frames long
using  the  very last image.  From within the converter set the loop flag on
and give it a count of 0.

@{FG HIGHLIGHT}@{u}Setting up your own demo disks ( Floppy ).@{uu}@{FG TEXT}

Format your blank disk.
Make the 'S' and 'C' directories ( Check your mannual if you're not sure ).
Copy the SFMV_Player to the 'C' directory.
Make a directory called ( For example ) 'SFMV'.
Copy  all your files into the 'SFMV' directory ( Including IFFs/Script/Mod )
Load up your text editor and enter...

@{FG SHINE}CD SFMV
C:SFMV_Player df0:SFMV/@{i}Scriptname@{ui}@{FG TEXT}

and save it as S:Startup-Sequence.
Make sure you install the disk ( ie Enter @{FG SHINE}Install Df0:@{FG TEXT} in the Shell/CLI )

The disk should now be a stand alone demo disk.

@{FG HIGHLIGHT}@{u}Setting up your own demo disks ( Hardisk ).@{uu}@{FG TEXT}

Make a directory ( For example ) 'SFMV' and copy all the files to it.
Assign it ( Again, check your mannual )
Enter @{FG SHINE}SFMV_Player SFMV:@{i}Scriptname@{ui}@{FG TEXT} from the Shell/CLI.

You'll  need  a  basic  knowledge  of  DOS  to make your own demos, but it's
nothing too complex.
Also to run the demo from an Icon, set up a project icon and set the default
tool to SFMV_Player ( See the Example one supplied ).
@ENDNODE
@NODE MUSIC "Music Format..."
@{fg shine}  _____________________________   ____      @{FG FILL}@{"Main SFMV Guide" LINK SFMV:Guides/SFMV.Guide/MAIN}@{FG SHINE}
 /'  _____/\_   _____/'    \`  \ /'  /
 \_____ ~\  |'   __)/  \ /  \   X   /       @{fg text}Player@{fg shine}
 //       \ |     \/    Y    \     /
/_______  / \___  /\____|__  /\___/
~       \/      \/         \/@{fg text}
@{u}                                                                           @{uu}
I've  used  fairly  non-standard formats for the music and packed files, and
this  is  because  of  one main reason.  The are the very best of their type
I've  seen,  and  I'm  not going to include crap within my code just to keep
things  compatable  with lower standard software.  If that was the case this
would be 1.3 compatable :)

@{FG HIGHLIGHT}Music Format@{FG TEXT}

This is the Player61a by Jarno Paananen.  You'll have to convert your normal
Pro/Noise/Sound  Tracker mods to this format to be able to include them with
your animation.
@ENDNODE
@NODE PACKER "Packer Format..."
@{fg shine}  _____________________________   ____      @{FG FILL}@{"Main SFMV Guide" LINK SFMV:Guides/SFMV.Guide/MAIN}@{FG SHINE}
 /'  _____/\_   _____/'    \`  \ /'  /
 \_____ ~\  |'   __)/  \ /  \   X   /       @{fg text}Player@{fg shine}
 //       \ |     \/    Y    \     /
/_______  / \___  /\____|__  /\___/
~       \/      \/         \/@{fg text}
@{u}                                                                           @{uu}
@{FG HIGHLIGHT}Packer Format@{FG TEXT}

This is Stone Cracker ( stc ) V4.10.3 Pro by Jouni Korhonen.

I'd  just  like  to  labour  the  point that I think it's a crime that Stone
Cracker  has had very little support anywhere, perhaps it's just me, but not
supporting  the  best  packer  around  seems a little bit stupid.  It's like
using Lha instead of Lzx, just 'cause you had Lha first.

If  you have difficulty getting either of these programs then have a look on
Aminet or check out the list of PD libraries in the @{"Distribution" link SFMV:Guides/SFMV.Guide/DISTRIBUTION} link.
@ENDNODE
@NODE CREDITS "How I did all the work myself..."
@{fg shine}  _____________________________   ____      @{FG FILL}@{"Main SFMV Guide" LINK SFMV:Guides/SFMV.Guide/MAIN}@{FG SHINE}
 /'  _____/\_   _____/'    \`  \ /'  /
 \_____ ~\  |'   __)/  \ /  \   X   /       @{fg text}Player@{fg shine}
 //       \ |     \/    Y    \     /
/_______  / \___  /\____|__  /\___/
~       \/      \/         \/@{fg text}
@{u}                                                                           @{uu}
@{FG HIGHLIGHT}SFMV concept and Player code by Squize/SHOAH.

SFMV File Format and Support utils by Vex/SHOAH.@{FG TEXT}

Additional code by Jarno Paananen and Jouni Korhonen, thanks ( Again ).

Playtesting by Paul and Stephen/Sublime.

Hellos to...

Knob/LDS
Bryan/Assassins
PJ/Arrow
Phil/SaddleTramps
Sue/SeaSoft
Adrian/Future PD
Chris/HorneSoft

And everyone else we have known along the way...

					  For the three girls in my life...
@ENDNODE
@NODE FUTURE "Future..."
@{fg shine}  _____________________________   ____      @{FG FILL}@{"Main SFMV Guide" LINK SFMV:Guides/SFMV.Guide/MAIN}@{FG SHINE}
 /'  _____/\_   _____/'    \`  \ /'  /
 \_____ ~\  |'   __)/  \ /  \   X   /       @{fg text}Player@{fg shine}
 //       \ |     \/    Y    \     /
/_______  / \___  /\____|__  /\___/
~       \/      \/         \/@{fg text}
@{u}                                                                           @{uu}
@{FG HIGHLIGHT}The Future@{FG TEXT}

We  have  got  about  a  million ideas on the go to improve this ( We had to
release it now otherwise we'd still be adding to it in a years time !  ).

Some of the ideas are...

Improved compression, including a Delta compression routine.

A lot more script based options and improved handling of IFFs.

Perhaps  a Pro version more suited to hardrive use ?  ( Using ASL requestors
etc.  )

We are also keen to hear your ideas on this...
@ENDNODE
@NODE INDEXNODE "Index"

@{FG HIGHLIGHT}- C -@{FG TEXT}
@{" Comments ';'        " link "Sixthline"}
@{" Convertor           " LINK "SFMV:Guides/SFMV_Convertor.Guide/MAIN"}
@{" Credits             " LINK "CREDITS"}

@{FG HIGHLIGHT}- D -@{FG TEXT}
@{" Direct              " link "Usage" 12}
@{" Distribution        " LINK "SFMV:Guides/SFMV.Guide/DISTRIBUTION"}

@{FG HIGHLIGHT}- E -@{FG TEXT}
@{" End.                " link "Seventhline"}

@{FG HIGHLIGHT}- F -@{FG TEXT}
@{" Features            " LINK "FEATURES"}
@{" Future Plans        " LINK "FUTURE"}

@{FG HIGHLIGHT}- I -@{FG TEXT}
@{" Introduction        " LINK "OVERVIEW"}

@{FG HIGHLIGHT}- L -@{FG TEXT}
@{" Loop=Yes|No         " link "Fourthline"}

@{FG HIGHLIGHT}- M -@{FG TEXT}
@{" Main SFMV Guide     " LINK "SFMV:Guides/SFMV.Guide/MAIN"}
@{" Mod=filename|No     " link "Fifthline"}
@{" MultiLoad=Yes|No    " link "Secondline"}
@{" Music Format        " LINK "MUSIC"}

@{FG HIGHLIGHT}- P -@{FG TEXT}
@{" Packer Format       " LINK "PACKER"}
@{" Patch               " link "Tricks" 14}
@{" Player61a           " link "Music"}

@{FG HIGHLIGHT}- S -@{FG TEXT}
@{" Screen=Pal|NTSC     " link "Thirdline"}
@{" Script              " link "Usage" 26}
@{" Script First Line   " link "Firstline"}
@{" Script Generator    " LINK "SFMV:Guides/SFMV_ScriptGen.Guide/MAIN"}
@{" SHOAH               " LINK "SFMV:Guides/SFMV.Guide/SHOAH"}
@{" Stone Cracker       " link "Packer"}

@{FG HIGHLIGHT}- T -@{FG TEXT}
@{" Tricks 'n Tips      " LINK "TRICKS"}

@{FG HIGHLIGHT}- U -@{FG TEXT}
@{" Usage               " LINK "USAGE"}

@{FG HIGHLIGHT}- V -@{FG TEXT}
@{" View example script " LINK "SFMV:Examples/Intro.Script/MAIN"}
@ENDNODE