Nyyrazzilyss / NyyLIB

Mudlet client script for Torilmud
http://www.torilmud.com/phpBB3/viewtopic.php?f=4&t=27194
GNU General Public License v2.0
7 stars 4 forks source link

Helpfiles need rewrite #99

Open Nyyrazzilyss opened 6 years ago

Nyyrazzilyss commented 6 years ago

The included help files (@help) need to be re-written/improved/etc. Which ones? All of them? What's missing: Anything that isn't there?

I'm not a documentation writer. As far as i'm concerned, they're just fine. If I can read them, they're good enough. I don't need a helpfile/instructions to use command (@xxx), so why would anyone else?

If there isn't a helpfile entry for a script command you're trying to use, figure it out and write one. If you're reading an entry, and it's not clear/formatted nicely, re-write it!

They can be changed in bulk by forking / or directly editing the helpfile.dat file. Also, you can append them to this thread, or create a new issue with the text of the edited entry.

i982 commented 6 years ago

Revision to the Cooldown alias - and also a suggestion. maybe change the checkmask because if you are a paladin you should use your cleave on entry rather than hitall. its guarenteed to hit everything not just a chance at it.

The countdown command will gsay a countdown from 5 to 1, then move in a specific direction. If a mobname had been previously supplied, it will be attacked.

Example:

@attack mobname - the name of the target will set this target as current target for @cd
@cd s tiamat    - Issue countdown, then move south and attack Tiamat.
@cd s           - Issue countdown, then move south. If a mob was previously specified by calling
                  countdown with a target or with @attack, it will be attacked.

Revision: The countdown alias is a timer used for notifying party members of the impending start of an engagement and will gsay a countdown from 5 to 1, then move in a specified direction and engaging target(s) there. If a target name had been previously specified then that target will be attacked.

Example:

@attack mobname - sets the name of the desired target to be used for the @cd alias

Example: "@attack reaver" will set your target for your "@cd" alias. So now when you type "@cd s" it will move south and attack reaver automatically. To clear the current target simply type "@attack" and it will clear current target.

@cd s - Issue a 5 second countdown, then move south.

(note): Using the alias "@cd " without a pre-selected alias "@attack" target will result in the coundown going in the specified directions and using the hitall ability rather than attacking a specific target. It will also disable your rescue triggers, so be mindful to turn them back on after the fight

i982 commented 6 years ago

Condensed

Many of the triggers require information that is gagged from ever arriving at the client by the mud's condensed mode. It is recommended to disable mud condensed (tog condensed so it shows: Disabled)

There are a number of condensed settings available internally through the script. These replace the mud's condensed settings.

Enable as many or all of these as desired to reduce spam.

@set condensed items - Item gags (couldnt find anything for this to gag? so not sure about this setting) @set condensed misc - Assorted miscellaneous gags (dont know what this gags) @set condensed combat - Combat related spam such as misses by targets and players @set condensed duplicate - Duplicate lines will be supressed including spells/attacks/items worn @set condensed spells - Spell spam (i assume this is for spells like magic missile or aoes? cause ranger spells still appear if so duplicate setting should replace this) @set condensed dragon - Dragon gags @set condensed arrows - Various archery related gags (not sure this is still needed? since arrows dont miss or bounce anymore in combat chat i dont think and collecting isnt displayed either) @set condensed spellout = Locally show self/group spellout messages

(note): For tanks condensing certain combat items may affect rescue triggers (note): For all others condensing certain items may affect assist triggers

The individual modes are enabled (will not be seen) when the script replies that it has been set to true.

Nyyrazzilyss commented 6 years ago

Added 1/20 dev, thanks!

Don't post to this ticket please, create a new one. That way changes can be visible to people for commenting, and can be labeled as being in progress.