home *** CD-ROM | disk | FTP | other *** search
/ Amiga Times / AmigaTimes.iso / programme / trionbbs110 / Trion / docs / 09_RIPscrip.doc < prev    next >
Encoding:
Text File  |  1998-10-06  |  6.0 KB  |  191 lines
  1.  
  2.  
  3.   Introduction
  4.   ------------
  5.  
  6.    This chapter describes what RIPscrip is and gives a little
  7.    information on how to use it in your menus.
  8.  
  9.  
  10.    What is RIPscrip
  11.    ----------------
  12.  
  13.     RIPscrip (Remote Imaging Protocol Script Language) is a
  14.     Graphical Script Language with wich you can produce all kind
  15.     of graphical effects in your menus and even use Mouse Buttons
  16.     or Mouse Areas to controll your BBS.
  17.  
  18.     RIPscrip is a set of codes .. a bit like the ANSI codes in
  19.     normall BBS screens .. but with RIPscrip you can do a lot
  20.     more then only drawing screens.
  21.     You can draw pixels, lines, circles, arcs bezier curves.
  22.     You can floodfill parts of the screen.
  23.     You can use 16 colors from a palette of 64 (more in newer RIP versions).
  24.     You can change and define line and fill styles.
  25.     Use different fonts in a lot of sizes (not suported
  26.     locally at this moment).
  27.     You can copy pieces of the screen and put them somewhere else
  28.     or load and save pieces from the screen to disk.
  29.     Or load pictures from disk to the screen.
  30.     You can use mouse buttons or mouse fields to make a screen
  31.     clickable.
  32.  
  33.     RIPscrip is a lot more complicated then ANSI, it is almost impossible
  34.     to make screens by hand. You need a special editor to "draw"
  35.     your screens.
  36.  
  37.     The Trion BBS system can display RIPscrip codes locally
  38.     (up to version 1.54 of RIPscrip).
  39.  
  40.     Note that some one who logs in over a serial port needs a
  41.     terminal program with RIPscrip capabilities or else his display
  42.     will be filled with unreadable codes.
  43.  
  44.  
  45.    How to use in menus
  46.    -------------------
  47.  
  48.  
  49.       Note that you have to enable RIPscrip processing with an ANSI-code
  50.       or the RIP commands will be shown as normal text.
  51.  
  52.  
  53.       ESC[1!    Disables all RIPscrip processing.  Any RIPscrip sequences
  54.                 are interpreted as raw text.
  55.  
  56.       ESC[2!    Enabled RIPscrip processing.  Any RIPscrip sequences will
  57.                 be parsed and processed.
  58.  
  59.  
  60.       Folowing is an menu example to show a single RIP screen:
  61.  
  62.       Cmd "1" , 0-255
  63.          Print "esc[2!|"
  64.          PrintFile   "trion:text/tower.rip"
  65.          More
  66.          Print "esc[1!|"
  67.       EndCmd
  68.  
  69.       (Replace 'esc' with the ANSI escape code)
  70.  
  71.       If you want to control a part of your BBS with RIPscrip screens you
  72.       only switch back to ANSI after the last screen because after the
  73.       last code the mouse clicks on RIP icons don't work, and the colors
  74.       are switched back to ANSI colors.
  75.       (RIPscrip uses the EGA color system with 16 colors from a palette
  76.        from 64 colors, which differ from the ANSI colors)
  77.  
  78.       Also note that RIPscrip on PC's use a screen of 640 x 350 pixels
  79.       (80 x 43) characters. So if you want to use the entire RIPscreen
  80.       you have to use the Interlaced mode, if you don't need the bottom
  81.       94 pixels you can use the non-Interlaced mode.
  82.       
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.       Added a menu flag "NOSCREEN" , if you put this after flags
  90.       in the first part of the menu (where hotkeyable is) then
  91.       the menu screen will not be printed.
  92.       This is usefull if there is no menu screen file, because
  93.       with this flag you don't get a warning that there is no
  94.       screen.
  95.       This flag is meant for use with FX (effects) doors that
  96.       can build a screen on there own.
  97.  
  98.       Flags should be separated with a comma !!
  99.  
  100.       For instance:     flags  hotkeyable, noscreen
  101.       Or:               FLAGS  NOSCREEN
  102.  
  103.  
  104.  
  105.       Included a RIPscrip BBS graphics test door.
  106.       I used this to debug RIP code, and to write a functions
  107.       to use RIP codes in doors.
  108.       This door is a good example of some things that are
  109.       possible with RIPscrip, for the people who want
  110.       to experiment with it, the source is included.
  111.       With this in your menu you can view it.
  112.  
  113.       Cmd "T" , 0-255
  114.          CliDoor  "trion:utils/riptest"
  115.       EndCmd
  116.  
  117.  
  118.       RIP menus..
  119.  
  120.       It is now possible to make a menu set the is for a great
  121.       part controlled with a mouse.
  122.       This is basically a demo to demonstrate just that.
  123.  
  124.       The problem with RIP is that you have to give an ANSI code
  125.       to switch it on and off, because if you have it on the ANSI
  126.       colors don't work, and if you turn it off the mouse button
  127.       definitions are gone.
  128.  
  129.       You can make a normal menu set with RIP screens instead of
  130.       the ANSI screens but you have to place print menu commands
  131.       to switch on/off the RIP mode all over the place.
  132.       (see BBS.doc for info about this.
  133.  
  134.       So what you basically want is an FX type of door that switches
  135.       RIP on when the screen is build and switch RIP off after the
  136.       input of a user.
  137.       That is what I have done .. I made an FX door that can
  138.       produce a screen with icons for every menu.
  139.       And because it is an FX door, it has a little graphicall
  140.       effect in it when it waits for input.
  141.  
  142.       On my BBS I made a copy of the menuset especially for
  143.       RIP so it can be viewed with ANSI or RIP.
  144.       When you arrive in the start menu you can go to the
  145.       "normal" menu with return but with R you end up in
  146.       the RIP menu set.
  147.  
  148.       (RIP menuset, Door and source of door is included)
  149.  
  150.       The new menuset is named like this:
  151.  
  152.       xxxxxxxxxx.src       ->      xxxxxxxx_rip.src
  153.  
  154.       In all RIP menus I added the "NOSCREEN" flag, because
  155.       it doesn't needs an ANSI file just the RipDoor FX door.
  156.       But when you've made a screen yourself you can remove
  157.       the NOSCREEN flag and use a normal file for a screen.
  158.       Or when you know a little C you can change the
  159.       door yourself.
  160.  
  161.       Added this to every RIP menu:
  162.  
  163.  
  164.       BuildScreen
  165.          CliDoor  "trion:utils/ripdoor ~50 0"
  166.       EndCmd
  167.  
  168.  
  169.       You have to replace the Zero with a different number
  170.       for each menu like this:
  171.  
  172.  
  173.       main menu      0
  174.       file menu      1
  175.       Mail menu      2
  176.       Bulletin menu  3
  177.       Door menu      4
  178.       Logout menu    5
  179.       Sysop menu     6
  180.       User edit menu 7
  181.       test menu      8
  182.       Browse menu    10
  183.       List menu      11
  184.       Download menu  12
  185.       Read msgs menu 13
  186.       Scan msgs menu 14
  187.       Editor menu    15
  188.  
  189.  
  190.  
  191.