Programmer 7500

home *** CD-ROM | disk | FTP | other *** search

/ Programmer 7500 / MAX_PROGRAMMERS.iso / CLIPPER / MISC / SIMCODE.ZIP / SIMCODE.DOC < prev next >

Wrap

Text File | 1992-11-06 | 29.8 KB | 682 lines

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- SimCode Programming Language. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- [Version 6.0] Copyright (c) 1992 By Michael Whitt All Rights Reserved By Michael Whitt I, Michael Whitt hereby claim no responsibity for any damage caused by SimCode, nor do I make any claims to the portablity of SimCode on any systems other than complete 100% IBM compatibles. SimCode is released as Shareware, and I believe that you will like using and that you will want to register it. I am offering the complete documented and extra command version for only $5.00 for private use. For more details please read the end of this document for more info. //////////////////////////////////////////////////////////////////////////////// First off: Program updates may be found on the following Bulletin Boards. The Listening Post - VBBS 5.1 - 1-502-554-3082 - 300-14,400bps 24hours a day. The HUG Board - RBBS - 1-502-554-0614 - 300-9600bps 24hours a day. The PCC Board - Wildcat - 1-502-554-4201 - 300-2400bps 24hours a day. You may also call me by Voice at 1-(502)-856-3788 or you might even try leaving a message for me at 1-(502)-658-3647 -<thats my beta testers number>-. Or if you dont want to call write me at: Michael Whitt Route 1 Box 81-d Hickory, Ky. 42051 Even if you dont wish to register SimCode, I would appreciate you just calling or mailing me a postcard, Thanx a lot. \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\ ||||||||||||||||||||||||||||||||||||||||| | Introduction to Simple Code (SimCode) | ||||||||||||||||||||||||||||||||||||||||| For a very good while I was a SysOp of a fairly nice sized Bulletin Board, and I wrote tons of Doors Applications for my BBS. I knew a lot of other SysOps that did not know a ounce of Programming and they always were asking me to do small little programs for their BBS, such as Questionares and such, so I began to think about writing a little script program for them to use, with this I began my work on SimText, which would come to be known as SimCode. The Original SimCode, or SimText as it was known would only center text and it would change text colors, nothing real major huh? Well luckly it evolved, and contains over 100 commands. SimCode now contains sound,color,file,and variable commands. ================================================================================ SimCode is no longer case sensitive like version .5 to 1.8, the case sensitivty was updated in version 2. For those of you that already use a SimCode Version from 2 to 4, you may be interested in reading the next section only. ================================================================================ <><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><> Major Updates from previous Versions. If you where using Versions 2 through 4, you may wish to read just this section of the document and note the major changes in SimCode with Version 6.0. Besides the addition of about ten more commands, and a new Con mode, undoubtably the most important change was a complete rewrite in the # and ^ commands. With previous versions the # and ^ command where used to Write a line of text to the screen, as long as that line of text did not include more than 255 characters the # command would not only write the line to the screen but would also space down a line. The complete rewrite was done so that reqular text and ascii characters could be added to the entire screen. To do this the # and ^ commands are no longer limited to 255 characters, and they are only limited by your memory. Also a major change in these commands are that the # command is now exactly like the ^ command. If you wish to space down a line you must now just type a @ sign when ever you wish to space down a line. Example: (with Version 2-4) ~Red~ #I am a SimCode Program# #Aint I nice?# would display I am a SimCode Program Aint I nice? Example (with Version 6.0) ~Red~ #I am a SimCode Program# @ #Aint I nice?# would display I am a SimCode Program Aint I nice? where-as the exact copy of the example from Version 2-4 would produce the following to the screen in Version 6.0: I am a SimCode ProgramAint I nice? Now I think that you can see the diffrence. The major reason for this changes was for the introduction of the Txt2Scs Utility so that ANY text or ascii file can be used in Scripting. ---------- Also a major update from Version 6.0 is the introduction of the File and Printer commands ~OPEN ~, ~APPEND ~, and ~PRINT ~. The Open command must be used before any Append command. The Open command assigns a filename to write to, if the file already exist it just appends or adds on to it, else it creates the file. Example Use for Open given the file Names.Txt: ~Open Names.Txt~ The Append command is the actually file writing command in SimCode, all info that it stores to a file is in ASCII Text, and can be read a numerous amount of ways, including coverting it into a SCS file with Txt2Scs. You MUST declare a file to open and append to using the Open command before the Append Command will work. Example Use for Append: Example 1: Writing a string to the file: ~Append <Hello World.>~ Example 2: Writing a variable-letter to the file: ~Append A~ The Print Command is a added utility that will send either text or variables to the printer. Example 1: Writing a string to the file: ~Print <Bye Bye.>~ Example 2: Writing a Variable-letter to the file: ~Print A~ --------- Another Addition Change is in the Run command, you can now specify Paremeters to be passed to a Runned Program. Example 1: ~RUN PKZIP.EXE : MyZip~ Example 2: ~RUN WIN.COM : /3~ Anything after the : comamnd is considered a Parameter. a null parameter pass would be: ~Run Pkzip.exe : ~ --------- A new Script Calling System has been added also the Call command will call other Script files: Example 1: ~CALL MyScript.Scs 1~ The above will call MyScript.Scs and initize the starting color to blue~ Example 2: ~Call script.SCS ~ This would call Script and nullify the color to the original Red setting. ---------- The Con mode was also added into SimCode, see below for more details. --------------------------End of Update---------------------------------------- <><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><> Okay lets get started on your tour of SimCode... ******************************************************************************** First lets list the Shareware SimCode Commands and their Functions: These are not in any perticular order. ~Run filename : parameters~ =- This Command will Run external programs. Example: ~Run Agame.Exe : CGA MOUSE~ The Above would load the program Agame.exe and pass CGA and Mouse to it as Parameters. This is useful for linking SimCode and other EXE, COM, BAT, and script files together. ~Call Script colornumber~ =- To call other SimCode Command Scripts, you would Type ~CALL MyScript.SCS colornumber~ After the linked Script is finished, the linked SimCode will fall back to the Parent SimCode. Note: A total of 25 Calls has can Be used with 512k or ram. *Note, if you wish to load multiple Scripts you may wish to use the following parameters: ~Call Myscript colornumber~ the parameter colornumber connvert the number it to a ASCIIcolor. This is helpful when you are running Text Files that are Converted into SCS withthe TXT2SCS program. You dont have to pass a Colornumber parameter, but I would advise it. Example: ~Call MySCS.SCS 3~ would load MySCS with the default color of 3. ~Get letter-variable~ =- This Command will store a string to memory. Example: ~Get A~ will store any user input up to 80 characters long into a Varible known as A. You have up to 26 variables to use in the Shareware Version of SimCode. They are A through Z. See ~Use letter-variable~ ~Use letter-variable~ =- This Command will retrieve a string from memory. Example: ~Use A~ will retrieve any user input that was stored with the ~Get A~ command. Please note that all variables are Null at first. You have up to 26 variables to retrieve. A to Z. ~TIME~ =- This Command will print to the user screen the current time in the following format: The Current Time is 12:00:00. ~DATE~ =- This Command will print to the user screen the current date in the following format: The Cureent Date is 1/1/80. ~MORE~ =- Will display --Please press a key-- to the user screen and wait for the user to press a key then the program will continue. ~ENTER~ =- Will display --Please press ENTER-- to the user screen and wait for the user to press the enter key for the program to continue. ~HALT~ =- Causes Script program to stop on a dime. Please note that in the Shareware Version of SimCode the only real use for the ~Halt~ command is in the SimCode < Con mode. In the SimCode < Con mode the ~Halt~ command will exit SimCode, also the ^Z or Control-Z command also acts as the ~Halt~ command in the SimCode < Con Mode. See SimCode < Con Mode. ~DOS~ =- This command dos what it says, it will create a Dos shell. Type Exit to return to SimCode. Also ~DOS~ reminds the user to type Exit to leave the shell. ~RED~ =- Changes Text Foreground Color to Red. ~BLUE~ =- Changes Text Foreground Color to Blue. ~GREEN~ =- Changes Text Foreground Color to Green. ~WHITE~ =- Changes Text Foreground Color to White. ~BLACK~ =- Changes Text Foreground Color to Black. ~CYAN~ =- Changes Text Foreground Color to Cyan. ~YELLOW~ =- Changes Text Foreground Color to Yellow. ~CLEAR~ =- Clears all screen attributes. Equal to CLS. This command can also be used with the ~BACK ~ command and ~Bcolor ~ Commands. ~SOUNDmhz,length~ =- This Command will play the selected MegaHertz for the set length of time in milli-seconds. Example: ~Sound400,1000~ will play 400mhz for a total of 1000 milli-seconds or 1 second. ~STAR~ =- This command is a little extra command that plays a familar tune, thats all, try it out. ~YN~ =- Waits for Y/N Input, currently not used in the Shareware version of SimCode. ~ASCIInumber~ =- Displays Ascii character for the Ascii number chosen. Example: ~ASCII1~ would display the Ascii character which is a Smiley Face. Try it out to completly understand the command. ~XYxlocation,ylocation~ =- Moves the Text XY location for the current place to the specified XY location. Example: ~XY40,24~ would move the cursor from whatever the current location is to column 40 on line 24. Useful in the # # and ^ ^ commands, as well as others. ~BACK RED~ =- Changes Text Background Color to Red. ~BACK GREEN~ =- Changes Text Background Color to Green. ~BACK BLUE~ =- Changes Text Background Color to Blue. ~BACK YELLOW~ =- Changes Text Background Color to Yellow. ~BACK BLACK~ =- Changes Text Background Color to Black. ~BACK WHITE~ =- Changes Text Background Color to White. ~BACK CYAN~ =- Changes Text Background Color to Cyan. *note on ~BACK ~ commands. If you wish to initalize the entire screen background to the ~BACK ~ color then you should use the ~CLEAR~ command after it, else only the screen attributes behind the current cursor location. Try it out and see.* ~COLORnumber~ =- Changes Text Foreground Color to the selected number that fits its ASCII Color Number. Examples: ~Color0~ : Black ~Color1~ : Blue ~Color14~ : Magenta ~BCOLORnumber~ =- Changes Text Background Color to the selected number that fits its ASCII Color Number. Examples: ~Bcolor0~ : Black ~Bcolor1~ : Blue ~Bcolor14~ : Magenta *note on ~BCOLOR ~ commands. If you wish to initalize the screen background to the ~BCOLOR ~ color then you should use the ~CLEAR~ command after it, else only the screen attributes behind the current cursor location. Try it out & see. ~CENTERnum <Text to Center>~ =- Centers a string of Text on the line number that is specified. Example: ~CENTER12 <Hi>~ would center Hi on line number 12. ~CENTERnum variable-letter~ =- Centers a variable-letter on the line number that you specify. Example ~Center12 A~ would center any string that is contained in the letter-variable A. See ~GET ~ Command. ~PAUSEnumber~ =- Pauses the program for set number of Milli-secs. Example: ~Pause1000~ would pause the program for 1000 milli-seconds or 1 second. ~OPEN filename~ =- This Command will Open or Create the filename that is specified. Example ~Open c:\Test.SCS~ would Create the file C:\Test.SCS. If the file already exist then it will be Appended. ~APPEND <text>~ =- This Command will Append to the filename that is specified. Example: ~Append <Hi>~ will Append or write Hi to the filename Opened with the ~Open ~ Command. Make sure you assign or Open before appending. ~APPEND variable-letter~ =- This Command will Append to the Filename that is specified with the Open command. An Example is: ~Append A~ would Append or Write the var-letter A to the file opened. ~PRINT <text>~ =- Same as the ~APPEND ~ command but sends output to Printer instead. ~PRINT variable-letter~ =- Same as the ~APPEND ~ command but sends output to Printer instead. # # # ^ ^ ^ ^ # =- These commands will write whatever is inbetween them. # HI # would write Hi to the user screen. @ =- Goes to the next line. ................................................................................ SimCode Modes ................................................................................ SimCode currently has two modes it has a Real mode and a Con mode. The first mode that we will look at is the Con Mode. The Con Mode is the mode in which SimCode goes into if no parameters are passed to SimCode and the users types enter at the opening command of internal SimCode which is the Filname or Enter for Con Mode= prompt. There are Three ways to end the Con Mode, the Halt command, ^Z or ^C. Any of these three commands will work, but the ~HALT~ command is the preferred. In Con mode, instead of SimCode looking into a file for commands, it will wait for the end user to manually type in the commands from the keyboard one line at a time. In the Con Mode there are few commands that will not work right, see Appendix D - "CON MODE ERRORS AND PROBLEMS". The Con mode is perfect for someone that is new to SimCode to learn how to program in SimCode. Most all of the basic commands will work just as they would in the Real mode. The added advantage of the Con Mode is to check out a command to see if it will do what you want it to do. It is also helpful because you can load your editor and another copy of Simcode from within it with the ~RUN ~ and ~DOS~ commands. I suggest that you print out a copy of your SimCode.DOC and practice each command from the Doc in the Con Mode. ()()()()()()()()()()()()()()()()()()()()()()()()()()()()()()()()()()()()()()() The SimCode Real Mode. ---------------------- In real mode, SimCode looks for a filename (Script) to run. Scripts may be created with any Pure Ascii Editor, or the Copy Con command at Dos. The default Extension for a SimCode Command Script is SCS, and if you type: SIMCODE THISISIT at the command prompt in dos, SimCode will automatically add the Extension .SCS. If for some reason you do not want the SCS extension or you dont wish to have a extension at all, that is okay, just remeber that if you do not have a extension to type a . behind the filename or the Interpeter will think that it is looking for a SCS file extension by the Filename. Example: Say you have three programs as such: SIMTEST.SCS, SIMTEST.TST and the file SIMTEST. you would type the following to run each example: SIMTEST.SCS type <SIMCODE SIMTEST or SIMCODE SIMTEST.SCS> at the prompt. SIMTEST.TST type <SIMCODE SIMTEST.TST> at the prompt. SIMTEST. type <SIMCODE SIMTEST.> at the prompt. In the Real mode, a Script will end in one of a few ways: 1) End of File --- No more commands to run. 2) ~HALT~ command --- Controlled Stop. 3) RUNTIME error --- Missing Script file. Of the above, Number 1 is probley the best way to end a Script, since in the Shareware version of SimCode, there is no looping, a ~HALT~ command is only a waste of space, since there is no nesting. Also in reference to Number 3, it is not likely that you will get a RunTime error, but it is still possible under the right conditions. You may convert any Pure Ascii Text files, into Simcode Command Scripts at any time from dos by using the TXT2SCS.EXE program included with SimCode. An good example would be if you had a DOC file to distrubite with your software, but also wanted a self pausing Script to go with it you would take that filename let's say AGAME.DOC and convert it into a Script by typing TXT2SCS AGAME.DOC AGAME.SCS )))))))))))))))))))))))))))))))))))))))((((((((((((((((((((((((((((((((((((((((( ============================ =The SimCode Command Script= ============================ The SimCode Command Script or (SCS) is the core of the SimCode Programming language. SimCode reads from Commands Scripts and converts them into actions. For example one of the smallest possible SimCode Scripts would be: ┌─────────────────────────────────────────────────────────────────────────────┐ │~Red~ │ │~Back Black~ │ │~Clear~ │ │# Hello │ │ Welcome to the world of SimCode. │ │ The Easiest Programming Language │ │ ever!! │ │ #│ │~Xy29,24~ │ │~More~ │ └─────────────────────────────────────────────────────────────────────────────┘ The Above would Change the Text Foreground Color to Red, then the background would be changed to Black, and the Screen Cleared. After the Screen is cleared SimCode will Display the line Hello Welcome to the World... Just like it is in the above box, then the cursor would goto line 24 column 29 and wait for a key to be pressed. To call another Script Called MYscript.SCS you would do the following comamnd. ┌──────────────────────┐ │~CALL Myscript.SCS 10~│ └──────────────────────┘ The above would call Myscript.scs and run it then return control to the parent Script. And Example would be the following: ┌─────────────────────────────────────────────────────────────────────────────┐ │ Script1.scs │ │~Red~ Set Foreground Color to Red. │ │ ~Back Black~ Set Background Color to Black. │ │ ~Clear~ Clear the Screen. │ │ │ │#Welcome to SimCode# @@@ Write Welcome to SimCode then space down 3 lines. │ │ │ │#Calling Script2# Write Calling Script2 to screen. │ │@@@ Space down Three Lines. │ │~ENTER~ Wait for enter key to be pressed. │ │~Call Script2.SCS 11~ Load Script2.scs with color 11. │ │ │ │~Color12~ Change Foreground Color to Light Red. │ │~Clear~ Clear Screen. │ │#bye bye#@ Write bye bye to screen. │ │~xy29,24~ Goto Line 24 Column 29. │ │~Bcolor1~ Change Back Ground Color to Blue. │ │~More~ Wait for user to press a key. │ └─────────────────────────────────────────────────────────────────────────────┘ ┌─────────────────────────────────────────────────────────────────────────────┐ │ Script2.scs │ │ │ │~Green~ Set Color to Green. │ │~Center12 <I am Script2>~ Center I am Script2 on line 12. │ │~Pause2000~ Pause for 2 seconds. │ └─────────────────────────────────────────────────────────────────────────────┘ The above describes what it is doing inside the Script. Anything out side of the ~ # ^ or @ commands is comments. An Example of the ~GET ~, ~USE ~, ~PRINT ~ and ~APPEND ~ commands: ┌─────────────────────────────────────────────────────────────────────────────┐ │#What is your Name # ~GET A~ Prompt for user name, then store to A. │ │@ │ │#What is your Age # ~GET B~ Prompt for user age, then store to B. │ │@ │ │#What is your City # ~GET Z~ Prompt for user city, then store to Z. │ │@ │ │@ │ │~GREEN~ │ │#Your name is # ~USE A~ Display your name is and return A. │ │@ │ │#Your age is # ~USE B~ Display your age is and return B. │ │@ │ │#Your City is # ~USE Z~ Display your city is and return Z. │ │@ │ │@ │ │@ │ │~OPEN DATABASE.DAT~ │ │~APPEND A~ │ │~APPEND B~ │ │~APPEND Z~ │ │~PRINT A~ ~PRINT B~ ~PRINT Z~ │ └─────────────────────────────────────────────────────────────────────────────┘ The above program is an example of the Variable, File and Printer Commands. The Program will prompt the user for his name, age, and city, store the user's input into A,B,and Z. Then will Re-Display the Users Answers, and then it will Open up DATABASE.DAT and APPEND A,B,and Z answers to DATABASE.DAT. If DATABASE file does not exist it will create it, else it will just append to the end of the file. The Last line will print the answers to the Printer. At the time of this document, using the ~PRINT ~ command without a printer online would result in a runtime error. Hopefully this problem was fixed. You may wish to look into the Last.Add file to see if there is any updates on the ~PRINT ~ command. Examples of the ~SOUND ~, ~STAR~, ~PAUSE ~, ~TIME~, ~DATE~, and ~DOS~ commands: ┌─────────────────────────────────────────────────────────────────────────────┐ │~SOUND500,1000~ Sound 500mhz for 1 second. │ │~Pause 2000~ Pause for 2 seconds. │ │~TIME~ @ Display current Time. │ │~DATE~ @ Display Currnet date. │ │~Star~ Plays theme song for a certain movie. │ │~DOS~ Shell to dos until user types EXIT. │ │~ENTER~ │ └─────────────────────────────────────────────────────────────────────────────┘ The Below is an Example of the Ascii to Screen Command. ┌─────────────────────────────────────────────────────────────────────────────┐ │~Ascii1~ Display ascii character 1 # This is a example of the Ascii Command #│ │~Ascii2~ Display ascii character 2 │ └─────────────────────────────────────────────────────────────────────────────┘ [[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]] But what can I use SimCode for? ------------------------------- Well first off as I stated earlier, you can Use SimCode BBS Doors, but a more broad use for SimCode could be either teaching, fun, or SimCode could also be used as a Installation program, or a Program introduction. For an example, I have a game called No-Nuke that is released as shareware, I used SimCode as a Introduction Document Script to No-Nuke. I also have used it for this program too. Bye running Install.Bat you was also running SimCode.SCS. The use of SimCode is up to you. ]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]]][[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[ License Agreement for SysOps. ----------------------------- Attention SysOps: If you wish to use SimCode for your Doors or as a Ad. file, you MUST send me $10.00 and you must send me a written letter explaining exactly what your Script does. If you dont send me the $10.00 I will not hire a hit man to track you down, but may God be easy on your soul. I am also asking that you add The following line somewhere into your Script or Doc file. Portions (c) Copyright 1992 Michael Whitt, SimCode Scripter. License Agreement for Programmers. ---------------------------------- Attention Programmers: If you wish to use SimCode with ANY of your Releases, you MUST, send me $15.00 and you Must send me a written letter explaining exactly what your Script does. I am not as nice to Programmers that dont register their copy as I am to SysOps. You also must include the following line in your script or Doc file: Portions (c) Copyright 1992 Michal Whitt, SimCode Scripter. License Agreement for Private Use. ---------------------------------- Hey as long as it is not public I dont care what you use SimCode for, but if SimCode is released with a script, you must register SimCode for $5.00. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- For Additional Script help, please call me at (502)856-3788. =============================================================================== Other Programs by the Author of SimCode: No-Nuke - Action game, can you save three cities before the warheads strike? EGA/VGA mouse driven game. Cryptic Thoughts - Nice little File Encoder/Decoder. Madlibs - Cool word game with a twist. AutoMess - Automatic Messager for Searchlight BBS. Slusage - Usage Chart for Searchlight BBS. ================================================================================ SimCode Version 6.0 was wrote and compiled in Turbo Pascal 6.0. Plans for 7.0 are being made in Mix's Power C. Projected Release of 7.0 is Feburary 28th '93. ================================================================================ SimCode.Arj should include the following files: SimCode.Doc - This file. SimCode.Exe - SimCode Script Compiler SimCode.SCS - Introduction Script. ExaScs1.Scs - Script ExaScs2.Scs - Script ExaScs1.Scs - Script Txt2Scs.Exe - Text to Script Conversion utility. Txt2Scs.Doc - Doc file to Txt2Scs. Script1.Scs - Script Script2.Scs - Script Sota.Gif - Gif of Author and his fiancee' SimCod2.Scs - Linked Script