@DATABASE "OptiMod v4.30"

@NODE MAIN "OptiMod v4.30"

Q-TECH Tools...
                    O P T I  M O D    version 4.30

            - THE PROTRACKER/NOISETRACKER MODULE OPTIMIZER -

                         Written by Joakim Ögren


      (C) Copyright 1992,93 Quality Technology - All rights reserved

                    Remember: Use the NEWPM option!!


@{" Distribution " link 1.}
@{" Disclaimer " link 2.}
@{" Author " link 3.}
@{" Purpose " link 4.}
@{" READ THIS!!! " link 5.}
@{" Template " link 6.}
@{" Examples " link 7.}
@{" Tips about Usage " link 8.}
@{" Message to all Musicans. " link 9.}
@{" Thanks " link 10.}
@{" SHAREWARE " link 11.}
@{" New version. " link 12.}
@{" PowerMusic " link 13.}
@{" How to contact me " link 14.}
@ENDNODE

@NODE 1. "Distribution"

      All these programs are copyrighted by Quality Technology. But
    they are freely distributable as long as it's not included in any
    comercial product or sold for a price higher than the cost for the
    disk and drive use. All documents and files must always be kept
    together. The only exception is when it's copied to eg a harddrive
    for own use. You are not allowed spread it unless it's a 100%
    complete package. You are neither allowed to spread it if any file
    is changed. The best way to distribute it, is in a LhA archive.
     It may not be included in any comercial products without contacting
    the author before.

      All files are also classified as SHAREWARE. That means that you are
    not allowed to use for a longer time than two weeks it if you haven't
    paid the shareware fee. But you are allowed to distribute it. More
    about the shareware fee later.

      Fred Fish have the right to include OptiMod in his Amiga Library.
    Other makers of PD-series also have the right to include it as long
    as all rules above are respected.

      Please respect these rules, and I will continue to make new
    versions of OptiMod.

    All files:

      OptiMod                    MainProgram
      OptiMod.doc                Documenation
      OptiMod.doc.info           icon
      OptiMod.guide              Documentation in AmigaGuide-format
      OptiMod.guide.info         icon
      OptiMod.history            Historyfile
      OptiMod.history.info       icon
      OptiMod.RegForm            Registration form
      OptiMod.RegForm.info       icon



@ENDNODE

@NODE 2. "Disclaimer"

      The author cannot be held liable for the suitability or accuracy of
    this manual and/or the program(s) it describes. Any damage (software
    or hardware damage) directly or indirectly caused by the use or misuse
    of this manual and/or the program it describes is the sole responsibility
    of the user her/him self.



@ENDNODE

@NODE 3. "Author"

      OptiMod is written by Joakim Ögren in assembler to get the
    program as short and fast as possible. OptiMod requires
    OS2.0 (V37+) to run, since it uses many of 2.0 features to
    get it as fast,short and powerfull as possible. If you only
    have 1.3 or lower I can only say: Upgrade :-)



@ENDNODE

