Bigshot: The New Optimus Prime

[Alorn15]

In Beta
Bug Reports and Feature Requests Welcome

Features:

* Optimus Prime: Completely rewritten
* MA capable
* Object oriented
* Revised UI
* Too many improvements to list

Synopsis:

****** Bigshot as a normal solo script ******

> ;trust bigshot
> ;bigshot setup
> ;bigshot

****** Bigshot in MA mode ******

1) Setup bigshot on all characters.
  (Settings dictating valid targets and flee configuration must be identical)

2) Kickoff
  a) Gather characters
  b) Join leader
  c) Start tails
    > ;bigshot tail
  d) Start head
    > ;bigshot head

****** Bigshot as an object ******

> ;trust bigshot
> ;bigshot setup

# require bigshot
start_script('bigshot')
wait_while { running?('bigshot') }

# class methods
Bigshot.wait_for_swing(optional_target)

# create bigshot object
my_bigshot = Bigshot.new()

# instance methods
my_bigshot.attack( GameObj.npcs[0] )
my_bigshot.poaching?
my_bigshot.start

FAQ:
Q: What is required to run bigshot?
A: Lich V4 or higher.

Q: How do I setup MA?
A: Read the synopsis.

Q: I'm a swinger
A: So your hunting commands probably look like this: kill target

Q: I'm a caster.
A: Then you probably want to do stuff like this in the Attack Routine: '413 target, 910 target, 903 target(xx)'

Q: Okay... but I want to spell myself up while resting.
A: Add 'waggle' to Resting Scripts.

Q: What's up with this? '903 target(xx)'.
A: If you add (xx) to a command, Optimus will execute it a bunch of times. You can also do things like (x2).

Q: It says Attack Routine Signs, but I'm in Sunfist/Voln! And I want to use Cman Surge!
A: You can add any sign/sigil/symbol/cman to Attack Routine Signs. Spells like 506 too. Just add the correct spell ID. You can even do warrior tricks, but you probably want to add a stamina check. For example: wtrick feint target(s7)

Q: What's the spell ID for <insert sign/sigil/symbol/cman>?
A: Mouse over the signs/sigils/cmans entry field in setup for a complete list of ID's.

Q: What do I put in wound eval?
A: Any ruby code. If it evaluates to true, you'll rest. Here are some options:
Rest at 80% health, or bleeding, or on a rank 2 wound:

bleeding? || percenthealth <= 80 || [Wounds.head, Wounds.nsysWounds.leftArm, Wounds.leftHand, Wounds.rightArm, Wounds.rightHand].max >= 2

This should rest when you can't cast anymore:

bleeding? || percenthealth <= 50 || ([Wounds.head, Scars.head].max >= 2) || ([Wounds.nsys, Scars.nsys].max >= 2) || ([Wounds.leftArm, Wounds.leftHand, Wounds.rightArm, Wounds.rightHand, Scars.leftArm, Scars.leftHand, Scars.rightArm, Scars.rightHand].max >= 3) || ( ([Wounds.leftArm, Wounds.leftHand, Scars.leftArm, Scars.leftHand].max >= 2) or ([Wounds.rightArm, Wounds.rightHand, Scars.leftArm, Scars.leftHand].max >= 2) )

Q: I want to change my attack routine depending on the creature.
A: Set your valid targets up like this: rat, wraith(b), cat(c). No, don't include the trailing period. Now fill out hunting routine b for the wraith, and c for the cat.

Q: I want to wait for the creature to attack me before I swing/cast.
A: Use the wait command. It works like this: wait 30, kill target(xx). Or, if you want to wait before every swing: wait 30, kill target. The 30 is the number of seconds to wait before timing out.

Q: What if I only want to cast 910 whenever i have at least 50 mana, but I want to swing otherwise?
A: 910 target(m50)(x10), kill target(x10)

Q: What does the spam attacks setting do?
A: It shortens the time you wait during roundtime before executing another command. I find that waitrt? and waitcastrt? wait a tad long, and I want my attacks to go off ASAP.

Q: I have wracking enabled, and sometimes my character just sits there.
A: Verify you've set your config to rest at a mana percentage which is greater than the cost of whatever spell it is you're trying to cast. Otherwise you may end up in a bad loop where:
1) You're not fried. Don't rest.
2) You're not out of mana. Don't rest.
3) You try and cast, but spell isn't affordable.
4) You try and wrack, but wracking isn't affordable.
5) Go back to 1.

Q: Gimme a list of valid commands for my hunting routine.
A:
wand | As in, 'wand target'
mstrike | As in, 'mstrike target'. Mstrike, or swing regularly, depending on mstrike cooldown
fire | As in, 'fire target'. Grab ammo and fire
berserk | Go berserk, then stand by until it fades
wand | As in, 'wand target'. Grab wand and wave
script | As in, 'script myattackscript'. Write your own attack routine
hide | Continue hiding until you're actually hidden. Or it's tired of trying.
sleep | As in, 'sleep 10'. Pause bigshot. Useful with fried hunting commands such as: 410, sleep 15
stance | As in, 'stance defense'. Change stances.
wait | As in, 'wait 30'. Covered above.
nudgeweapons | Move all weapons on the ground to an adjacent room
force <cmd> until <endroll> | As in, 'force 1002 until 101'. Continue issuing a command until a desired endroll. Only works for normal looking swings/spells/cmans.

Q: I'm having an issue with Bigshot.
A: First, make sure you're on the newest version by doing a ;repos download bigshot. If the issue persists, post about it here. Just include a short log of what happened, as well as the output of ;bigshot display