@DATABASE DASMP
@TITLE "D.A.S.ModulePlayer V.2.2 04.02.1993 by Pauli Porkka"
@NODE masterw


             D.A.S.Module Player V2.2 HELP guide
            =========================================


     @{" Master window " link masterwin} * Main window gadgets.
     @{"    Config     " link config} * Config window gadgets (5 pages)
     @{" Module config " link mcnf} * Module config gadgets.


@ENDNODE
@NODE masterwin

Closing this window (windows closebutton) will cause the Playwindow to open.
Playwindow is a window containing only the playing buttons. Closing playwindow
will cause the master window become active again.

@{b} Add @{ub}
    This function pops out a filerequester. From the filerequester user
    can select one file/multiple files or a whole directory. Selected
    files will be added to the list if file(s) matches with config selection
    @{"add type" link cpage1,120}

@{b} New @{ub}
    Combined CLR and ADD function. Unlike normal CLR function, this will
    clear the whole list, not just active or inactives if that type of 
    "show list" is selected.

@{b} Del @{ub}
    Selected entries will be deleted from the modules list.

@{b} Exg @{ub}
    Click this once and then both the modules you wish to switch, once.

@{b} Mcnf @{ub}
    @{"Module config" link mcnf} window will be opened.

@{b} Listview @{ub}

    NOTE!!! Not every option support @{"multiselection" link multiselecs}.

    List of selectable modules. 
    List contains two columns: Modules name and flags.
    Flags are:
                F/C  = Locate to Fast/Chip
                A/I  = Active/Inactive 
                R/   = Randomized (won't be randomized again until all
                        modules have been played once.
                ##   = Replay count

@{b} Load @{ub}
    This function pops out a filerequester in which user can select one
    list file to be loaded. 

@{b} Save @{ub}
    This function pops out a saverequester in which user can select/type in
    a file name which will be used when saving the current list.

@{b} Clr @{ub}
    When pressed all files currently in a list will be deleted.

@{b} Sort @{ub}
    Sorting will be done for the wisible list depending on a selection
    @{"sort type" link config} in config window.

@{b} 1/2/3/4 @{ub}
    Channel selection "toggle" buttons, when pressed selected channel
    will not be heard. 

@{b} Au @{ub}
    Toggle button. When selected will open Author listing window. Tracing
    routine will keep tracing selections in this window and updates
    the master list. This will keep selected author's modules in list only. 
    @{" Author CFG " link cpage5}

@{b} Search@{ub}
    Active search string gadget. When letters entered will start tracing
    matching modules name from the list. matching selection will be highlighted
    and played if user press "RETURN".

@{b} Play gadgets@{ub}
    These are quite selfexplanatory.

@{b} Info @{ub}
    Opens the info window. 

@{b} Config @{ub}
    Opens a @{"config" link config} window. 

@{b} Eff@{ub}
    Opens/closes the hidden page #2 on master window.
    QScope = QuadraScope view on/off
    DScope = Double Scope view on/off
    Pri = NCC-1701 Task priority.
    Rightmost slider    = Effects speed (approximately 1/50 seconds)

@{b} ? @{ub}
    Brings up the about requesters.

@{b} PWin@{ub} 
    Opens a mini sized play window. Normal window will be closed
    for the duration of the mini window.

@{b} R@{ub}
    Repeat "toggle" button. When pressed causes the module to be 
    repeated as long as the button is kept in its "toggled" state

@{b} Tempo slider@{ub}
    For changing the play tempo of the module.

@{b} Speed slider@{ub}
    For changing the play speed of the module.

@{b} Volume slider @{ub}
    For changing the volume of the module.

@ENDNODE
@NODE config

        @{" Config Page: Misc settings   " link cpage1}

        @{" Config Page: Path & req opts " link cpage2}

        @{" Config Page: External archs  " link cpage3}

        @{" Config Page: External Players" link cpage4}

        @{" Config Page: Author listing  " link cpage5}


@{b} Page cycle @{ub}
    Switches between different config pages (5 of them)
    Although not visible, this cycle can be controlled using key "p".

@{b} Defaults @{ub}
    Sets default settings to all selections. It is recommended to do
    this first time you start using D.A.S.MP.

@{b} Save @{ub}
    Saves current configs to ENV: and ENVARC:
    Saves: External Archive list, External Player list, Author/Style list,
        Cfg page1/2/3 options and ASL reqeuster Width/Height (dasmp.config).

@{b} Use @{ub}
    Saves current configs to ENV:
    Saves: External Archive list, External Player list, Author/Style list,
        Cfg page1/2/3 options and ASL reqeuster Width/Height (dasmp.config).


@ENDNODE
@NODE cpage1

@{b} Force filter off @{ub}
    When set always disables audio filter. When unset leaves the
    decision for the module to decide.

@{b} Fade @{ub}
    Set fading on/off

@{b} Fade speed @{ub}
    Sets the fading speed. Values ranging from 0(disabled) to 6.
    Find suitable value for yourself.

@{b} Joystick control @{ub}
    This is actually quite unuseful option, but I did it anyway.
    Thus you can scroll through the master module list by using joystick.
    From version 2.2 and above also a popup window is added. If you have
    some other screen in front than that which DASMP is located in, then 
    little window is opened on center of the frontmost screen. You don't
    have to see the DASMP master window to control it with joystick.


@{b} Effect Trace @{ub}
    Affects on "fwd" commands. When set, program traces effect commands in
    patterns so that no effect gets untranslated. When this option is
    unset the fwd commands doesn't trace commands and some speed/volume
    controls may get through and the module may sound somewhat odd.
    Quite useful option, if it just worked properly. I hate to admit
    but there is still unfound bug in this routine and results may not
    be what expected.

@{b} Double checking@{ub}
    When enabled will prevent adding same file twice. Note that the
    whole list will be scanned and not only the visible list.
    Also scans the Inactives against actives.    

@{b} Ending time set@{ub}
    Controls the modules end time setting. If enabled: Everytime module
    is played the modules duration time will be set. When you have played
    all your modules once trough you should disable this. 
        
@{b} Alloc channels @{ub}
    When set, always tries to allocate all audio channels so that no
    program may get to them.
    
@{b} Locate module to Fast@{ub}
    Loads the module to FAST ram and then moves samples to chip, this
    works only for the internal player and external players supporting it.
    As you may have realised, this just keeps the song data in fast
    but all samples go to chip as they normally do.

@{b} Archive's first file @{ub}
    When External packet such as LHA is found, normally (when this set)
    only the first file will be taken from there, but if this is
    unset then all files are extracted and added to the list.

@{b} Double buffering @{ub}
    When set, currently playing module keeps playing until new module
    is ready to be played. Well, actually currently playing module will
    be stopped and removed before fast ram relocation/initialization
    (if selected).

@{b} Pre schedule load@{ub}
    If enabled, player will inform DASMP that song is about to end
    one pattern ahead of its time. This will hopefully prevent
    some of those situations, where song will start playing again
    before decrunching is completed. Note that for External Players
    this is only done if it supports this option.

@{b} Use reqtools@{ub}
    Reqtools filerequester used instead of asl. 
    Whole directory selection supported for reqtools.    

@{b} Delete for real@{ub} 
@{b}    CAUTION!! USING THIS OPTION DELETES THE MODULE FROM DISK!!!!@{ub}
    Deleted module will also be deleted from disk!! 
    This option is not saveable, so selected state won't stay after
    quit. This will also be verified with a requester for security.
    
    Apart that it is dangerous, it is also very handy for removing unwanted
    modules. Now you don't have to jump between directory management program
    and DASMP anymore.

@{b}    CAUTION!! USING THIS OPTION DELETES THE MODULE FROM DISK!!!!@{ub}
    
@{b} Autoplay @{ub}
    Selections: 
    No autoplay = Never autoplay
    List loaded = Do autoplay always when list is loaded.
    Always      = Do autoplay always when file added or list loaded.

@{b} Mode @{ub}
    Playing modes:
    All seq.    = Play all modules in list in order repeating list.
    All once    = Play modules in list once, then stop.
    One Once    = Play selected module and then stop
    All Random  = Play all modules in random.

@{b} Sort @{ub}
    Sorting modes:
    Name        = Alphabetical sorting on all modules.
    Date        = Date order sorting, from older to newer.
    Reverse N.  = Reverse alphabetical sorting.
    Reverse D.  = Reverse date order sorting, from newer to older.

@{b} Show List @{ub}
    This option is made so that you may divide all your modules to two
    groups. Active and inactive groups. 
    Selections:
    Show all    = Shows all modules, actives and inactives.
    Show Actives= Show only those modules with "A" flag set.
    Show inactvs= Show only those modules with "I" flag set

    This option is useful ex. when you have modules on your harddisk and
    lots a modules in normal floppy disks. You could add those floppy based
    modules as inactives and those on harddisk as actives and be able
    to see what you have by selecting "show all". When you'd liked to play
    something from the disks you'd select it as normal, and system would
    ask you to insert proper disk in to the drive. Easy or what.
    (one my cute but not so useful options)

@{b} Int type @{ub}
    interrupt type selection:
    CIA     = One of the four available CIA interrupts.
                (Software interrupt used if Level 6 allocated)
    VBlank  = Vertical blanking interrupt, not recommended.
    
@{b} Add type @{ub}
   
    Normal  = all selected files are always added (normal operation)
                (If not in conflict with @{"Double checking" link cpage1,30} option.)
    Date upd.= Date update sequence, only files newer than the current
            list file are added. Current lists date can be found from
            @{"Config page 2" link cpage2,22}

    Check   = Changes the "ADD" button to "CHK" button. After pressing
            the CHK button DASMP will check through the list querying
            if the file really exists, if it doesn't you will be hit
            with a requester asking what to do with the module.

            Selections:
                DEL     = delete this module
                DEL ALL = Delete all non-existing modules when encountered.
                SKIP    = Leave this module untouched
                STOP SCAN = Stop scanning.

@ENDNODE
@NODE cpage2

@{b} Mod patt. @{ub}
    Default pattern which is used in filerequesters to filter unwanted
    files.

@{b} List patt @{ub}
    Default pattern which is used in filerequesters to filter unwanted
    files. For list files only. (options LOAD/SAVE)    

@{b} Mod dir @{ub}  
    Directory definition which is used as default in filerequesters and
    Arexx commands. For single or multiple modules

@{b} List dir @{ub}
    Directory definition which is used as default in filerequesters and
    Arexx commands. For List files only.
    
@{b} Temp dir @{ub}
    Directory specification for temporary directory where external packets
    are temporarely extracted before loading them into the memory.
    RAM: is good selection here, no unnecessary disk accesses required.

@{b} Current List date@{ub}
    This is the date which is used when doing "add update" on selected
    files/directories.

@{b} DMA Wait @{ub}
    Dmawait time for PT player. Values like:
    Old 68000 7MHz machine = 300
    A3000/25Mhz            = 1200 - 2000
    You should experiment different values here, so that you find
    suitable values for your machine. When the value is too small samples
    gets cut from odd places and module sounds strange.


@ENDNODE
@NODE cpage3

This page contains the External Archiver Listing system controls.
Using this with right values makes possible to use almost any archiver with
DASMP. Such as LHA, ZIP, ZOO... and others can be used. 

@{b}Listview@{ub}
    This list contains ExtArch nodes found from file "dasmp.extarc".
    Selecting any ne of these causes values in it to be placed
    on their own places in this window.

@{b}New@{ub}
    Makes a new ExtArc node available and to be filled with proper values.

@{b}Del@{ub}
    Deletes selected entry from list. (No undo option available)

@{b}Page@{ub}
    Switches between sub-pages in this window.

@{b} Packer path @{ub}
    path + filename for your external archiver (like LHA). This is used
    on command lines when performing operations needing external packer.
    
@{b} Packer opts @{ub}
    Command options for external archiver. This is used when extracting
    files from archive. 
    For example lha archivers opts line is: "e -x0 -N <>NIL:"

@{b} Packer ~()@{ub}
    Pattern definitions for external archiver. This should contain
    something like ~(#?readme#?), this instructs external archiver not to
    extract files like BBSreadme.txt. Only used when extracting multiple 
    files from listing file.

@{b} Ending ID @{ub}
    Pattern definition for selecting files which should be directed to 
    external archiver. External archiver files are recognise using
    this pattern. For example (#?.LHA|#?.LZH) should instruct this
    node to be used when lha/lzh archives found.

@{b} Match string @{ub}
    
    Match string for finding out external archivers ID. 
    "?" matches any character. For LHA archiver proper string
    is "-lh?-"
    
@{b} name offs @{ub}
    Offset value counted from start of Match string. From this offset
    player expects to find start of the name of the file in external archive.
    Used only when extracting with "first file in archive" - option. 
    For lha archiver this should be set to 20.

@{b} Name len @{ub}
    Offset counted from start of match string. From this offset
    player expects to find size of the name in external archive.
    Only used when extracting with "first file in archive" - option.
    For Example the LHA archiver should use value 19.

@{b} Listing opts @{ub}
    Listing opts feeded to external archiver when extracting list file 
    of the contents of the archive. Only used when "First in archive" - option
    is NOT set i.e using multifile extraction.

    For example LHA archiver: "lq -N" should be used.

@{b}Byte name @{ub}
    When this option is set, player expects byte value as name lenght. This is
    not supposed to be changed, keep this set.

@{b}Multifiles?@{ub}
    Does this archiver support listing? Only listing which outputs
    pure filenames is supported.
    If proper values set to string: "Listing opts" this can be used.

@{b}First files?@{ub}
    Does this archiver support single file raw extraction? If 
    proper values set to strings: "Match string","Name offs","Name len"
    this can be used.

@{b}Temp dir?@{ub}
    Some archiveers/unarchivers don't support "define destination". For example
    my unzip did not accept any destination for unarchiving. So when
    this option is enabled DASMP won't try to feed/use destination
    temporary directory. Unarchiving and Loading will happen to and from
    somehere, but hopefully will be succesfull. Sorry for any inconvinience.

@ENDNODE
@NODE cpage4

@{b} External player list @{ub} The leftmost list.

    Here are listed all currently selected das????.library files.
    You will have to add everyone of the libraries separately when
    first time using the player. If you are not going to play any
    modules which are supported through external player library you
    don't have to do anything in here. There should always be one listnode
    located here and that is the "Internal player", you cannot delete it 
    from the list.

@{b} Query list @{ub} The rightmost list.
    This is only for showing the contents of the "query" about the
    external player library.
    
@{b} Query @{ub}
    Performs query operation for the selected library. Results will
    be visible in the rightmost listview.

@{b} Add @{ub}
    Brings up a filerequester where you are able to select das#?.library
    named libraries for the external libraries list. When player loads a
    module it will scan through this list for matching external player
    library or internal player. When the library is selected from the
    filerequester, D.A.S.MP will make a query about its properties and
    add it to the list if suitable values were found.

@{b} Del @{ub}
    When selected will remove selected entry from the external player list.

@{b} Config@{ub}
    Not implemented at this time.

@ENDNODE
@NODE cpage5

Purpose of author listing is to maintain list of Authors you might
want to use to sort your modules. dasmp.author file will be created when
you either "USE" or "SAVE" current configs. 

@{b} Author List @{ub}
    This is the actual listing of available authors in your dasmp.author
    file. When you select an entry, that entry will be copied to the string
    gadget above the list where you may edit it at will. remember to press
    enter/return when finished with modifications.
    
@{b} New @{ub}
    This causes a new entry to be displayed in the list. Entry has following
    name "--- NEW ---", after new entry has been created you may edit it
    for your purposes.

@{b} Del @{ub}
    This delets the active entry from author list.
    WARNING: In general you should NOT remove entries from this list
    after you have already marked modules to have been made by certain
    person/alias. If you however delete an entry it might cause some 
    modules to become "authored" by someone else it originally was.

@{b} Sort @{ub}
    Sorts the author list. The "Unknown" remains always in the first position.

@{b} Author listing window @{ub}
    This window can be opened from two places: Activating "AUTH" toggle
    button from master window or pressing popup button from "MCNF" window.

    Doubleclicking on the entry will cause the entry's specified
    author to be used as list insertion specifier, so that all modules
    with the same internal number as this author will be shown in master
    windows module list. @{" Author popup " link mcnf,30}


@ENDNODE

@NODE mcnf

    Personal configs for every module. 

@{b} Locate to FAST@{ub}
    Relocate to FAST ram. This controls the F/C flag of the module.
    C = Normal location to chip
    F = Fast ram location (song data)

@{b} Randomed@{ub}
    This controls the "R" flag of the module. If set then the module
    is considered to be "randomed" and will not be selected for random
    play until this flags is cleared by user or program.

@{b} +/-@{ub}
    These two buttons controls the repeat count of the module.
    When ex. repeat count is 3 then the module will be played 4 times.
    Endless repeat ofcourse disables this. 

@{b} State @{ub}
    Controls the active/inactive state of the module. 

@{b} True name @{ub} 
    Text gadget which shows the complete name of the module.

@{b} Date text @{ub}
    Here is shown modules statestamp, taken when added to the list.
   
@{b} Time @{ub}
    Moudles playing time if available.

@{b} Style text @{ub}
    Assigned style for the module. Default is "Unknown"

@{b} Author text @{ub}
    Here is shown the assigned author for presently selected module,
    default is "Unknown". 

@{b} Popup authorlist@{ub}
    This pops up a author listing similar to that found in "Author listing"
    page of the configuration window.

    You can set the author for a module doubleclicking in the author 
    list window. Note that you don't have to keep the MCNF window open
    if you don't like it. @{" Author CFG " link cpage5}






@ENDNODE