home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / telecomm / bbs / creditor.lha / creditor / Creditor.Doc next >
Encoding:
Text File  |  1995-02-19  |  5.1 KB  |  220 lines
  1. Small docfile for the FileCreditor.
  2.  
  3. * last update of this docfile 18-2-1995 *
  4.  
  5. The main purpose of this door is to have an easy way to
  6. credit uploads and to let the user know his uploads have
  7. been validated. 
  8.  
  9. Extra features :
  10.  
  11. - Fast in and out for quickly validating many files.
  12.  
  13. - Comment on uploaded files. (optional)
  14.   (Both pre-defined and written comments)
  15.  
  16. - Add (Remove) x times the filelength or add (Remove)
  17.   a generic amount of bytes.
  18.  
  19. - Give a penalty or a bonus for a file.
  20.  
  21. - Works with online users too, extra bytes are added 
  22.   immediately.
  23.  
  24. - Keeps a creditrecord for every user.
  25.   This record shows the number of (different) penalties
  26.   the user has and his last up- and download attempt.
  27.   
  28. - Add comments to filedescriptions. (optional)
  29.   (Pre-defined and written.)
  30.  
  31. - Edit bad uploaders. (Even if the user is online)
  32.  
  33. - Kill files.
  34.  
  35. - And some other things...
  36.  
  37.  
  38. Archive contents.
  39.  
  40. Doors:RobTools/Creditor/Creditor         (The Main program)
  41. Doors:RobTools/Creditor/Process          (Displays info to user)
  42. Doors:RobTools/Creditor/GoodComments     (List of comments for good uploads)
  43. Doors:RobTools/Creditor/BadComments      (List of comments for bad uploads)
  44. Doors:RobTools/Creditor/FileComments     (List of filecomments)
  45. Doors:RobTools/Creditor/Creditor.doc     (This file)
  46.  
  47.  
  48. Installation.
  49.  
  50. Put the creditor in your BrowseFile.src. The best place is right 
  51. before the "Validate" command (RetVal(6)).
  52.  
  53. Example :
  54.  
  55. ;===============================================================
  56. ; Browsefile.src
  57.  
  58. CMD = "=" 250-255
  59.    {
  60.    PRINT "Starting up the great creditbasher, please wait...."
  61.    XenolinkDoor "doors:RobTools/Creditor/creditor ~20 ~576"
  62.    RetVal(6)
  63.    }
  64.  
  65. ;===============================================================
  66.  
  67.  
  68. This door does not (yet) write a normal message to the user
  69. about his uploads. Instead the user receives a special message
  70. at login. If no files were processed the door gives the message :
  71.  
  72.  
  73.  
  74.  Checking uploads...
  75.  
  76.  There are no processed uploads in your name.
  77.  
  78.  
  79.  
  80.  
  81. If there are processed uploads the message could look like this :
  82.  
  83.  
  84.  
  85.  You earned 1x 686160 uploadcredits for the file ROKTZ225.LHA
  86.  
  87.  You earned 1x 1000000 uploadcredits for the file AMOSAIC13.LHA
  88.  
  89.  The Sysop says : Thank you, I was waiting for that...
  90.  
  91.  
  92.  <RETURN>
  93.  
  94.  
  95.  
  96. These messages are displayed by a special utilitiy. The best
  97. place for this utility is in your login menu. If you don't have
  98. a login menu you might want to make a "CHECK UPLOADS" command in
  99. your file menu.
  100.  
  101. The process door is called like this :
  102.  
  103. XenolinkDoor "Doors:RobTools/Creditor/Process ~20 Sysop_Name"
  104.               
  105.  
  106. Example login menu.
  107.  
  108. ;============================================================
  109. ; Loginmenu.src
  110.  
  111. CMD = "" 2-255
  112.    {
  113.       REXX "XSCRIPTS:login.rexx"
  114.       PRINT "H"
  115.       ChangeMsgSection(2)
  116.       Readnew
  117.       REXX "XSCRIPTS:writeaccess.rexx"
  118.       REXX "XSCRIPTS:setscan.rexx 1-Jan-94"
  119.       XenolinkDoor "DOORS:RobTools/Creditor/Process ~20 Put_Name_Here"
  120.       REXX "XSCRIPTS:2400.rexx ~10"
  121.       REXX "XSCRIPTS:savename.rexx ~14 ~100"
  122.       XenolinkDoor "Doors:thewall/thewall"
  123.       GotoMenu "Main.menu"
  124.    }
  125.  
  126. ;============================================================
  127. ;
  128.  
  129.  
  130. Replace spaces in the Sysop's name with underscores. Maximum length
  131. for the name is 30 karakters. (The comment has to fit on the same line.)
  132.  
  133.  
  134.  
  135. In order for the door to keep track of a user's last up- and downloadattempts 
  136. a utility must be placed before every up- and download command in your bbs.
  137.  
  138. Example :
  139.  
  140. ;==============================
  141. ; Filemenu.src
  142.  
  143.  
  144. CMD = "D"
  145.    {
  146.       XenolinkDoor "^3^15000^Doors:RobTools/SaveUpDownload ~20 ~40 ~46 ~50 DOWN"
  147.       Download
  148.    }
  149.  
  150. CMD = "U"
  151.    {
  152.      XenolinkDoor "^3^15000^Doors:RobTools/SaveUpDownload ~20 ~40 ~46 ~50 UP"
  153.      Upload
  154.    }
  155.  
  156. ;==============================
  157.  
  158.  
  159. Use the ^3^15000^ only if you have multiple nodes. (raise the three for more 
  160. than 3 nodes...)
  161.  
  162.  
  163. Operation :
  164.  
  165. Pretty straight forward, just try it out.
  166.  
  167.  
  168. Notes : 
  169.  
  170. The options 1 and 2 in the main menu of the door (AddBytes and RemoveBytes)
  171. will compensate for the Bytes Xenolink gives. So giving 1x credits will 
  172. actually add nothing to the user's record since Xenolink has already 
  173. given 1x credits for the file. 
  174.  
  175. Option 3 will NOT compensate. Use this option to give or take something 
  176. extra from the users bytes. 
  177.  
  178.  
  179. When you give a negative amount of bytes for a
  180. file the door adds a bytepenalty to the users record.
  181. Editing the following userdata (with the creditors internal usereditor only!)
  182. will also change the creditrecord :
  183.  
  184.    Privilege      
  185.    ByteRatio      
  186.    FileRatio      
  187.    Uploads        
  188.    UpLoadBytes    
  189.    MaxBytesPerDay 
  190.  
  191. :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  192.  
  193. Thanks to : Lennart Schram, Jeroen Meydam and Robert Dekker for testing....
  194.  
  195.  
  196. This door has been converted from Arexx to C, it is most likely that there are
  197. several bugs left to iron out. Please inform me about any problems, suggestions
  198. or bugreports.
  199.  
  200.  
  201. Send mail to :
  202.  
  203. Rob Veenman
  204.  
  205. internet robvtnz@xs4all.nl
  206. fidonet  2:280/208.3
  207. BBS      +31-29971964
  208.  
  209.  
  210. Have fun....
  211.  
  212. To Do :
  213.  
  214.  
  215. - Leave a message in the Xenolink message base.
  216. - Move files.
  217. - Edit 'good' uploaders.
  218. - ? 
  219.  
  220.