Wan-Wan!

4.4k Downloads

Wan-Wan! -- Read Me
===================

Greetings:
----------

    Hello, there! If you need some basic info on this little project of mine, you've come to the
    right place! I have everything in (hopefully) logical ordering.

    Thank you for trying out Wan-Wan! I hope you enjoy it!


What it Does:
-------------

    Wan-Wan! plays a random feral sound whenever you open up dialogue with a merchant or other
    friendly NPC, or when you interact with a hostile NPC or enemy player to initiate combat.
    The sound you'll hear will depend on what form you're in, whether the target is friendly or
    hostile, and if you have a glyph active that affects your feral form. This is geared towards
    druids and shamans who want to make extra sounds in their alternate forms.

    NOTE: There should be no need to worry about annoying other players. The sounds are all
    client-side, meaning only you will hear them.

    As of right now, that is all Wan-Wan! does. That is all I wanted it to do. If you think you can
    make it better or wish for it to do something else, my code is all yours to explore. Feel free
    to do whatever you want with it. Unfortunately, there are some things I cannot figure out how
    to do code-wise, such as making druids in cat form yawn loudly when they stretch. I would love
    to make the addon do that, but that may take a bit more work, if it's doable.

    This AddOn seems pretty lightweight. Hopefully, you won't run into any lag issues using it.


How to Use this Addon:
----------------------

    On first use: If Wan-Wan! is working, you should see a message in the Default Chat Frame once
    you log into the game: "Wan-Wan! has successfully loaded! Type "/wanwan ?" for some help with
    commands."

    By default, this addon is enabled. You can use the slash command "/wanwan" or "/bowwow" to
    toggle its functions on or off. This is the "base" slash command. You can tack on a slash
    command option after the base command for some extra effects. You can see the full list below:

        /wanwan                The base command. Enables/Disables the addon when used by itself.
        /wanwan spam        Toggle the login greeting on/off.
        /wanwan s            Same functionality as "/wanwan spam".
        /wanwan reset        Change the addon's settings back to their defaults.
        /wanwan r            Same functionality as "/wanwan reset".
        /wanwan adjust x    Adjust the wait time before making an extra feral sound by 'x' seconds.
                            NOTE: x must be a number between 1 and 20, inclusive.
        /wanwan a x            Same functionality as "/wanwan adjust x".
        /wanwan ? topic        Get information on a slash command option of a certain 'topic' (for
                            example, adjust). If you only type '?', you will get a list of all
                            acceptable commands.
        /wanwan help topic    Same functionality as "/wanwan ? topic".

        NOTE: You can always use the base command "/bowwow" instead!


Other Things to Note:
---------------------

    I use a timer function to make sure that the addon does not play more than one sound at a time
    due to multiple possible event triggers. This should be adjustable with the adjust slash
    command option as explained earlier.

    The majority of testing was done in the current (5.4.8) live client (enUS).

Special Thanks:
---------------

    My family and friends for their support.
    The WoW community (both in-game and in-forum) for the inspiration,  advice, and support.
    You, the addon user, for testing out my idea!


Farewell:
---------

    Thank you for trying out Wan-Wan!

    Feel free to let me know of any bugs or other errors via comments on the Curse website.
    A personal message is also acceptable. Please make sure to post the whole error message.
    I will get it fixed as soon as I can.

    Questions? Comments? Suggestions? Please, send them my way! I am open to constructive criticism.

    Regards,
    Cammy Bear.