Talk:Pound *KS* (script)

From Elanthipedia
Revision as of 20:35, 13 June 2016 by RY4NPW (talk | contribs) (→‎Script Suggestions: new section)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Script Suggestions

Since you asked for feedback/suggestions, I thought I'd mention a few things.

1. Add some usage directions to the top of your script. It makes it so much easier to figure out when people share scripts.

   # To use this script, have your instruction book in hand. Turn your book to the desired page and run .pound
   # Make sure you set the variables "toolContainer" and "hammer" below before the first run!

2. When others need to maintain and/or work with scripts, it is very helpful to have descriptive variable names. It means so much more than A, B, C, etc. It also makes setting variables a lot easier for the user too! Instead of 2 variables, you can suggest users add an underscore. With StormFront you can also use quotes, but quotes are incompatible with Genie.

   # Make sure you set the variables below *BEFORE* the first run!
   SETVARIABLE toolsContainer forger's_belt      # this container has your  hammer, tongs, rod, bellows, and shovel.
   SETVARIABLE consumablesContainer "tool chest" # this is the container for consumables such as oil, hilts, cloth padding, etc.
   SETVARIABLE instructionsContainer backpack    # where you keep your logbook and forging instructions

3. There is such a thing as a forging mallet in addition to a forging hammer. Your script would need a minor tweak to support both:

   SETVARIABLE hammer ball-peen_mallet
   
   ...
   
   PUT pound %itemToForge on anvil with my %hammer

Cheers! - padhg (talk) 20:35, 13 June 2016 (CDT)