SRL Archive - General

Many members, I feel, are bamboozled with funcs/procs in MSI.
I wouldn't blame them, the whole system is intricate and looks intimidating.
MSI needs tutorials to show how each function will work, I discussed this with RM. This is what I have in mind. Debate and post feedback, please.

MSI's Core Functions [TUT]:
MSI's Skill Functions [TUT]:
A breakdown on MSI records and types [TUT]:

Blue = in the process of doing.
Red = To be done.

I feel, we should split this up into headings of every file and subheadings of each function and explain it. In detail.

For Example (not in the EXACT format ofc..):

MSI's Core Functions [TUT]:


AntiBan.Scar

Procedure MSI_AntiBan(HowLong, ChancePerc: Integer);

*This function will…*
*How to use it in scripts…*

Procedure MSI_FindRandoms;

*This function will…*
*How to use it in scripts…*



Banking.Scar

…and so on…

—————————————————————————

We have to make this all 'Noob Proof'! Everyone will be looking and learning from this, we have to make everything clear. Clarity of expression, I feel, must be a definite element.

We must discuss the prospect of adding more tutorials. I feel, we as a group, must think about who will write what. This has to be a team effort :spot:, one person cannot take the brunt of all the writing.
Hopefully, owing to this; MSI will become more understandable for everyone :norris:.

Lookin' good :)

~RM

Why not just document in the code itself?

If you place comments internally, those who try to follow the code can have some nice descriptions of what its doing. Makes the tutorials rather obsolete.

Albeit, it probably is a good idea to write up some information about interpreting the documentation etc.

Once again, I apologize for posting where I really have no part in, just giving some input.

From: Nava2
Why not just document in the code itself?

If you place comments internally, those who try to follow the code can have some nice descriptions of what its doing. Makes the tutorials rather obsolete.

Albeit, it probably is a good idea to write up some information about interpreting the documentation etc.

Once again, I apologize for posting where I really have no part in, just giving some input.

No need for apologies :)

I think the code is readable enough, but believe the tuts wil be useful for two reasons:
- The reasoning behind the code is not always obvious
- Not everyone will bother to read through the code

~RM

From: Rasta Magician
No need for apologies :)

I think the code is readable enough, but believe the tuts wil be useful for two reasons:
- The reasoning behind the code is not always obvious
- Not everyone will bother to read through the code

~RM

Agreed!

(thought it was better to write that then the typical spam of +1)

From: Nava2
(thought it was better to write that then the typical spam of +1)

^Lol :p

Naum, I agree 100%. We need to do everything we can to get members involved. :)

