home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / commod / sdark14s.lha / docs / superdark.doc < prev    next >
Text File  |  1993-03-21  |  21KB  |  654 lines
  1. @AUTHOR "Thomas Landspurg"
  2.  
  3. ## $VER: SuperDark.guide v1.4 (20.3.93)
  4.  
  5. ----------------------------------------------------------------------------------
  6. Main "SuperDark"
  7. ----------------------------------------------------------------------------------
  8.             SuperDark
  9.  
  10.  
  11.     'Introduction'
  12.  
  13.     'Installation'
  14.  
  15.     'Utilisation'
  16.  
  17.     'Configuration'
  18.  
  19.     'Modules'
  20.  
  21.     'Bug report'
  22.  
  23.     'History'
  24.  
  25.     'Adress'
  26.  
  27.     'Thanks to...'
  28.  
  29. ----------------------------------------------------------------------------------
  30. Introduction "Introduction"
  31. ----------------------------------------------------------------------------------
  32. @Toc    "Main"
  33.  
  34.     Whatis SuperDark?
  35.  
  36.     SuperDark is a Screen Blanker...Yet, another one, but this one has
  37. some special features. It's based on the well now program named AfterDark in
  38. the PC and Macintosh World.
  39.  
  40.         SuperDark_1.3, the version of superdark for WBench 1.3 and 1.2 is
  41. no more supported. Move to WB2.0!
  42.  
  43. IMPORTANT NOTE: Don't blame me for my bad english!!! (I'm French you know!)
  44.  
  45.  
  46. Some caracteristics:
  47.  
  48.     - A lot of different effects, but only one effect is loaded in
  49.       memory at a given time.
  50.  
  51.     - Possibility of screen locking, with password.
  52.  
  53.     - And great effects...
  54.  
  55.  
  56. ----------------------------------------------------------------------------------
  57. Installation "Installation"
  58. ----------------------------------------------------------------------------------
  59. Installation
  60. --------------
  61.  
  62. To install SuperDark, just put the SuperDark directory somewhere in your hard
  63. disk, and put the SuperDark program in your WBStartup drawer.
  64. After, just run superdark but don't forget to put the name of the directory
  65. where are the blankers modules in the DARK DIRECTORY string gadget.
  66. If all is correct, you should now see a list with different modules in the
  67. main configuration window.
  68.  
  69. If nothing happen, may be superdark is running, but the main configuration
  70. window is closed. To open it, just run superdark a second time, or just
  71. press the "hotkey" (look 'Configuration'). You can also
  72. try the program from your workbench "commodities exchanges" if you still can't
  73. open this window, and from then selecting superdark and pressing the "show"
  74. gadget.
  75.  
  76. Note: superDark use reqtools.library if present, and especally the screen
  77. format requester, only available with reqtools V38 or higher...
  78.  
  79. Note2: SuperDark need WB2.0 or higher
  80.  
  81. - If you've put superdark in your WBStartup, and if there is this requester
  82. after reboot: "Superdark not yet returned,still waiting?" or something
  83. like that, just add the ToolType DONOTWAIT in the .info of superdark.
  84.  
  85.  
  86. ----------------------------------------------------------------------------------
  87. Utilisation "Utilisation"
  88. ----------------------------------------------------------------------------------
  89. II Utilisation
  90. --------------
  91.  
  92.  To modify parameters, press the key <left shift> and the key <f3>, a
  93. window will appears...the explaination will be given next chapter
  94. Note: if you start another superdark while someone is running, the new
  95. program will exit, but it will told to the older superdark to open is
  96. configuration window.
  97.  
  98.  Immediate blanking: If you press the <left shift>key and the <f4> key at the
  99. same time, there will be an 'immediate blanking', This means that the screen
  100. will be instantanly be blanked.
  101.  
  102.   You can also put the mouse in the lower left corner of the screen to
  103. blank immediatly the screen (in fact after 2 seconds).
  104.   But if you put your mouse in the lower right corner of the screen, 
  105. the screen will neither blank.
  106.  
  107. If don't touch your computer for some time (depending of the configuration)
  108. it will be automaticelly go to a 'blanking state'
  109.  
  110.  
  111. ----------------------------------------------------------------------------------
  112. Configuration "Configuration"
  113. ----------------------------------------------------------------------------------
  114. Configuration
  115. -------------
  116.  
  117. 3.1 The main window configuratiom:
  118.  
  119. Dark directory:
  120.  
  121.   The first important thing in this window, is the 'SuperDark directory'. It's
  122. the place where superdark will look for his blanking modules. So, if you see
  123. nothing in the Modules list, fill the SuperDark directory with the correct
  124. place where you've put the modules.
  125.  
  126. 'Modules'
  127.  In the modules list, you must see the superdark modules (like firework, effets,
  128. ramdom,...).If no, look at the Dar directory paragraph!. With this list you
  129. select the module that you eant to be active during the blanking. The current
  130. selection is show at the bottom of the list.
  131.  
  132. Param:
  133.   This button open the configuration window of the selected module.
  134.  
  135. Tempo:
  136.   This slider gadget allows you to choose the inactivity time of the blanker, in
  137. seconds.
  138.  
  139. Quiet:
  140.   This little checkbox just tell SuperDark to not to show the little window 
  141. when started, the window with: "SuperDark Started,....."
  142.  
  143. Lock:
  144.   If you select this checkbox, a passwd will be asked after each blanking of
  145. the screen. Example: you go somewhere else, but you don't want your computer
  146. be used by someone else.
  147.  
  148. Passwd:
  149.    This gadget allow you to enter the Passwd needed to Unlock Screen.
  150.  
  151. Remove:
  152.    If you press this button, SuperDark will be removed (it will exit)...
  153.  
  154. Save:
  155.    To Save the current parameters of SuperDark and the Random module.
  156.  
  157. Help:
  158.    This will shows you a little information window.
  159. ¸
  160. Hide:
  161.    This button will close this configuration window. If you want to open
  162. it again, just press <left Shift> and <F3> .
  163.  
  164.  
  165.  
  166. ----------------------------------------------------------------------------------
  167. Modules
  168. ----------------------------------------------------------------------------------
  169.  
  170. 3.2 Blankings Modules
  171.  
  172. Note:
  173.    All the parameter window of the blanking module have the four following
  174. buttons:
  175.  
  176.    OK: to close the parameters window and to save configuration
  177.    TEST: to test the effect.
  178.    CANCEL:to close the parameter window, without saving configuration.
  179.    INFO: to have some information on this effect.
  180.  
  181. 'Anim'            'Line'            'Slide show'
  182. 'ARexx'            'Line2'            'Spot'
  183. 'ASWarm'            'Melt'            'Star'
  184. 'Effets'            'Mistify'        'Text'
  185. 'FireWork'        'Music'            'Time'
  186. 'FracBlank'        'Plasma'            'Random'
  187. 'FlyingToaster'        'Plasma Cycle'
  188.  
  189.  
  190. ----------------------------------------------------------------------------------
  191. anim "anim"
  192. ----------------------------------------------------------------------------------
  193. 3.2.1 anim
  194.  
  195.   This effect show you a 3d Object moving on the screen. That's all for
  196. the moment, but this effect is still in developpement to be more attractive!
  197.  
  198.    * Medium   cpu-user.
  199.  
  200.    * small memory-user.
  201.  
  202.  
  203. ----------------------------------------------------------------------------------
  204. ARexx "Arexx"
  205. ----------------------------------------------------------------------------------
  206. 3.2.2 ARexx
  207.  
  208.   This effect allow you to send an ARexx command at the beginning of the
  209. blank, and another command at the end of the blanking period. This allow you
  210. to start for example a music program, paint program or custom program during
  211. blanking. I'am sure that a lot of poeple will find good idea for this effect!
  212.  
  213. AREXXPORT: This is the name of the ARexx port where the ARexx command are send.
  214.  
  215. CMD:    This is the command send at the beginning of the blank.
  216.  
  217. ENDCMD:    This is the command send at the end of the blank.
  218.  
  219.     * Small CPU-Usage
  220.  
  221.     * Small Memory-Usage.
  222.  
  223.  
  224. ----------------------------------------------------------------------------------
  225. ASWarm "ASWarm"
  226. ----------------------------------------------------------------------------------
  227. 3.2.3 ASWarm
  228.  
  229.   This module show you little things moving on screen....Just look at it
  230. to understand! It's based on a Sun effect's, and it was made by Markus Illenser
  231. Matthias Scheler for another blanker.
  232.  
  233. SPEED=[Slow motion | Very Slow | Slow | Normal | Fast | Very Fast | Incredible ]
  234.  
  235. WASPS=[1-10] number of Wasps!
  236.  
  237. BEES=[1-500] number of bees!
  238.  
  239. TIGHTNESS=[1-10]
  240.  
  241. COLOR CYCLING=[ON|OFF]
  242.  
  243. AIM MODE=[ON|OFF]
  244.  
  245.     * Medium to big cpu-user
  246.     * Small cpu-user
  247.  
  248.  
  249. ----------------------------------------------------------------------------------
  250. Effets "Effets"
  251. ----------------------------------------------------------------------------------
  252. 3.2.4 Effets
  253.  
  254.   This in fact three different effects. But all these three effects have
  255. been described in an old issue of the scientific america.
  256.  
  257. TYPE= [ INTERFERENCES | DRAGON | FRAC EFFECT | RANDOM ]
  258.  
  259. DUREE= [ 50-100]
  260.  
  261.     * Big cpu-user
  262.     * Medium memory-user
  263.  
  264.  
  265. ----------------------------------------------------------------------------------
  266. FireWork "FireWork"
  267. ----------------------------------------------------------------------------------
  268. 3.2.5 FireWork
  269.  
  270. This effect show you a FireWork on your screen....
  271.  
  272.     * Big cpu-user
  273.     * Medium memory-user
  274.  
  275.  
  276. ----------------------------------------------------------------------------------
  277. FlyingToaster
  278. ----------------------------------------------------------------------------------
  279. 3.2.xx FlyingToaster
  280.  
  281.     This effect seems to be greatly inspired from the well now AfterDark.
  282. I've take the code from a PD ScreenBlanker, FlyingToaster, from xxx
  283.  
  284.     * Medium CPU-user
  285.     * Medium meory-user
  286.  
  287.  
  288.  
  289. ----------------------------------------------------------------------------------
  290. Fracblank
  291. ----------------------------------------------------------------------------------
  292. 3.2.6 Fracblank
  293.  
  294. Adapted from .....
  295.  
  296.  
  297. ----------------------------------------------------------------------------------
  298. Line
  299. ----------------------------------------------------------------------------------
  300. 3.2.7 Line
  301.  
  302.  The screen will slowly disappears under the lines....
  303.  
  304.     * Small cpu-user
  305.     * Medium cpu-user
  306.  
  307.  
  308. ----------------------------------------------------------------------------------
  309. Line2
  310. ----------------------------------------------------------------------------------
  311. 3.2.8 Line2
  312.  
  313.   This effect will show you multicolored lines...You can choose the number
  314. of lines, their speed, etc....
  315.  
  316.  
  317.     * Big cpu-user
  318.     * Medium memory-user
  319.  
  320. ----------------------------------------------------------------------------------
  321. Melt
  322. ----------------------------------------------------------------------------------
  323. 3.2.9 Melt
  324.  
  325.   Very nice effect! The current screen is suddenly moving in a very particular
  326. manner...Look at this one!
  327.   Three type of effects are available:type1,type2,type3 (not very clear...)
  328.  
  329.     * Medium cpu-user
  330.     * Medium cpu-user
  331.  
  332. ----------------------------------------------------------------------------------
  333. Mistify
  334. ----------------------------------------------------------------------------------
  335. 3.2.10 Mistify
  336.  
  337.   Draw moving line on screen, once again...Based on the Window's effect...
  338.  
  339. NUMBERS=[1-3]
  340. SPEED  =[1-10]
  341.  
  342.     * Medium to Big cpu-user
  343.     * Medim memory-usage
  344.  
  345. ----------------------------------------------------------------------------------
  346. Music
  347. ----------------------------------------------------------------------------------
  348. 3.2.10 Music
  349.  
  350.    This effect is based on my old demo named "The PoiPoi". Four little guys
  351. move with music, while PoiPoi musicians are playing the music...
  352.    You can select wich SoundTracker or protracker module to play, by
  353. selecting it's name in the "Module" string gadget (sorry, no requester for
  354. the moment).
  355.    Each of the musician is assigned to one instrument. Usually, soundtracker
  356. modules have 32 instruments. So you can select what instrument a poipoi
  357. is playing. For example, is instrument number two is a guitar, you can put
  358. "2" in "guitar" field. So the guitarist will play instrument number two!
  359.  
  360.   If the module can't find your module, or if the selected file is not a
  361. protracker/stk module, a default module will be played (mod.wizardy).
  362.  
  363.   Try this effect....Really nice!
  364.  
  365. MODULE=<name of the file to be played>
  366. DRUMMER (L)=<1-32>
  367. DRUMMER (R)=<1-32>
  368. LEFT KEYB = <1-32>
  369. RIGHT KEY = <1-32>
  370. GUITAR    = <1-32>
  371.  
  372.  
  373.     * Medium cpu-user
  374.     * Medim memory-usage
  375.  
  376.  
  377. ----------------------------------------------------------------------------------
  378. Plasma
  379. ----------------------------------------------------------------------------------
  380. 3.2.11 Plasma
  381.  
  382.   This effect is based on plasma effect from the demos. But it's not a 
  383. perfect programming, so there must be some problems on some Amiga...
  384.  
  385.     * Big cpu-user
  386.     * Big Memory-usage
  387.  
  388. ----------------------------------------------------------------------------------
  389. Plasma_Cycle
  390. ----------------------------------------------------------------------------------
  391. 3.2.xx Plasma_cycle
  392.  
  393.     This effect also make plasma, but using a standarts bitmap after
  394. cycle the colormap, so it must look nice...
  395.  
  396.     * Big cpu-user
  397.     * Medium Memory-usage
  398.  
  399. ----------------------------------------------------------------------------------
  400. Shuffle
  401. ----------------------------------------------------------------------------------
  402. 3.2.12 Shuffle
  403.  
  404.   Based on a blanking effect from the XSB program...
  405.  
  406. SPEED=[SLOW | MEDIUM | FAST | VERY FAST ]
  407.  
  408.     * Small cpu-user
  409.     * Medium memory-usage
  410.  
  411. ----------------------------------------------------------------------------------
  412. Slide-show
  413. ----------------------------------------------------------------------------------
  414. 3.2.13 Slide-Show
  415.  
  416.   Rem: This effect is only available in WB2.0 or higher....
  417.  
  418.  This effect allow you to make a slide show of your picture during blanking.
  419. Useful if you are a gfx artist!
  420.   Some explanation:
  421.      You must select wich pictures are shown during blanking by pressing the
  422. 'Add' buttonm and then select the picture you want. Delete will remove the
  423. selected filename in the list of the pictures.
  424.     Show will show you the selected picture during a few seconds.
  425.  
  426. Note: The list of the filename will be saved in the file s:slide-show.cfg
  427.   You can modify this file yourself if you want.
  428.  
  429.     * Small cpu-user
  430.     * Medium to big memory-user
  431.  
  432. ----------------------------------------------------------------------------------
  433. spot
  434. ----------------------------------------------------------------------------------
  435. 3.2.x  Spot
  436.  
  437.     One or more spots will highlight the screen. If the module can
  438. open a screen of one or more bitplanes than the actual one, you can change
  439. the luminosity of the background.
  440.     You will see the real screen in the spot (I mean that if something
  441. happens, something move in the screen, you'll see this in the spots).
  442.  
  443. SIZE   = [1-80]
  444. SPEED  = [1-10]
  445. NUMBER = [1-5]
  446. DOUBLEBUFFER=[TRUE|FALSE]  You can use or not dble buffer, but not in all the
  447.                cases.
  448.  
  449. SHADOW = [0-90]   Percentage of luminosity for the background
  450.  
  451.       * Medium Cpu-user
  452.     * Medium Memory-User
  453.  
  454. ----------------------------------------------------------------------------------
  455. Star
  456. ----------------------------------------------------------------------------------
  457. 3.2.14 Star
  458.  
  459.   This effect will show you a Starfield in your screen. You can change
  460. number of stars and their speed.
  461.  
  462.  
  463. STARS NUMBER=[10-150]
  464. SPEED       =[1-10]
  465.  
  466.     * Big cpu-user
  467.     * Medimu memory-user
  468.  
  469. ----------------------------------------------------------------------------------
  470. Text
  471. ----------------------------------------------------------------------------------
  472. Text
  473.  
  474.    Not a very original effect, but evrybody need this one some days.
  475. Just write a little text on your screen, and you can choose resolution screen
  476. and screen font.
  477.  
  478. TEXT=<your text>
  479. FONTS=<font used> (don't modifiy it from .info)
  480. SCREEN=<screen used> (don't modifiy it from .info)
  481. SPEEDX=[0..5] 
  482. SPEEDY=[0..5] 
  483.  
  484.     * Small to high cpu-user (dpend of the size font)
  485.     * Medium memory-user
  486.  
  487. ----------------------------------------------------------------------------------
  488. Time
  489. ----------------------------------------------------------------------------------
  490. Time
  491.  
  492.   This effect show you a clock. You can choose three different clocks, but
  493. none is really nice...that's why this effect will soon be modified!
  494.  
  495. TYPE=[DIGITAL|AIGUILLE|MODERNE]
  496. SECONDS=[ON|OFF]
  497.  
  498.     * Small cpu-user
  499.     * Medium memory-user
  500.  
  501. ----------------------------------------------------------------------------------
  502. Random
  503. ----------------------------------------------------------------------------------
  504. Random
  505.  
  506.   This effect will choose randomly different other effects! You can
  507. select the effect that you want to be 'choosable' in the selection list.
  508. But if the All Checkbox is checked, all the effect are selectables!
  509.  
  510.   The list of the selectables effects is saved in the file s:dark_random.cfg
  511.  
  512.  
  513.         NOTE:
  514.         ----
  515.  
  516.    The blankers modules are executales, so you can pack them with powerpacker
  517. for instance!
  518.  
  519.   
  520.   
  521.  
  522. ----------------------------------------------------------------------------------
  523. Improvment "Improvment"
  524. ----------------------------------------------------------------------------------
  525.  
  526. Improvment
  527.  
  528.    It would be nice to make a documentation in a correct english! :-)
  529.    --------------------------------------------------------------
  530.  
  531. ----------------------------------------------------------------------------------
  532. BugReport
  533. ----------------------------------------------------------------------------------
  534.  
  535. Now bugs:
  536.     - There is a bug using spot with WB3.0, with the workbench screen. This
  537.     is due to the fact that WB3.0 use interleaved screen! 
  538.  
  539. Bug Report
  540.  
  541.   Please, send me bug reports, or any information (idea, improvment,etc..)
  542.  
  543.   
  544.   I think there is some problems with A1200 or 4000, due to the DblPal mode..
  545. I don't know a lot of this mode. If you have any information, or any problem
  546. you know what to do!
  547.   REM: if you use the lockscreen features, the passwd screen is always
  548. a lowres screen...may be this will cause troubles with VGA monitors in
  549. a 1200.
  550.  
  551.  
  552. ----------------------------------------------------------------------------------
  553. History
  554. ----------------------------------------------------------------------------------
  555. History
  556.  
  557. 01/01/93
  558.     v.09:    -First version realised, on some BBS
  559.  
  560. 30/01/93
  561.     v1.0:    -Lot of bugs fixed, but a lot of bugs still here...
  562. 05/02/93
  563.     v1.1:    - Crash if incorrect configuration fixed
  564.         - TaskPri control added
  565.         - "Mouse in the corner" functions
  566.         - New effect in line.dark
  567.         - New: Spot.dark
  568. 12/02/93
  569.     v1.2:    - SuperDark for OS2.0 or higher is now a commodities
  570.         - Cx_popkey,and blankey can be modified
  571.         - Memory allocation error fixed in spot and anim
  572.         - New: Music.dark! GREAT...
  573.         - First version sent to FredFish and to BBS via SAN
  574. 25/02/93:
  575.     v1.21:    - Bug fixed in module spot.dark: if the screen width was not a 
  576.         multiple of 8 this cause a modulo problem...
  577.         - Bug fixed in the FireWork module, sometime the module never
  578.         exit.
  579.         - The 3d Amiga logo was in the wrong direction in the anim module
  580.         :-)
  581.         - French text removed in the effects and line 2 modules
  582.         - In overscan, Shuffle and line doesn't use the whole screen.
  583.         Corrected.
  584.         - Bug in slide-show: when the param window was opened the
  585.         first time, the file list wasn't correct. Fixed.
  586.         - The "Duree" field in the Random module was not correct. Fixed
  587.  
  588.         - Source: I've finally got the last 2.0 includes files, and I've
  589.         changed my files to fit them. No more "convert.h" file.
  590. 08/03/93:
  591.     v1.22:
  592.         - New type of datas: IMAGE, and DATA_STRING
  593.         - choice of screen reolution in some modules, using reqtools
  594.         requester.
  595. 10/03/93:
  596.     v1.3:
  597.         - Pointer should now disappear...
  598.         - Bug fixed in Plasma (screen depth is now really zero )
  599.         - Music: Now music players should be visible in NTSC :-)
  600.         - Music: File selector (and wait...soon, more interesting things)
  601.  
  602. 20/03/93:
  603.     v1.4
  604.         - Forgot to put UnLockPubScreen() ! Now fixed
  605.         - Look at the font size of window title bar.
  606.         - The famous Uppercase/Lowercase bug reported in Usenet
  607.           corrected. Now blankers modules are also recognise even
  608.           if they use uppercase letters.
  609.         - New type of data: FONT
  610.         - Bug removed in ASwarm if screen depth was less then 2 bitpl.
  611.         - Superdark_1.3 support stopped
  612.         - new: text.dark
  613.  
  614. ----------------------------------------------------------------------------------
  615. Adress
  616. ----------------------------------------------------------------------------------
  617.  Contact adress
  618.  
  619.     Thomas LANDSPURG
  620.     9, Place Alexandre 1er
  621.     78000 VERSAILLES
  622.     FRANCE
  623.  
  624.     FidoNet: 2:320/104.18
  625.     AMyNet:    39:180/1.18
  626.     UseNet:    Thomas_Landpsurg@ramses.gna.org
  627.  
  628.  
  629.  SuperDark may not be included with any commercial product nor may it be
  630.  sold for profit either separately or as part of a compilation without
  631.  my permission. It may be included in non-profit disk collections such as the
  632.  Fred Fish collection. It may be archived & uploaded to electronic bulletin
  633.  board systems as long as all files remain together & unaltered.
  634.  
  635.  
  636.  So you can use this program freely, but if you find it useful, just send
  637. me a letter or postcard with your opinion,
  638.  
  639. ----------------------------------------------------------------------------------
  640. Thanks
  641. ----------------------------------------------------------------------------------
  642. 8. Thanks:
  643.  
  644.  
  645.     Thanks to:
  646.  
  647. - Eric Delord, for his help!
  648. - Frank Geider
  649. - Per Jonsson
  650. - Aeneas Verhe
  651. - Chris Hurley
  652. - Theodore A. Serreyn 
  653.  
  654.