Sir R. M8gic1an
2009-09-07 11:24:19
Background Information
As some of the newer members might not be aware of what MSI is or was, MSI used to run projects to make humoungous scripts, such as Varrock Owner which would pretty much do all the skills in varrock, from mining to fighting to woodcutting to smithing, etc. MSI had even an earlier stage where they attempted to develop an entire extra include. However, what we are going for is one of those humoungous scripts.
To properly organize this script we will make an include which will of course include SRL. We will, once again, attempt a city owner.
MSI Revamp
[INDENT]
Reasons for MSI failing before (I believe to be):
[INDENT]Lack of Structure
Lack of Aim
Too Greedy[/INDENT]
Structure:
[INDENT]Script Wise Structure
Leader Wise Structure[/INDENT]
Aim:
[INDENT]Aims were too big
Aims were too far fetched[/INDENT]
Greedy:
[INDENT]Too many skills
Too much creativity used in the way of combining them[/INDENT][/INDENT]
Script Wise Structure:
[INDENT]/MSI/
[INDENT]Setup.scar
Proggie.scar
Walking.scar
SkillX.scar
Mainloop.scar
RunMe.scar[/INDENT]
/MSI/Skills/
[INDENT]All functions related to a certain skill are to be put in here[/INDENT]
All those in /Skills/ will be included in Setup.scar[/INDENT]
Setup.scar
will be there for any constants and vars that need pre-setting up.
Proggie.scar
will obviously be the progress report file. It will receive all necessary vars from the /skills/ folder and SetUp.scar It will most likely use SRL's Reports.scar
Walking.scar
will use reflection, at least to start off with. All walks will be simple. Bank - >Place, Place - > Bank, no Place - > Place. A walking system with this in mind will be easy to develop.
SkillX.scar
will have the skill's mainloops.
eg. Procedure Loop_Mine(UntilLevel, Time: integer);
Mainloop.scar
will then be the place where the script figures out what to do next.
RunMe.scar
will be the actual script.
SRLPlayerForm
(at least to start with) will be used for the script, so the user does not have to figure out where the hell to go.
What skills to focus on:
[INDENT]The absolute basics. The first aim will be to get 3 skills done completly and have a running script with them. From there on then we can add more. The first skills will be gatherers, so the script can be self-sufficient.[/INDENT]
Leader Wise Structure:
[INDENT]There are two types of leaders to take into account: Scripting Leaders (SL) and Project Managers (PM).
These two groups will have to work together, pretty much as SRL Staff and SRL Devs do.
Project Managers will be those in charge of keeping everyone in the right direction, of thinking ahead, of organizing everything to make it possible.
Scripting Leaders will be those in charge of making sure the script quality is good, as well as making sure everything is going according to script structure.
Scripting Leaders will also make sure MSI Standards are met. More on MSI Standards further down.
SLs will also be the only ones with svn-write access; Everyone else will post their functions in a forum which will follow the same concept as PublicSVN.
Note: SLs will obviously also be allowed to commit their own funcs/procs.[/INDENT]
Aims:
[INDENT]1. Organize all SL and PM
2. Organize MSI Forums
3. Put Empty files in MSI SVN, just for the structure.
4. Planning how each thing will be done.
5. Get The Script done (3 skills max)
[INDENT]0. Setup.scar (structure)
1. Walking.scar (structure)
2. /Skills/
3. SkillX.scar
4. Mainloop.scar
5. RunMe.scar
Proggie.scar , Setup.scar, Walking.scar will be filled out throughout all the others, as seen fit.[/INDENT]
6. Discussion of future plans, either more skills or new script[/INDENT]
MSI Scripting Standards:
In terms of indenting and so on, these will follow the usual scar standards, as stricly as possible.
Types should be used when they fit well.
No HardCoded Values! MSI will use Constants for just about everything
There will be comments throughout the include. Lots of them!
A MSIDebug function will be made, along with a DebugMSI const. MSIDebug will be your new best friend from now on.
All procs and funcs will have headers like on SRL; But better!
This is just the original plan. It is subject to changes and additions, as SLs and PMs will see fit.
MSI has not succeded many times before. It is now my turn to give it a try. As with all of my other projects, I'll be using every resource available to pull this off. I'll guide you and let you loose, I'll direct you at first, and then let you go on, keeping an eye on things. As always, I'll be available to questions and discussions. I am giving this project every single possibility, including a lot of thinking ahead as you can see. I just won't script it; That is for you SRL Members to do, and i might throw in a function or two ;)
If you wish to apply for Scripting Leader or Project Manager now would be the time (look at next post for App Form).
As some of the newer members might not be aware of what MSI is or was, MSI used to run projects to make humoungous scripts, such as Varrock Owner which would pretty much do all the skills in varrock, from mining to fighting to woodcutting to smithing, etc. MSI had even an earlier stage where they attempted to develop an entire extra include. However, what we are going for is one of those humoungous scripts.
To properly organize this script we will make an include which will of course include SRL. We will, once again, attempt a city owner.
MSI Revamp
[INDENT]
Reasons for MSI failing before (I believe to be):
[INDENT]Lack of Structure
Lack of Aim
Too Greedy[/INDENT]
Structure:
[INDENT]Script Wise Structure
Leader Wise Structure[/INDENT]
Aim:
[INDENT]Aims were too big
Aims were too far fetched[/INDENT]
Greedy:
[INDENT]Too many skills
Too much creativity used in the way of combining them[/INDENT][/INDENT]
Script Wise Structure:
[INDENT]/MSI/
[INDENT]Setup.scar
Proggie.scar
Walking.scar
SkillX.scar
Mainloop.scar
RunMe.scar[/INDENT]
/MSI/Skills/
[INDENT]All functions related to a certain skill are to be put in here[/INDENT]
All those in /Skills/ will be included in Setup.scar[/INDENT]
Setup.scar
will be there for any constants and vars that need pre-setting up.
Proggie.scar
will obviously be the progress report file. It will receive all necessary vars from the /skills/ folder and SetUp.scar It will most likely use SRL's Reports.scar
Walking.scar
will use reflection, at least to start off with. All walks will be simple. Bank - >Place, Place - > Bank, no Place - > Place. A walking system with this in mind will be easy to develop.
SkillX.scar
will have the skill's mainloops.
eg. Procedure Loop_Mine(UntilLevel, Time: integer);
Mainloop.scar
will then be the place where the script figures out what to do next.
RunMe.scar
will be the actual script.
SRLPlayerForm
(at least to start with) will be used for the script, so the user does not have to figure out where the hell to go.
What skills to focus on:
[INDENT]The absolute basics. The first aim will be to get 3 skills done completly and have a running script with them. From there on then we can add more. The first skills will be gatherers, so the script can be self-sufficient.[/INDENT]
Leader Wise Structure:
[INDENT]There are two types of leaders to take into account: Scripting Leaders (SL) and Project Managers (PM).
These two groups will have to work together, pretty much as SRL Staff and SRL Devs do.
Project Managers will be those in charge of keeping everyone in the right direction, of thinking ahead, of organizing everything to make it possible.
Scripting Leaders will be those in charge of making sure the script quality is good, as well as making sure everything is going according to script structure.
Scripting Leaders will also make sure MSI Standards are met. More on MSI Standards further down.
SLs will also be the only ones with svn-write access; Everyone else will post their functions in a forum which will follow the same concept as PublicSVN.
Note: SLs will obviously also be allowed to commit their own funcs/procs.[/INDENT]
Aims:
[INDENT]1. Organize all SL and PM
2. Organize MSI Forums
3. Put Empty files in MSI SVN, just for the structure.
4. Planning how each thing will be done.
5. Get The Script done (3 skills max)
[INDENT]0. Setup.scar (structure)
1. Walking.scar (structure)
2. /Skills/
3. SkillX.scar
4. Mainloop.scar
5. RunMe.scar
Proggie.scar , Setup.scar, Walking.scar will be filled out throughout all the others, as seen fit.[/INDENT]
6. Discussion of future plans, either more skills or new script[/INDENT]
MSI Scripting Standards:
In terms of indenting and so on, these will follow the usual scar standards, as stricly as possible.
Types should be used when they fit well.
No HardCoded Values! MSI will use Constants for just about everything
case lowercase(string) of
'bank': …
'mine': …
//...
//Big NO!
Const
Loc_Bank = 0;
Loc_Mine = 1;
Case Location of
Loc_Bank: …
Loc_Mine: …
There will be comments throughout the include. Lots of them!
A MSIDebug function will be made, along with a DebugMSI const. MSIDebug will be your new best friend from now on.
All procs and funcs will have headers like on SRL; But better!
{*******************************************************************************
procedure FixSpells;
By: ZephyrsFury
Rev: 1
Date: 01 Sep 09
Description: Orders the spellbook by level.
*******************************************************************************}
This is just the original plan. It is subject to changes and additions, as SLs and PMs will see fit.
MSI has not succeded many times before. It is now my turn to give it a try. As with all of my other projects, I'll be using every resource available to pull this off. I'll guide you and let you loose, I'll direct you at first, and then let you go on, keeping an eye on things. As always, I'll be available to questions and discussions. I am giving this project every single possibility, including a lot of thinking ahead as you can see. I just won't script it; That is for you SRL Members to do, and i might throw in a function or two ;)
If you wish to apply for Scripting Leader or Project Manager now would be the time (look at next post for App Form).