It's been released for what? A week? So not very long. But even after a week, I thought we'd at least have a couple people testing. :(

From: Coh3n

It's been released for what? A week? So not very long. But even after a week, I thought we'd at least have a couple people testing. :(

I believe people are testing if you watch it on Stats. Not much going on in the Proggy's thread though.

Perhaps we could add a text document to an svn so we can all write our parts and make it nice and complete for everyone.

Or a wiki maybe?

Or is it preferred that we all just pick parts and give a brief explanation/lesson on them?

From: NCDS
I believe people are testing if you watch it on Stats. Not much going on in the Proggy's thread though.

If you look at the stats, I'm the only one who's tested it. The total time for the script is the same as my total time.

Also, that text svn isn't such a bad idea. Even a Wiki isn't a bad idea. I'd go either way. :)

You can just write the tuts on the SVN forum… hummm.

the SRL Wiki doesn't get much use. That's why I'd reconsider such an idea.

~RM

From: Coh3n
If you look at the stats, I'm the only one who's tested it. The total time for the script is the same as my total time.

Also, that text svn isn't such a bad idea. Even a Wiki isn't a bad idea. I'd go either way. :)

I apologize for my lack of testing, I just need to get this damn yew cutter out of the way. It has been at the same point for months :p

Work has also picked back up..

From: RM
You can just write the tuts on the SVN forum… hummm.

True. I believe we all have mod powers there correct?

From: Rasta Magician
You can just write the tuts on the SVN forum… hummm.

the SRL Wiki doesn't get much use. That's why I'd reconsider such an idea.

~RM

I'd rather see one big tut, then a bunch of little ones to be honest.

I think that's what Naum meant anyway. A guide for the core, and a guide for the Skills.

From: NCDS
I apologize for my lack of testing, I just need to get this damn yew cutter out of the way. It has been at the same point for months :p

Work has also picked back up..

Don't worry. We should have added that cutter to MSI. :p Not to take away any of your personal accomplishments or anything, but I'm going to assume that we'll have that exact script eventually and I'm sure we'll take the walking from it at that point. :p

From: Coh3n
I'd rather see one big tut, then a bunch of little ones to be honest.

I think that's what Naum meant anyway. A guide for the core, and a guide for the Skills.

Using the MSI SVN forums sounds good. You should be able to edit each other's posts ;)

Or when you are done with the tut in can be moved to the MSI general Section, I jsut think it should be kept within the forums :)

~RM

From: Coh3n
I'd rather see one big tut, then a bunch of little ones to be honest.

I think that's what Naum meant anyway. A guide for the core, and a guide for the Skills.

I agree with that.

From: Coh3n

Don't worry. We should have added that cutter to MSI. :p Not to take away any of your personal accomplishments or anything, but I'm going to assume that we'll have that exact script eventually and I'm sure we'll take the walking from it at that point. :p

To be honest, Naum is working on a YewChopper too right now for edgeville, which is also where mine is. I honestly wouldn't mind merging the two as an MSI add on.

I would imagine people would be more inclined to chop yews rather than Normal trees :redface:

And yes, I got the walking down ;)

It would mean jumping out of our original plan a little though.

From: Rasta Magician
Using the MSI SVN forums sounds good. You should be able to edit each other's posts ;)

Or when you are done with the tut in can be moved to the MSI general Section, I jsut think it should be kept within the forums :)

~RM

I'd rather it get done in the SL forums, then moved later.

From: NCDS
I agree with that.

To be honest, Naum is working on a YewChopper too right now for edgeville, which is also where mine is. I honestly wouldn't mind merging the two as an MSI add on.

I would imagine people would be more inclined to chop yews rather than Normal trees :redface:

It would mean jumping out of our original plan a little though.

Yes, I know. But we have to think about what people are going to use, and what's going to get them involved. Athough coverall all of Varrock was a good plan, I don't think it's the best one to get MSI rolling. I mean, there are a ton of things to do in Varrock that I guarantee will never be used. I would rather add the scripts that are actually going to be used.

From: Coh3n
I'd rather it get done in the SL forums, then moved later.

Again, I agree.

From: Coh3n

Yes, I know. But we have to think about what people are going to use, and what's going to get them involved. Athough coverall all of Varrock was a good plan, I don't think it's the best one to get MSI rolling. I mean, there are a ton of things to do in Varrock that I guarantee will never be used. I would rather add the scripts that are actually going to be used.

So is this something we should open for discussion?

From: NCDS
So is this something we should open for discussion?

I would say yes. Even RM suggested the Al Kaharid tanner. But we can't have too many projects going on at once. Isn't that how previous MSI projects failed?

From: Coh3n
I would say yes. Even RM suggested the Al Kaharid tanner. But we can't have too many projects going on at once. Isn't that how previous MSI projects failed?

Honestly, between mine and Naum's already functioning scripts(multiple hour long reports from both), I don't see it taking more than a few hours to put that into MSI.

I obviously have to talk to him about all this first as well.

From: NCDS
Honestly, between mine and Naum's already functioning scripts(multiple hour long reports from both), I don't see it taking more than a few hours to put that into MSI.

I obviously have to talk to him about all this first as well.

That's exactly what I was thinking. I would understand if you guys decided not to add them as I'm sure you've put hours of work into it, but it would be a very nice addition to MSI. :)