@NODE 4. "Purpose"

      OptiMod is a utility to optimize NoiseTracker and ProTracker
    modules. All modules must be in the 31 instruments fileformat
    and be a ProTracker/NoiseTracker module. ie OptiMod won't
    accept any StarTrekker or 15 instruments SoundTracker modules.
    To use OptiMod on any of them please load them into ProTracker
    (or some other Tracker) and save it again.

      OptiMod started when I saw that most modules were longer than
    they would have to be. And the stupid fileformat of modules doesn't
    make it shorter. Some other authors have already tried to do this
    but in another way: Azatoth of Phenomena with his ProPacker, but it
    changed the whole format and deleted all instrument names etc.
      But by using OptiMod with the NewPM option, and then crunch/archive
    them you'll gain about 10% than just crunching it.

    YOU'LL SAVE ABOUT 40-50% WITH   NEWPM OPTION + LhA   (by Stefan Boberg)

      But now with OptiMod you can optimize modules and they will sound
    EXACTLY the same. OptiMod will try to do these things:


    - Rearrange patterns to take less space.
      ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ
        For instance by using pattern 0,1,2 & 6. All patterns in the middle
      will be saved (3,4 & 5) but unused and empty. This will gain 1024
      bytes per deleted pattern. OptiMod won't delete any used pattern.
      As long as it's in the 'SongPositions' it will be left.
        Duplicate patterns will be removed.


    - Delete unused samples.
      ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ
        Every unused but existing sample will be deleted.


    - Cut away zeros in the end of Samples.
      ŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻŻ
        If a instrument/sample ends with many zeros they will be cut away.
      This will not affect how it sounds, if the zeros is in a loop they
      will not be deleted. At least 2 zeros is always left to make the
      sound not 'click' at the end.
        Sample data after a loop is deleted. Watch out if you're using
      the command to start playing a sample at a certain offset.


    - Garbage
      ŻŻŻŻŻŻŻ
        If the module contains garbage at the end of the module it will
      be cut away. Some rippers save some bytes extra just in case. But
      OptiMod will cut them. Please note that Garbage gain can be negative.
        If it is negative the module wasn't correct at the start. OptiMod
      will add some bytes were it should be. (Load it into ProTracker,
      and you'll see the same result)


    Optimod has also the ability to check who has done the module. If you
    use the Verbose (No option), Short or Name mode you'll see the authors
    name (if any). OptiMod will search thru all sample names for strings.



@ENDNODE

@NODE 5. "READ THIS!!!"

    DO NOT USE OPTIMOD ON MODULES THAT AREN'T FINISHED. THIS MAY CAUSE SOME
    NOT YET INSERTED PATTERNS/SAMPLES TO BE DELETED!!!

    DON'T BLAME ME IF SOMETHING GOES WORNG, I HAVE NOTE YET FOUND A MODULE
    THAT WERE CORRUPTED AFTER OPTIMIZING. AND I HAVE TESTED ON ABOUT 900 (!)
    MODULES.

    THE MODULE WILL SOUND EXACTLY THE SAME AFTER OPTIMIZATION AS BEFORE!!!

    If OptiMod crashes or won't optimize a module correctly, please load it
    into ProTracker and save it again.

    If newer versions of ProTracker changes the fileformat or adds new
    advanced commands, I can't garantee OptiMod to work correctly!



@ENDNODE

@NODE 6. "Template"

    OptiMod   SOURCE,DESTINATION,SHORT/S,SHORT2/S,MEDIUM/S,NAME/S,QUIET/S
              NS=NOSAVE/S,NPAT=NOPATTERN/S,NSMP=NOSAMPLE/S
              NSMPLEN=NOSAMPLELEN/S,NA=NOAUTHOR/S,NOPP/S,NOERROR/S
              NEWPM/S,FX=EFFECT/S,BUG=UNWANTED/S,NOBUFF/S,SAMPLE=INSTR/S
              NORESAVE=NRS/S

    /S is a switch, by using the option you will turn it on.
    =  means that you can use either one of the options. (NS is the
       same sa NOSAVE)

    SOURCE         The module to optimize.

    DESTINATION    If omitted, the source will be the destination.


    SHORT          This will list  FileSize before
                                   FileSize after
                                   Gain
                                   SongLength. (Number of Positions)
                                   Real Module name
                                   Author

    SHORT2         This will list  FileSize after
                                   Gain
                                   SongLength. (Number of Positions)
                                   How much percent with effects
                                   Play time of Module. (Approx.)
                                   Bugs in Module:  - = Legal PosJmp
                                                    P = Illegal PosJmp 
                                                    I = Used nonexistant sample
                                                    Use BUG for more info!
                                   Real Module name
                                   Author

    MEDIUM         This will list  FileSize before
                                   FileSize after
                                   All four Gains (Pat/Smp/SamEnd/Garbage)
                                   Total Gain
                                   SongLength. (Number of Positions)
                                   Real Module name

    NAME           This will list  Filename (no path)
                                   Gain
                                   Real Module name
                                   Author

    QUIET          No output at all

    >> If none of these output modes are selected, the optimization will be
       output in Verbose mode, and when I say verbose I mean VERBOSE!

    NOSAVE         Only examine, don't save the file.


    NOPATTERN      Don't optimize patterns

    NOSAMPLE       Don't optimize samples usage

    NOSAMPLELEN    Don't optimize samples len

    NOAUTHOR       Don't show authors name


    NOPP           Don't use powerpacker.library

    NOERROR        No returncode=20 whenever an error occurs.
                   OM will return 20 if an error occurs, this
                   will for example directly break any script
                   file.

    NEWPM          This will convert the module into the new
                   PowerMusic (see notes below) module format.
                   The module will have the exact lenghts as
                   a normal module, but when you pack with
                   a packer/archiver it will be crunched better.
                   OM will always output normal ProTracker
                   module (except when the optimizationfailed
                   and no file was generated) even if the
                   source file was a PM-module. Keep that in mind.
                   READ THE POWERMUSIC DOC FOR MORE INFO!!!

    EFFECT         This will show some information about how much all
                   effect-commands are used. Both graphically and with
                   numbers.

    UNWANTED       This will spot 'bugs' in a module! You can find any
                   used but nonexisting sample. And nested pos-jumps
                   which causes some positions not to be played.
                   NoSave is automaticly enabled. Module won't be saved.
                   USE IT BEFORE RELEASING ANY MODULE!!! Please...

    NOBUFF         I normal cases OptiMod will allocate a little extra
                   bit of memory after the module, in case that the module
                   are trashed and some instruments are missing. Then it
                   will save zero's at the end istead of trash. By using
                   this option you'll save some bytes of memory. Only use
                   this if you're short of memory.

    INSTR          This will list all instruments. NoSave is automaticly
                   enabled.

    NORESAVE       OptiMod won't save the module if you haven't gained 
                   anything unless you wan't to change the format. From
                   ProTracker to PowerMusic format or the other way.
                   (Good for floppy-only users.)


    Please refer to any AmigaDos 2.0 Reference for more information
    about Templates and modifiers.



@ENDNODE

@NODE 7. "Examples"

    OptiMod mod.LetsRock ns             To just analyze the module.
                                        Great for musicians.

    OptiMod mod.LetsTwist name newpm    Optimize module, save as the same
                                        name as the Source. Show it in Name
                                        output mode. Output file=PowerMusic

    OptiMod mod.LetsBoogie mod.LB nsmp  Optimize everything except sample
                                        usage, and save as mod.LB.



@ENDNODE

@NODE 8. "Tips about Usage"

      It's smart to use OptiMod in conjunction with DirOpus, here is
    two gadgets to use in DirOpus (v3.51+).


    OptiModCheck

    Executable   OptiMod {f} nosave

    Flags:  Output window
            CD source
            Recursive directories
            Do all files
            Reload each time.

    CloseDelay: -1


    - Directory Opus is Copyrighted by Jonathan Potter 1990-92 -
                  - Published by INOVAtronics -



@ENDNODE

@NODE 9. "Message to all Musicans."

      All modules will sooner or later be ripped or spreaded. But when this
    happends it's better that you, the author of the module gets the credits
    instead of no one. Please make it a habbit to write your name in the
    first pattern!

    INSTRUMENT 1: #JOAKIM OGREN______

      And it would be good if you included your adress some place in the
    module as well. Many musicians already do this but some musicians don't.
    Please do it in the future!



@ENDNODE

@NODE 10. "Thanks"

    Thanks to:

      Niklas Edmundsson  For helping me with a lot ßetatesting!!!


      Peter 'Crayon' H   For his ProTracker. Get in touch if you want
                         to include this in the ProTracker.

      Freelancers        Previous ProTrackers..

      Mahoney & Kaktus etc...  for all other Trackers.



      Nico François      For his two Great libraries (powerpacker
                         & reqtools) which I have used in some
                         of my other programs.

      Robert Wahlström   For ßeta testing some of my programs.

      Pierre Andersen    For some modules.

      Martin Larsson     For some modules.

      Kalle Kiviaho      For some suggestions and some modules.

      Myself             For making this wonderful program.



@ENDNODE

@NODE 11. "SHAREWARE"

      This program is SHAREWARE, to get a version without the annoying
    requester in the beginning you should get yourself registred. All
    registred users will recieve a keyfile, this file will disable
    the annoying requester in OptiMod AND in all future QTech Tools
    programs which requires registration. As you recieve new versions,
    (of OptiMod or other QTech Tools Programs) this keyfile will work
    with them also. All distribution of the keyfile is totally forbidden!
    The keyfile is personal.

      You're allowed to use this program for trial period no longer
    than two weeks, if you find this program usable after that trial
    period you must register yourself. Register yourself by sending
    50 SEK or US$10 (by international money order/postal money order
    in SEK, look at Registration Form for more info). As registred user
    you'll get the latest version of OptiMod and other QTech Tools
    availble. If a new version is under development I will wait until
    it's ready before sending the programs/keyfile. Please remember that
    a lot of time and money have been spend on OptiMod and other QTech
    Tools. You SHOULD GET yourself REGISTRED now!

      Continuing to use OptiMod without being registred is both illegal
    and inmoral! ...and #?$*&  :-)

      Use the Registration Form supplied with OptiMod!



@ENDNODE

@NODE 12. "New version."

     To recieve the latest version of OptiMod without registering just send
   a disk full with some GREAT modules (preferable done by you, if you're
   Good  :-> ) and some money for the stamp (optionally send a stamp). And
   you'll recieve the latest version of OptiMod for free (except stamp)

     To just get the latest version you don't have to send in the registration
   card.



@ENDNODE

@NODE 13. "PowerMusic"

     PowerMusic is a new and powerfull moduleplayer. It's the best
   module player ever (That's true! Ask anyone!). Here are some functions.

   o Full xpk support. (Even password, priority etc)

   o Full PowerPacker support.

   o Full PowerPlayer module support. (PMC, thru lh.library)

   o Full LhA support. (That's GREAT)

   o Only for OS2.0+, uses some 3.0 functions if 3.0 is availible.

   o Handles only ProTracker (NoiseTracker) and PowerMusic-modules.

   o All ProTracker commands supported.

   o Full support of CIA timing.

   o Runs as a commodity.

   o Controllable thru JoyPort.

   o LongPlay function.

   o Rnd order of playing.

   o Nice Equalizer.

   o Own module format (PowerMusic-modules), which saves 10% of filelength.

   o LOTS of configuration things.

   o Nice to the system (allocates audiochannels, allocates interrupts.)

   o No known enforcer hits.

   o Written in 100% assembler = Fast!

   o Availible NOW! (Send me a disk with modules and I'll send you PowerMusic!)


@ENDNODE

@NODE 14. "How to contact me"

   Address:       Joakim Ögren  /Q-Tech
                  Snipgränd 69
                  S-90624 UMEĊ
                  Sweden

   NetMail:       2:205/509 (Joakim Ogren)   (No dots above the O)

@ENDNODE

