The documentation to MAX's Byte Ratio System v2.0 (MBRS) Index: ~~~~~~ Conditions of use ..... 1.0 Introduction .......... 1.1 Installation .......... 1.2 Upgrade from v1.0 ..... 1.3 Upgrade from v2.0 De .. 1.4 Configuration ......... 1.5 Local-uploads ......... 1.6 For programmers only .. 1.7 Demo limitations ...... 1.8 How to register ....... 1.9 Greetings! ............ 2.0 *** 1.0 - Conditions of use *** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The MAX's Byte Ratio System (MBRS) is copyright (c) Mikael Kinnunen 1996. You may spread and distribute the DEMOVERSION, in the condition that you do NOT take any charges for it (except the price of a disk). Nor are you allowed to re-distribute the archive with any changes/additions. A registered version must NOT be spread or distributed. You must NOT change/manipulate any executable files in the archive, even for use on your own BBS. Else it'll be considered a breach of copyright, and actions will be taken - please remember this. Disclaimer ~~~~~~~~~~ The author takes no responsibility for any problems which may occur by using the product. There's no reason to believe there will be, if the product is used as the documentation describes. *** 1.1 - Introduction *** ~~~~~~~~~~~~~~~~~~~~~~~~~~ The development in MBRS started sometime in 1994, and has now (-96) come to its second version, that includes lots of features. Here are SOME good ones.. * FILE_ID.DIZ support for LHA, LZH, LZX, DMS, ZIP archives, and all kinds of textfiles. * Optional byteratio for each user. * Optional creditfactors for seperate fileareas, and specific files, i.e you are able to set exactly the percentage that will be drawn for downloads. * Free download on all files in a fast way - great for anniversaries. * You may change descriptions, move, delete, nuke files. * You may edit users byteratios, set UNLIMITED ratio and allowed downloads. * Users may raise their own accesses, byteratios when they have uploaded enough (compared to what's configured). * Works fine with multinode-systems. * Easy for you programmers to write extra doors/utilities for it. *** 1.2 - Installation *** ~~~~~~~~~~~~~~~~~~~~~~~~~~ If you already have MBRS v1.0 installed, go to "Upgrade from v1.0" instead. 1) Copy the MBRS directory to Doors: 2) Assign MBRS: Doors:MBRS from CLI, and also put the line in user-startup, or startup-sequence. 3) Move all files from the directory MBRS:ARCHIVERS to Sys:C 4) Make sure that the lines 181, 182, 187, 188, 189, 190 (in MAX's Text- editor) look like this: ^[[30m 5) Load MBRS:CONFIG/FileDevices.cfg into an ASCII-editor, and put in all of your own filepaths. Make sure "Files File Path" is put in the top. 6) Also edit MBRS:CONFIG/DefaultRatio.cfg and MBRS:CONFIG/DefaultByteAcc.cfg as you desire. The values in the files will be used as default, where DefaultRatio.cfg contains the byteratio, and DefaultByteAcc.cfg the amount of bytes that new users will get for free. 7) Now edit MBRS:CONFIG/FileArea.cfg as follow: Each filearea is divided in 6 lines, and then comes an empty-line. Line 1: The string users will enter to jump to the area. 2: The section-number for the area. 3: The menu-number to jump to. 4: Minimum-access users got to have, in order to reach the area. If a negative value is given, the users will be able to list and upload, but not download from it. For example: -5000 means that users with less than access 5000 won't be able to download, but upload and list etc. 5: The factor of how much credits that will be drawn for files downloaded from the area. In other words - the percentage divided by 100. A factor of 1 will result in normal credit-taking (100%). One of 0.3 will be 30%, one of 0 will mean free download etc. 6: The areaname. It'll be used by the filelisters. Make sure all of your fileareas are in here. 8) If you want seperate files, with different "credit-factors" set for them, edit MBRS:CONFIG/SpecialFiles.cfg to suit your needs. Works the same way as in line 5 of each filearea. Enter the filename (without path), and on next line you enter the factor, then an empty line before next etc.. 9) Run MBRS:DLCheck (from CLI) This will log all downloads, and take some time (approx. 10 mins per 2000 downloads). NOTE: If you want to start from scratch, and ignore all the old downloads - simply delete BBS:LogFiles/DnLoadLog.text and just don't run MBRS:DLCheck as said above. If you receive an error-message, something like: Couldn't handle user.. then you have some user(s) with "strange" names, that can't be handled. This problem occurs with PC-users, so you've got to remove or change all usernames that have any of these (3 last swedish) letters BOTH in the user editor of MAX's and in the BBS:LogFiles/DnLoadLog.text. 10) Run MBRS:ULStarter (from CLI) This will log all uploads. Takes approx. 1 minute per 200 users. 11) Run MBRS:DescStarter (from CLI) This will deflate the FILE_ID.DIZ from all your files online. It'll take some time too, but don't hesitate! ;) 12) Now you're going to put up some doors in your menus. All doors are to be used with menufunction #34 as usual. AutoRaiser - Raises users accesses automatically. Edit MBRS:CONFIG/AutoRaiser.cfg if you want. In its config, there are some text lines in the top - then follow different levels. Line 1: Amount of bytes to reach the level Line 2: Access that will be given Line 3: Ratio that will be given NOTE: Keep the last level! Put it wherever you want. I've got mine in the main. ( This door isn't needed to get the rest to run. So if you don't want it - simply don't use it. ) FileEditor - Edit descriptions, move/delete/nuke files. ---> Make sure you always use this door instead of MAX's ---> own fileeditor when you move/delete. Sysops (axx 5000+) may kill (nuke) all files. Users may kill only the files uploaded by themselves. Sysops may also "delete" files, so the uploaders keep their credits but the files get deleted. Put it in each filearea. UserEditor - Edit users byteratios/accounts etc. Put it wherever you want. UnMarkAll - Will un-mark all marked files by a specific user. Put it in each filearea. UserStati* - Will show some information for the user. Put it in either intro- or maindoor.text. ULoad - The upload door. Edit MBRS:CONFIG/ULoad.cfg as follow: Line 1: Path to a textfile that will be shown before upload. For example, an upload-rules text. Make this line empty if you don't want this. Line 2: Path to another textfile that will be shown before upload. For example, a toplist. Make this line empty if you don't want this. Line 3: Command line, that will be executed after upload. Make this line empty if you don't want this. Put it in each filearea, and give it an argument for a path where the files will be uploaded to; MBRS:ULoad The path MUST be terminated with either : or / DLoad - The download door. Edit MBRS:CONFIG/DLoad.cfg like in ULoad.cfg, except that this has only 2 lines, where the first is a textfile-path and the second, the command line. Put it in each filearea. FileArea - Goes to a specific filearea. Change MBRS:CONFIG/FilesMenu.text as you want in an ansi- editor. Put this in your main-menu and each filearea. If you give an argument to it, which contain the string a user will have to enter to get there - it will jump to it automatically; MBRS:FileArea [] If no argument is given, users will be prompted. FileLister FORW - Lists old->new files. FileLister RVRS - Lists new->old files. FileLister CSRC - Searches for files in current area. FileLister GSRC - Searches for files globally. FileLister CNEW - Lists new files in current area. FileLister GNEW - Lists new files globally. Takes an argument. If you want to run it automatically on login - copy this file to Doors: and write in intro- or maindoor.text: FileListerGNEW ? And users will be asked whether they want to list new files or not. Put all FileLister-doors in each filearea. 13) Make the CLI-programme Update run automatically after logoff, by enter MBRS:Update in "Execute on logoff:" (in System configure), or if you have a script, simply add it there. 14) Since the door FileArea shows a textfile when run, which is named MBRS:Config/FilesMenu.text - you should edit this one, or copy your old filesmenu to that file. -- FINISHED! -- *** 1.3 - Upgrade v1.0 -> v2.0 *** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ( Do the following steps only if you already have the v1.0 installed ) 1) Copy the MBRS directory to Doors: 2) Assign MBRS: Doors:MBRS from CLI, and also put the line in user-startup or startup-sequence. 3) Move all files from the directory MBRS:ARCHIVERS to Sys:C 4) Make sure that the lines 181, 182, 187, 188, 189, 190 (in MAX's Text- Editor) look like this: ^[[30m 5) Replace MBRS:CONFIG/FileDevices.cfg with your old one, and make sure the "Files File Path" is placed in the top. Replace MBRS:CONFIG/DefaultRatio.cfg with your old one. 6) Edit MBRS:CONFIG/DefaultByteAcc.cfg as you desire. It contains the value of available downloads in bytes, new users will get for free. 7) Now edit MBRS:CONFIG/FileArea.cfg as follow: Each filearea is divided in 6 lines, and then comes an empty-line. Line 1: The string users will enter to jump to the area. 2: The section-number for the area. 3: The menu-number to jump to. 4: Minimum-access users got to have, in order to reach the area. If a negative value is given, the users will be able to list and upload, but not download from it. For example: -5000 means that users with less than access 5000 won't be able to download, but upload and list etc. 5: The factor of how much credits that will be drawn for files downloaded from the area. In other words - the percentage divided by 100. A factor of 1 will result in normal credit-taking (100%). A factor of 0.3 will have the effect of only 30% etc. 6: The areaname. It'll be used by the filelisters. As you can see, line 5 and 6 are new for MBRS v2.0. Make sure all of your fileareas are in here. 8) If you want seperate files, with different "credit-factors" set for them, edit MBRS:CONFIG/SpecialFiles.cfg to suit your needs. Works the same way as in line 5 of each filearea. Enter the filename (without path), and on next line you enter the factor, then an empty line before next etc.. 9) Run MBRS:DescStarter (from CLI) This will deflate the FILE_ID.DIZ from all your files online. It'll take some time, but don't hesitate =) 10) Now put up these doors in your menus. All doors are to be used with menufunction #34 as usual. AutoRaiser - Raises users accesses automatically. Edit MBRS:CONFIG/AutoRaiser.cfg if you want. In its config, there are some text lines in the top - then follow different levels. Line 1: Amount of bytes to reach the level Line 2: Access that will be given Line 3: Ratio that will be given NOTE: Keep the last level! Put it wherever you want. I've got mine in the main. ( This door isn't needed to get the rest to run. So if you don't want it - simply don't use it. ) FileEditor - Edit descriptions, move/delete/nuke files. ----> Make sure you always use this door instead of MAX's ----> own fileeditor when you move/delete. Sysops (axx 5000+) may kill (nuke) all files. Users may kill only the files uploaded by themselves. Sysops may also "delete" files, so the uploaders keep their credits but the files get deleted. Put it in each filearea. UserEditor - Edit users byteratios/accounts etc. Put it wherever you want. UnMarkAll - Will un-mark all marked files by a specific user. Put it in each filearea. UserStati* - Will show some information for the user. Put it in either intro- or maindoor.text. ULoad - The upload door. Edit MBRS:CONFIG/ULoad.cfg as follow: Line 1: Path to a textfile that will be shown before upload. For example, an upload-rules text. Make this line empty if you don't want this. Line 2: Path to another textfile that will be shown before upload. For example, a toplist. Make this line empty if you don't want this. Line 3: Command line, that will be executed after upload. Make this line empty if you don't want this. Put it in each filearea, and give it an argument for a path where the files will be uploaded to; MBRS:ULoad The path MUST be terminated with either : or / DLoad - The download door. Edit MBRS:CONFIG/DLoad.cfg like in ULoad.cfg, except that this has only 2 lines, where the first is a textfile-path and the second, the command line. Put it in each filearea. FileArea - Goes to a specific filearea. Replace MBRS:CONFIG/FilesMenu.text with your old one in BBS:Menus/ Put this in your main-menu and each filearea. If you give an argument to it, which contain the string a user will have to enter to get there - it will jump to it automatically; MBRS:FileArea [] If no argument is given, users will be prompted. FileLister FORW - Lists old->new files. FileLister RVRS - Lists new->old files. FileLister CSRC - Searches for files in current area. FileLister GSRC - Searches for files globally. FileLister CNEW - Lists new files in current area. FileLister GNEW - Lists new files globally. Takes an argument. If you want to run it automatically on login - copy this file to Doors: and write in intro- or maindoor.text: FileListerGNEW ? And users will be asked whether they want to list new files or not. Put all FileLister-doors in each filearea. 11) Make the CLI-programme Update run automatically after logoff, by enter MBRS:Update in "Execute on logoff:" (in System configure), or if you have a script, simply add it there. 12) Since the door FileArea shows a textfile when run, which is named MBRS:Config/FilesMenu.text - you should edit this one, or copy your old filesmenu to that file. - Make sure that ALL new doors are used everywhere instead of the old ones in v1.0! -- FINISHED! -- *** 1.4 - Upgrade from v2.0 demo -> registered v2.0 *** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If you've got the demo of v2.0 installed, simply replace all of your old doors/programmes with your new (registered) ones, and that's it! *** 1.4 - Configuration *** ~~~~~~~~~~~~~~~~~~~~~~~~~~~ Here are the configuration possibilities listed for each door/programme in alphabetically order.. AutoRaiser : In its configurationfile (AutoRaiser.cfg) you may edit all comments that users will receive, and all different levels. Each level consists of 3 lines, with an empty line before next level. Line 1: Amount of bytes the user has to upload before he reaches this level. Line 2: Access that will be given. Line 3: ByteRatio that will be given. Note: Keep the last level, with the amount 0 intact. CleanUp : This programme deletes all deleted users' userfiles, which no longer are needed. So run this for about once a month or so. DescStarter : No configuration. DLCheck : ( This programme is automatically used by DLoad and all filelister-doors ) If you want FREE DOWNLOAD on all files, simply create a file named MBRS:CONFIG/FreeDL.text That will automatically be shown when DLoad is run, so if you want to tell your users the reason why you've set free download - this is a good way. If you want seperate files, with DIFFERENT "CREDIT-FACTORS" set for them, edit MBRS:CONFIG/SpecialFiles.cfg to suit your needs. Works the same way as in line 5 of each filearea. Enter the filename (without path), and on next line the factor - then an empty line before next file etc.. If you'd like to restart the BBS:LogFiles/DnLoadLog.text, when it's far too big and causes looong time to log each new download - simply delete it, AND MBRS:DL.data. DLoad : In its configurationfile (DLoad.cfg) you may edit two lines; Line 1: Path to textfile that will be shown at start. Line 2: Command line that executes after transfer. If you don't want one of them, just leave that line blank. FileArea : In its configurationfile (FileArea.cfg) all fileareas are set-up. Each filearea is divided in 6 lines, and then comes an empty-line. Line 1: The string users will enter to jump to the area. 2: The section-number for the area. 3: The menu-number to jump to. 4: Minimum-access users got to have, in order to reach the area. If a negative value is given, the users will be able to list and upload, but not download from it. For example: -5000 means that users with less than access 5000 won't be able to download, but upload and list etc. 5: The factor of how much credits that will be drawn for files downloaded from the area. In other words, the percentage divided by 100. A factor of 1 will result in normal credit-taking (100%). One of 0.3 will be 30%, 0 will be free dl.. 6: The areaname. It'll be used by the filelisters. If an argument is given to FileArea, consisting a string that users will have to enter in order to jump to a specific area (1:st line of each filearea in FileArea.cfg) - it'll automatically jump to that area. FileArea [] If no argument is given - FileArea will show MBRS:CONFIG/FilesMenu.text and prompt as normal. FileEditor : No configuration. FileLister* : In its configurationfile (FileLister.cfg) you may alter the ansi colourcodes to suit your needs. Each colourcode is described in the conf.file. The files; MBRS:CONFIG/DLHeader.text FileListerHelp.text Paused.text ..can be changed. FileListerGNEW: Takes, in difference to the other filelister-doors an argument; FileLister ? And will ask the user whether he wants to check for new files or not. Without '?' the -GNEW will go on but not ask. ULCheck : No configuration. ULoad : In its configurationfile (ULoad.cfg) you may edit three lines; Line 1: Path to textfile (UL-rules for ex.) Line 2: Path to textfile (toplist for ex.) Line 3: Command line that will be executed after transfer. If you don't want one of them, just leave that line blank. You may also edit MBRS:CONFIG/DescHeader.text ULStarter : No configuration. UnMarkAll : No configuration. Update : No configuration. UserEditor : No configuration. UserStatistics: No configuration. *** 1.5 - Local-uploads *** ~~~~~~~~~~~~~~~~~~~~~~~~~~~ In order to perform "local" upload(s) - follow these steps; * Add the file(s) like you use to (in the Files Editor of MAX's) but do NOT click the SAVE-button. * Instead - flip to another node, and do like users, press 'U' so that ULoad gets executed. * When the transfer-window appears, flip to the first node and click SAVE. * Done.. Now step back to the node with the transfer-window, and abort it. Now it'll deflate eventual FILE_ID.DIZ's, or you may write your own long ones, if you feel to! *** 1.6 - Programmers information *** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The files you may have use of, when writing doors/utils for MBRS are found in: MBRS:EXTRA MBRS:UL MBRS:DL MBRS:MARKEDFILES MBRS:FILE_IDS In the directories EXTRA, UL, DL and MARKEDFILES - the datafiles are named with usernames, except all spaces (' ') are made into '_' letters as you can see. In EXTRA - datafiles contain following: Line 1: Byteratio Line 2: Correction-amount. (extracorr) Line 3: Last date the user accessed the files. In UL - datafiles contain following: Line 1: Uploaded bytes Line 2: Correction-amount. (ulcorr) In DL - datafiles contain following: Line 1: Downloaded bytes Line 2: *NOT USED* Note: Use this formula to calculate the correctly amount of available downloads: alloweddls = ((ratio*(ulbytes+ulcorr))-dlbytes)+extracorr; In the directory FILE_IDS there are subdirectories in it. Each subdirectory is named with the sectionnumber, and within it the datafiles are named with same name as the file each description/datafile belongs to. *** 1.7 - Demo limitations *** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Following limitations won't be present in the fully (registered) version: * Annoying time-delays. * User will be able to download, even if his account doesn't allow it. * Only 3 lines in each filedescription will be shown in filelists. * Download disabled in filelists. *** 1.8 - How to register *** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The actual price of MBRS v2.0 is 150 SEK (swedish crowns) There are two ways to register it; * Either by sending the money (150 SEK) in an envelope (put them between 2 papers) to me, and a notice within it that contains: NAME, BBS-NAME, BBS-PHONE-NUMBER, what COUNTRY you live in and that you want to register MBRS v2.0. Also a short PASSWORD that I can use to set up a user-account for you here. to the address: Mikael Kinnunen Myrmalmsringen 88 136 65 Haninge SWEDEN * Or by inserting the money (150 SEK) to my Postal-Giro account: 616 40 05-8 and you shall be able to write a small notice on it too. I want it to contain: NAME, BBS-NAME, BBS-PHONE-NUMBER, what COUNTRY you live in and that you want to register MBRS v2.0. Also a short PASSWORD that I can use to set up a user-account for you here. In this way, the Postal Giro Service will send me the notice you wrote, together with a notice that the money have reached my account. As soon as I get informed that the money is here - I'll set up a user- account for you with your NAME and PASSWORD specified on the notice, register (with your name specified on the notice), compile and attach the package on a private message to you on my BBS: EXPOSiTiON BBS .... +46-8-7773824 *** 1.9 - Greetings! *** ~~~~~~~~~~~~~~~~~~~~~~~~ Big thanks & greetings to: Christian Vigård for the great creating in extra doors and utils to MBRS and for beta-testing! Henrik Olsson also for creating extra doors! Anthony Barrett for MAXsBBS! .. and ofcourse all of you that came with those brilliant ideas and bugreports! ;) ----------------------------------------------------------------------------- Feel free to call my BBS: EXPOSiTiON, +46-8-7773824 if you've got ideas/bugreports/questions/suggestions etc. There's also a MBRS-support-section here, with extra-utils/doors etc! ----------------------------------------------------------------------------- Regards, Mikael Kinnunen