From: Coh3n
I would say yes. Even RM suggested the Al Kaharid tanner. But we can't have too many projects going on at once. Isn't that how previous MSI projects failed?

Indeed it is.

We already started discussing the miner, although it is up to you wether to scrap it or not. Iron mining is somewhat popular, and MK's script used to get a lot of use. Both tanner and yew cutter sound good.

I've also already told Naum that when I have the time I am willing to pluck my Guild Miner into MSI.

~RM

From: Rasta Magician

I've also already told Naum that when I have the time I am willing to pluck my Guild Miner into MSI.
~RM

That, plus a yew cutter, plus a tanner, plus a VEM?!? plus the original normal tree cutter?? MSI would be killin it :p

Me and Blumblebee actually made an AK Tanner a while back that might have some useful things in it.

From: Rasta Magician
Indeed it is.

We already started discussing the miner, although it is up to you wether to scrap it or not. Iron mining is somewhat popular, and MK's script used to get a lot of use. Both tanner and yew cutter sound good.

I've also already told Naum that when I have the time I am willing to pluck my Guild Miner into MSI.

~RM

Awesome! There's also 2 Oak trees just outside Varrock that I think we should add. We'd only have to add a couple paths. I can do that later if I get spare time. I'm just thowing that out there though.

From: NCDS
That, plus a yew cutter, plus a tanner, plus a VEM?!? plus the original normal tree cutter?? MSI would be killin it :p

Me and Blumblebee actually made an AK Tanner a while back that might have some useful things in it.

:D

Stick to Varrok for now, bros..

From: NCDS
That, plus a yew cutter, plus a tanner, plus a VEM?!? plus the original normal tree cutter?? MSI would be killin it :p

Me and Blumblebee actually made an AK Tanner a while back that might have some useful things in it.

there was nothing useful in what I wrote haha, my walking wasn't too nice. Although I suppose it's a good start. Your functions worked nicely :)

From: Nava2
Stick to Varrok for now, bros..

Arguments being?

Moduled the way it is, the core can pretty much accept any location and skill..

~RM

From: Rasta Magician
Moduled the way it is, the core can pretty much accept any location and skill..

~RM

Not pretty much… it CAN! :D

On topic, what are people thinking? Start the tutorial in the SL forums, and discuss/edit as we add to it? Or do the latter, except in the public forum? Do we want one guide for the whole core, and one guide for the Skills folder? Do we want a brief guide on the many features of MSI?

From: Blumblebee
Your functions worked nicely :)

Thanks :) Though, that seems like so long ago now

From: Coh3n
Not pretty much… it CAN! :D

On topic, what are people thinking? Start the tutorial in the SL forums, and discuss/edit as we add to it? Or do the latter, except in the public forum? Do we want one guide for the whole core, and one guide for the Skills folder? Do we want a brief guide on the many features of MSI?

I think we should start it in SL's, then move to public once we get it started.

I also feel that the core and skills should be explained in different sections obviously, but maybe not different threads? Have a post for the core, then one for all the skill functions, but still the same thread?

A brief guide explaining MSI and what it currently/will/could include(s) is not a bad idea either.

From: NCDS

I think we should start it in SL's, then move to public once we get it started.

I also feel that the core and skills should be explained in different sections obviously, but maybe not different threads? Have a post for the core, then one for all the skill functions, but still the same thread?

A brief guide explaining MSI and what it currently/will/could include(s) is not a bad idea either.

Separate posts is good. I see nothing wrong with that. I think maybe the features list can be added to MSI Phoenix - Grand Opening as it already explains what it is and everything. May as well list all the features.

From: Coh3n
I think maybe the features list can be added to MSI Phoenix - Grand Opening as it already explains what it is and everything. May as well list all the features.

Sounds good to me. You have mod there, right? ;)

From: NCDS
Sounds good to me. You have mod there, right? ;)

Sure do. :) I'll actually do that right now.

