ENs - Fast Script Framework

[Endless Night]

EN's Fast Script Framework
Version 1 Release Date: 11/2012

[spoiler=Script Header]
;============================================
; EUO version tested with: As Per Revision Date
; Shard OSI / FS: OSI
; Revision Dates: 11/12
; Public Release:  11/12
; Purpose: Fast Script Creation
;============================================
[/spoiler]

ABOUT
  I remember long ago Cerveza saying how he would love an easy way to setup a script and reuse code, well this is the answer. The first thing you will notice about scripts that use EN's Fast Script Framework is how little code is actually contained in the main File. The objective is to setup a framework that accesses and extends ENs callable Script Library  to automate standard script setups and functions.

FEATURES
- automatically detecting what skills a given character has and setting appropriate variables.  IE REcall or Sacred Journey,  Mind-blast or Corp Por, Can I hide, Can i pickup bods etc.
- Setting up the character environment .. location of backpack, status bar etc
- Menus  and menu functions (pause/halt resume)
- remove all customization header-blocks or code or setup functions into one standard place for all scripts using the framework. In order to eliminate duplication or the need to edit scripts for individual characters. Or the need to cut and paste setup functions when a script is updated.


HOW TO SETUP ENs SCRIPT LIBRARY AND FAST SCRIPT FRAMEWORK
  Step 1 - ENs Script Library
        Follow instructions and download Script library's files located Here
  Step 2 - ENs Elite Script Library
        Download Elite Level Script Library Files  Here (Obviously if your not elite this is not going to happen so skip this step)
  Step 3 - ENs Fast Script Framework
      3a- Download ENs-Subs-FastScriptFramework.txt from this post (Save in same location as Library Files) Now included in the zip from step 1.
      3b- Download ENs-Subs-PersonalSettings.txt from this post (Save in same location as Library Files)
      3c- Configure Personal Settings - Documentation 1 Post Down

HOW TO USE THE FAST SCRIPT FRAMEWORK IN YOUR SCRIPTS
Documentation 2 Posts Down


Feedback:
Feedback both negative and postive are defiantly more than welcomed and encouraged.  Same with feature requests .. no guaranettee will make it into the code .. but it might.

THESE ARE CALLABLE SCRIPTS ONLY ... DO not cut and paste into your script


Disclaimer/Usage License:  See Script for full Details.
(C) 2007 All Rights Reserved JosephAJ
Commercial usage requires written permission from the author

NOTE: My scripts or any derivative of them are *not* for use in other players script/s!

[Endless Night]

How To Configure ENs_Subs-PersonalSettings.txt
File: ENs_Subs-PersonalSettings.txt

If you don't need to change a particular scripts functions or override ENs Default settings you dont need to read any further.

Why put personal settings in sub files, well it allows me to update a script without you having to edit the header block.  It also allows me to post scripts without worrying ive included my username/password for those autologin features.  Many default character settings are made behind the scenes you can override these settings in this sub file

Overriding Re/setting a Var can be done in each of these 3 subs with differing effects (order of overide is as listed):
-Sub ENs_StandardPersonalSettings: Will override that var for  chars all in all EN supported scripts
-Sub ENs_Setup??? :  Setup sub for a particular script will override for this script only
-sub ENs_CharacterSpecificOverRides: to make settings for particular chars eg autologin stuff or whatever you want like below
    ;  if #charname = bla , #spc , Bla
   ;    call %ENs_Subs_LoginOut ENs_LoginSetup ; Autologin(true/#false)  Accountname password maxslots charslot shardname (nospaces)

Runebooks
The Default Names of runebook/s sets are: Bank, stables, Bodding Tailors, Bodding BlackSmiths

Setting up resouce Containors in the Bank
This script uses ENs auto bag detection routines.  You need to label a bunch of bags with unique names, and then tell the script the name of the bag (or keyword in name) and the type of bag for each of the below resource categories.  This script doesn't use all these bags but will look for them anyways so if you want you can set the unneeded ones to the same bag over and over.

I use colored wood boxes as that was initially easier for me than labeling bags for many diff chars on many diff accounts, but you use whatever you want... edit the sub ENs_ResourceStorageSettings  for your preferred settings.

The format of the sub is ...
1- Internal Var name eg BankFishBag (dont change this)
2- Bag text  ie yew  (change to whatever you want eg fishfingers)
3- Bag type code ie wooden box=HKF_CUD  .. but use the matching code for your bag

You can set 2 and 3 to anything you wish.
call %ENs_Subs_Banking AutoDetectBag BankFishBag      Yew        %BagTypeWoodenBox

Bodding
Bod pickup is automatically turned on if your character has the skill to pickup either tailor or smith bods.  Please make sure to have a bodbook in your backpack.  You can turn off this automatic bodding by adding the below lines either to  file  ENs_Subs-PersonalSettings.txt,  Sub ENs_StandardPersonalSettings (will turn off for all chars all EN scripts) or add to ENs_SetupFishMongerQuestor and will turn off for this script only or add to  ENs_CharacterSpecificOverRides to turn on off for certain characters.

Personally I think if you can pickup bods its worth leaving on auto as the script will only do it at convient times when the timer has been reached.

set %EN_CollectBodsTailor     #False
set %EN_CollectBodsBlackSmith #False

[Endless Night]

HOW TO USE THE FAST SCRIPT FRAMEWORK IN YOUR SCRIPTS

Outline template file is attached.   Further documentation will come when i have time.  Ask questions etc in this thread.

[NObama]

Dear sweet baby Jesus.  Do you actually even play the game, EN, or do you just have a laptop in a dark, dusty server room that does everything for you in SPECTACULAR AUTOMATED FASHION!

I am impressed.

[manwinc]

I once set things up like this for my Guildmates. Mainly Crafting. Its A Great Learning tool for people to understand how to make a loop and to use subs others have written. My hat is off to you for doing it publicly!

[Endless Night]

I once set things up like this for my Guildmates. Mainly Crafting. Its A Great Learning tool for people to understand how to make a loop and to use subs others have written. My hat is off to you for doing it publicly!

just wait until you see the massive code dump that's coming.

[NObama]

I once set things up like this for my Guildmates. Mainly Crafting. Its A Great Learning tool for people to understand how to make a loop and to use subs others have written. My hat is off to you for doing it publicly!

just wait until you see the massive code dump that's coming.

Christmas isn't until *next* month, EN...

[gimlet]

Gim holds his breath!

[Paulonius]

A TOOL KIT!!! Very cool idea. I will wait to see what you put out there before I start sending requests for subs!

[Endless Night]

A TOOL KIT!!! Very cool idea. I will wait to see what you put out there before I start sending requests for subs!

Current list of sub files (each contain a varing number of actaul subs)

ENs-Subs-SpellsAndRuneBook.txt
ENs-Subs-Standard.txt
ENs-Subs-BodsAndNPCs.txt
ENs-Subs-Menus.txt
ENs-Subs-BanksAndHome.txt
ENs-Subs-Pets.txt
ENs-Subs-ResourceGathering.Txt
ENs-Subs-CharacterSkills.Txt
ENs-Subs-LoginOut.Txt
ENs-Subs-ThreatCheck.txt
ENs-Subs-Crafting.txt
ENs-Subs-HealthBars.txt

And thier will be few more after i rip apart some more of my scripts.

[Endless Night]

This will be up shortly .. but meanwhile im ripping usefull public posted subs (open licesesed) on Euo into a seperate file. For easy access.

[Endless Night]

Gim holds his breath!

I think you must have taken another breath by now... but just in case .. the code has finally hit the boards .. breath easy.