An Ashita v3 addon that allows the user to change or remove the default mount music in Final Fantasy 11 Online.

Sjshovan dce7b5be54 initial.		6 years ago
LICENSE	initial.	6 years ago
README.md	initial.	6 years ago
constants.lua	initial.	6 years ago
helpers.lua	initial.	6 years ago
mountmuzzle.lua	initial.	6 years ago

README.md

Author: Sjshovan (Apogee)
Version: v0.9.0

Mount Muzzle

An Ashita v3 addon that allows the user to change or remove the default mount music in Final Fantasy 11 Online.

Prerequisites
Installation
Aliases
Usage
Commands
Support
Change Log
Known Issues
TODOs
License

Prerequisites

Installation

Ashita:

Navigate to the Addons section on the left.
Locate the MountMuzzle addon.
Click the flashing download button near the upper-right corner.

Manual:

Navigate to https://github.com/Ap0gee/Ashita-MountMuzzle.
Click on Releases.
Click on the Source code (zip) link within the latest release to download.
Extract the zipped folder to Ashita_v3/addons/.
Rename the folder to remove the version tag (-v0.9.0). The folder should be named MountMuzzle.

Autoloading:

By default you will need to manually load this addon each time you restart the game. To autoload MountMuzzle so that it is always ready for use upon entering the game, follow these steps:

Navigate to the Ashita_v3/scripts/ directory.
Open the Default.txt file.
Locate the Load Common Addons section.
add the following line: /addon load mountmuzzle.

Aliases

The following aliases are available to Mount Muzzle commands:

mountmuzzle: muzzle | mm
list: l
set: s
get: g
default: d
unload: u
reload: r
about: a
silent: s
mount: m
chocobo: c
zone: z
help: h

Usage

Manually load the addon by using the following command:

/addon load mountmuzzle

Commands

help

Displays available Mount Muzzle commands. Below are the equivalent ways of calling the command:

/mountmuzzle help
/muzzle help
/mm help
/mountmuzzle h
/muzzle h
/mm h

list

Displays the available muzzle types. Below are the equivalent ways of calling the command:

/mountmuzzle list
/muzzle list
/mm list
/mm l

set <muzzle>

Sets the current muzzle to the given muzzle type. This command takes a single argument represented by <muzzle>. Below are the equivalent ways of calling the command:

/mountmuzzle set <muzzle>
/muzzle set <muzzle>
/mm set <muzzle>
/mm s <muzzle>

Here are some usage examples for the set <muzzle> command: mm set silent and muzzle set zone etc...

get

Displays the current muzzle that is set. Below are the equivalent ways of calling the command:

/mountmuzzle get
/muzzle get
/mm get
/mm g

default

Sets the current muzzle to the default muzzle type: Silent. Below are the equivalent ways of calling the command:

/mountmuzzle default
/muzzle default
/mm default
/mm d

unload

Unloads the Mount Muzzle addon. Below are the equivalent ways of calling the command:

/mountmuzzle unload
/muzzle unload
/mm unload
/mm u

reload

Reloads the Mount Muzzle addon. Below are the equivalent ways of calling the command:

/mountmuzzle reload
/muzzle reload
/mm reload
/mm r

about

Displays information about the Mount Muzzle addon. Below are the equivalent ways of calling the command:

/mountmuzzle about
/muzzle about
/mm about
/mm a

Support

Having Issues with this addon?

Please let me know here.

Have something to say?

Send me some feedback here: [email protected]

Want to stay in the loop with my work?

You can follow me at: https://twitter.com/Sjshovan

Want to show your love and help me make more awesome stuff?

You can do so here: https://www.paypal.me/Sjshovan

Change Log

v0.9.0 - 12/4/2018

Initial release

Known Issues

Issue: If Mount Muzzle is selected to automatically load and the player is mounted upon login, there is a significant delay before the chosen music will begin to play.
Issue: Upon changing zones the default music can be heard for a moment before the chosen music begins to play.
Issue: Unable to correctly set mount music to original if Mount Muzzle is unloaded while mounted.

TODOs

TODO: Investigate alternative methods for music change as packet injection/swap allows the player to hear the default music upon zone change and login, regardless of chosen music.
TODO: Investigate methods for determining which mount type the player is on when loading/unloading Mount Muzzle.