From: Coh3n
Sure do. :) I'll actually do that right now.

Also post the changes, as an edit won't show as a 'new post'

~RM

From: Rasta Magician
Also post the changes, as an edit won't show as a 'new post'

~RM

Done.

This is what I've got done so far. Give it a read over, please. (I did this after school)

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

MSI Logs/

This folder will contain a .txt file or .txt files, which contain the debug text of the script at a certain time. This will have been written by the function in Debug.Scar called MSI_SaveLog;.
-Please Note: If you have not run the script yet or have just checked out, then this folder will have no logs.


MSI Progress Reports/

This folder will contain .txt file of progress reports when using the script. It will save them under the file containing the date it was saved; this in turn will contain the times each progress report was written at. This will be written to the folder by the function: MSI_PrintSave(FileH, S : String);
-Please Note: If you have not run the script yet or have just checked out, then this folder will have no Progress Reports.


Skills/

This folder contains all the .scar/.simb files related to different skills in RuneScape. These .scar/.simba files then contain functions and procedures related to that skill. For example MSI_WaitWhileChoppingEx; in Woodcutting.scar.
Visit this tutorial for a more in depth guide of all Skills/ functions/procedures : LINK HERE


Antiban.scar

Procedure MSI_AntiBan(HowLong, ChancePerc: Integer);

{******************************************************************************}
{ Procedure MSI_AntiBan(HowLong, ChancePerc: Integer);                         }
{ By: Naum, edited by Coh3n, RM & Zyt3x                                        }
{ Description: The AntiBan procedure to be used throughout the scripts.        }
{******************************************************************************}

This procedure will call the antiban feature. This includes: moving the mouse randomly in an arc-type style, examining inventory items using the 'examine' options, randomly changing to GameTabs and waiting before changing back, randomly right clicking for a few seconds, moving the compass to a random angle then moving it back and doing nothing.
This procedure uses two parameters; HowLong and ChancePerc which only accept whole numbers because they are integer data types. 'HowLong' dictates how long the antiban should last, in milliseconds e.g. 2000. Low times in the range of 0 to 5000 are recommended for use whilst walking, any thing more for other things.
The second parameter 'ChancePerc' is the chance out of 100 for antiban to be performed. Something adequate like 50 percent should be used for mediocre antiban usage, anything above or below that depending on what you want to do. The constant used for 'ChangePerc' is in Globals.scar and is called: ANTI_BAN_CHANCE. This is pre-defined to 10, thus meaning 10 times out of 100 it will perform antiban when used in MSI or any other script.
Usage:

MSI_AntiBan(5800, 50);

This performs antiban for 5.8 seconds if the probability of 50% chance is met (ChancePerc).

Procedure MSI_AntiBan(HowLong, ChancePerc: Integer);

{******************************************************************************}
{ procedure MSI_FindRandoms;                                                   }
{ By: Coh3n                                                                    }
{ Description: Checks for random events                                        }
{******************************************************************************}

This procedure will call the FindNormalRandoms; in SRL. This procedure will try to solve any random MSI encounters. This will also add to the stats profile if the random was solved (or not) and which random it was.


Banking.scar

CompileMSI.scar

Debug.scar

Globals.scar

ItemInfo.scar

Mainloop.scar

Objects.scar

RunMe.scar

Setup.scar

Skills.scar

Stats.scar

THINGS_TO_REMEMBER_WHEN_WRITING_CODE.txt

Walking_Color.scar

Walking_Reflection.scar

I'll read it over soon, when I get more time. You should make a new thread so we all can edit it and then just move the thread to public later.

From: Coh3n
I'll read it over soon, when I get more time. You should make a new thread so we all can edit it and then just move the thread to public later.

Me and Blumblebee only have mod where everyone can see anyways, so it really doesn't make much of a difference. I guess we will just post what we wright, and have one of you add it?

Feel free to make a thread in SL, seeing as we're all now mods :).

GJ RM!