Reference

What Maru-gun can do, what its settings mean, and how to control it. This reference describes the current addon and desktop application. Spell and ability choices depend on the character's job, learned actions, equipment and live game state.

Party controls

Load //lua load marugun on each character and open the desktop application. Select a character to edit its modules. Start and Stop control whether a module acts; changing its settings does not normally start it.

  • Enabled: include a module in that character's configuration.
  • Start / Pause: run or pause automation. The party controls apply to connected characters; in-game commands apply to the character receiving the command.
  • Automatic sync: edits are sent to the selected character. Watch the sync/result indicator before assuming a change has reached the game.
  • Save / Load party settings: keep named snapshots and explicitly restore a saved group configuration.
  • Job variants: module settings can follow a character's main-job/subjob combination.

Connecting or installing starts paused. //mg ws apply is an explicit exception: it applies the WS choices and starts that module. Closing the desktop window does not stop the broker or running automation; use Pause or //mg pause.

Healing

Control single-target cures, Curaga, ailment removal, self Reraise and per-recipient buffs. Set normal, critical and tank HP thresholds, reserve MP, and choose which Cure and Curaga tiers can be used.

  • Cure tiers: configure each tier's HP amount, choose a minimum tier, and allow smaller/larger fallback cures.
  • Curaga: choose the minimum injured recipients, their HP threshold and the minimum total missing HP.
  • Buffs: choose party recipients and their available buffs, including Protect, Shell, Haste and supported Scholar storms. Reserve Scholar charges for other actions when needed.
  • Debuffs: select individual ailments to remove, including Doom, Petrification, Sleep, Silence, Paralysis, Slow, Elegy, Curse, Disease, Plague, Poison, Blind, Bind, Weight, Addle and supported stat-down effects.
All healing definition fields
SettingExplanationAllowed values
schema_versionSaved definition format. Version 1 is currently supported.1
auto_self_reraiseMaintain Reraise on the healer when a usable spell is available.boolean
cure.start_hppStart curing a normal recipient below this HP percentage.1 to 100
cure.critical_hppTreat recipients below this HP percentage as critical.1 to 100
cure.enabledAllow single-target cures.boolean
cure.tank_start_hppUse this HP threshold for recipients marked as tanks.1 to 100
cure.min_cure_tierLowest Cure tier the healer may choose.1 to 6
cure.use_cureplease_thresholdsUse your configured per-tier HP thresholds when selecting Cure.boolean
cure.overcureAllow a larger Cure tier as a fallback.boolean
cure.undercureAllow a smaller Cure tier as a fallback.boolean
cure.tiers.*.enabledAllow this named Cure tier.boolean
cure.tiers.*.amountConfigured HP amount for this named Cure tier.0 to 99999
cure.cure_target_factorScale missing HP when choosing a Cure for a normal recipient.0.1 to 2
cure.critical_cure_target_factorScale missing HP when choosing a Cure for a critical recipient.0.1 to 2
cure.mp_reserveKeep this amount of MP in reserve when selecting a cure.0 to 99999
aoe_cure.enabledAllow area cures with Curaga.boolean
aoe_cure.min_targetsMinimum number of injured recipients needed for Curaga.1 to 18
aoe_cure.use_cureplease_thresholdsUse configured per-tier HP thresholds for Curaga selection.boolean
aoe_cure.overcureAllow a larger Curaga tier as a fallback.boolean
aoe_cure.undercureAllow a smaller Curaga tier as a fallback.boolean
aoe_cure.tiers.*.enabledAllow this named Curaga tier.boolean
aoe_cure.tiers.*.amountConfigured HP amount for this named Curaga tier.0 to 99999
aoe_cure.start_hppCount recipients below this HP percentage for Curaga.1 to 100
aoe_cure.min_total_missing_hpMinimum combined missing HP before using Curaga.0 to 99999
removals.*Turn removal of this named status ailment on or off.boolean
buff_assignments[]Healing buff recipients and choices; see the assignment fields below.assignment record
target_roles.*Mark a recipient with a healing role, such as tank, for role-specific treatment.string
sch_reserve_chargesKeep this many Scholar stratagem charges in reserve.0 to 4

Weapon skills

Pick a weapon type, a weapon skill and a TP threshold from 1000 to 3000. The engage requirement limits actions to combat; close-only waits for skillchain opportunities.

  • Single WS: use the selected WS at the configured TP.
  • WS sequence: choose weapon skills in order.
  • Maintain aftermath: use the aftermath WS at AM1, AM2 or AM3 TP, then return to the regular WS.
  • Abyssea cycle: use configured WS/TP/equipment entries in the cycle.
  • Job preparation: enable supported job-ability preparation, including Dancer Finishing Move/Flourish policy and Thief Sneak Attack policy.
  • Automatic ranged attacks: enable ranged attacks where supported by the current mode.
  • GearSwap / Break: GearSwap can apply TP, WS and aftermath together. Advanced definitions can name equipment sets for Break and Abyssea entries.

The desktop editor exposes the main WS controls. The Dancer, Thief and equipment fields below are advanced saved-definition fields, not additional visible sliders in the current editor.

All ws definition fields
SettingExplanationAllowed values
schema_versionSaved definition format. Version 1 is currently supported.1
modeWeapon-skill strategy: one WS, an ordered sequence, aftermath maintenance, or Abyssea cycling.single, chain, aftermath, abyssea
actionThe selected spell, ability or weapon skill; see action fields below.Action record or empty selection
tpMinimum TP for the selected weapon skill.1000 to 3000
close_onlyWait for a suitable skillchain-closing opportunity.boolean
chain[]Weapon skills to attempt in order in sequence mode.Action record or empty selection
aftermath.actionWeapon skill used to establish or renew aftermath.ws_action record
aftermath.tpTP threshold for the desired aftermath level: 1000, 2000 or 3000.1000, 2000, 3000
aftermath.buff_idStatus ID used to observe whether the desired aftermath is active.1 to 65535
preparation[]Ordered actions to run as preparation. Self-buff preparation entries use the rule fields below; WS preparation entries use action fields.action record
engage_requiredOnly act while engaged. In Self buffs this limits maintenance, not an explicit preparation request.boolean
job_preparationEnable job-specific ability preparation before weapon skills.boolean
dnc.fm_targetTarget number of Finishing Moves to build.1 to 6
dnc.climactic_fmFinishing Moves threshold used for Climactic Flourish preparation.1 to 5
dnc.rf_minMinimum Finishing Moves before considering Reverse Flourish.1 to 5
dnc.reserveReserve Finishing Moves when Climactic Flourish will be ready within this many seconds.0 to 600
dnc.max_holdMaximum seconds to hold a weapon skill for Dancer preparation.0 to 60
dnc.rf_bonusExtra TP added to the Reverse Flourish TP estimate.0 to 1000
dnc.rf_squareQuadratic coefficient in the Reverse Flourish TP estimate; accounts for relevant equipment.5 to 1000
thf.max_holdMaximum seconds to wait for Thief weapon-skill positioning/preparation.0 to 10
thf.enabledEnable the Thief-specific Sneak Attack preparation policy.boolean
autoraAllow automatic ranged attacks where supported by the selected WS mode.boolean
break_equipmentEquipment-set ID used for the explicit Break WS action.1 to 65535
abyssea[].actionWeapon skill for this Abyssea cycle entry.ws_action record
abyssea[].tpTP requirement for this Abyssea cycle entry.1000 to 3000
abyssea[].equipmentEquipment-set ID associated with this Abyssea entry.1 to 65535
equipment_sets[].idNumeric ID referenced by Break or Abyssea entries.1 to 65535
equipment_sets[].nameDisplay name for an equipment set.string
equipment_sets[].items.*Equipment item for the named slot in this set.0 to 65535

Self buffs and preparation

The maintenance list keeps selected effects active in order. The separate preparation list runs once, in order, when you press Run preparation. Add, remove or reorder available spells and abilities, and select rune counts where supported.

Choose a bundled job/subjob set as a starting point, then edit it for the character. Main-job and subjob eligibility, buff dependencies, existing effects, pet state and rune capacity affect which actions can run. Special abilities require explicit consent for that preparation; they are not silently added to routine maintenance.

Cancel preparation stops the pending sequence. The engagement checkbox limits routine maintenance.

All self buffs definition fields
SettingExplanationAllowed values
schema_versionSaved definition format. Version 1 is currently supported.1
maintenance[]Buffs to keep active, in priority order; each entry uses the rule fields below.rule record
preparation[]Ordered actions to run as preparation. Self-buff preparation entries use the rule fields below; WS preparation entries use action fields.rule record
main_jobMain-job label associated with this self-buff definition.string
sub_jobSubjob label associated with this self-buff definition.string
engage_requiredOnly act while engaged. In Self buffs this limits maintenance, not an explicit preparation request.boolean

Advanced buff-rule fields

All rule definition fields
SettingExplanationAllowed values
actionThe selected spell, ability or weapon skill; see action fields below.action record
buff_idStatus ID used to detect whether the effect is already active.1 to 65535
targetTarget category for a buff rule. GEO uses a character identity for the Entrust recipient.self, enemy, party
target_keySpecific party-member identity when a rule targets a party recipient.string
min_hppLowest HP percentage at which the rule is eligible.0 to 100
max_hppHighest HP percentage at which the rule is eligible.0 to 100
jobs[]Jobs for which the rule is eligible.string
specialMarks special abilities requiring the appropriate explicit preparation consent. COR keeps this field in saved definitions; it is not a general permission to spend special abilities.boolean
countDesired stack count; rune entries may request more than one.1 to 3
blocks[]Status IDs that prevent this action from being selected.1 to 65535
alternative_buffs[]Other statuses that satisfy this buff rule without recasting it.1 to 65535
requires_buffRequired active status before this rule can run.1 to 65535
after[]Preparation dependency identifiers, used to order prerequisite buffs.1 to 64
petTreat the rule as pet-related when determining whether its effect is satisfied.boolean
pet_namePet name used when identifying the required pet.string
requires_petRequire an existing pet before the rule is eligible.boolean
no_petOnly use the rule when no pet is present.boolean
tp_belowOnly use this rule below the specified TP amount.0 to 3000
requiredWhether a preparation step is required instead of optional.boolean

Bard

Set party songs in order, choose placeholder songs, and assign Pianissimo songs to individual recipients. Press Sing to request a sequence or Cancel singing to cancel it.

The Sing controls let you include or omit NiTro, placeholders and Pianissimo. Soul Voice and Clarion Call are separate opt-in choices for that singing request. These request options are not persistent song-list fields.

All bard definition fields
SettingExplanationAllowed values
schema_versionSaved definition format. Version 1 is currently supported.1
songs[]Ordered party songs for the singing sequence.spell_action record
placeholders[]Placeholder songs used while establishing the desired song capacity.spell_action record
pianissimo_targets[].targetRecipient identity for an individual song.string
pianissimo_targets[].songSong to give that recipient using Pianissimo.spell_action record

Geomancer

Select Indi, Geo and Entrust spells and an Entrust recipient. Adjust engagement gating, early refresh, Full Circle distance and fallback Entrust duration.

Enable supported GEO abilities individually. Hate mode can be Off, an enemy spell, or a cure on a chosen party member, with a minimum interval between attempts. Bolster is an explicit button/command request.

All geo definition fields
SettingExplanationAllowed values
schema_versionSaved definition format. Version 1 is currently supported.1
indiIndi spell to maintain on the geomancer.Action record or empty selection
geoGeo spell used for the luopan.Action record or empty selection
entrustIndi spell to give another character through Entrust.Action record or empty selection
targetTarget category for a buff rule. GEO uses a character identity for the Entrust recipient.string
require_engagedOnly run this module's maintenance while engaged.boolean
refresh_marginRefresh a timed effect this many seconds before its observed expiry.0 to 30
fullcircle_distanceDistance used to decide when a misplaced luopan should be removed with Full Circle.5 to 40
entrust_durationFallback Entrust lifetime in seconds when no better observation is available.60 to 900
abilities.blaze_of_gloryAllow Blaze of Glory in the GEO maintenance policy.boolean
abilities.ecliptic_attritionAllow Ecliptic Attrition in the GEO maintenance policy.boolean
abilities.lasting_emanationAllow Lasting Emanation in the GEO maintenance policy.boolean
abilities.life_cycleAllow Life Cycle in the GEO maintenance policy.boolean
abilities.dematerializeAllow Dematerialize in the GEO maintenance policy.boolean
hate.modeChoose no hate action, an enemy spell, or curing a party member.off, enemy_spell, cure
hate.enemy_spellSpell used when the hate mode is enemy_spell.string
hate.cure_spellCure spell used when the hate mode is cure.string
hate.cure_targetParty recipient for the hate-generation cure.string
hate.interval_secondsMinimum seconds between hate-generation attempts.5 to 300

Corsair

The editor has two roll selectors and a Crooked Cards choice: Off, Roll 1 or Roll 2. The runtime handles the roll sequence using its configured Double-Up, Snake Eye and Fold policy.

The range and engagement options below belong to advanced saved definitions. They are not extra controls in the current compact COR editor.

All cor definition fields
SettingExplanationAllowed values
schema_versionSaved definition format. Version 1 is currently supported.1
rolls[]The selected Corsair rolls, in order.ability_action record
double_upAllow the roll policy to use Double-Up.boolean
snake_eyeAllow the roll policy to use Snake Eye.boolean
foldAllow the roll policy to use Fold to recover from a bust.boolean
specialMarks special abilities requiring the appropriate explicit preparation consent. COR keeps this field in saved definitions; it is not a general permission to spend special abilities.boolean
require_engagedOnly run this module's maintenance while engaged.boolean
require_party_rangeWait until eligible party members are within roll range.boolean
roll_while_engagedAllow rolling while engaged; false limits rolls to outside engagement.boolean
crooked_cardsChoose no Crooked Cards, the first roll, or the second roll using 0, 1 or 2.0 to 2

In-game overlay

A single overlay shows module state for connected characters. Choose party-only or all-connected rows, show or hide the display, set its position, and lock it. Font size is 6–32 and background opacity is 0–255. Display preferences are saved per character.

Use //mg overlay pos 40 180, //mg overlay size 12, or the commands below. Reset restores the overlay's starting preferences.

Command reference

//mg and //marugun address the same addon. Commands act on the character where they are entered.

CommandWhat it does
//mg helpShow the current in-game command help.
//mg start|stop|status [all|healing|ws|buff|bard|geo|cor]Control or inspect all modules, or one module, on this character.
//mg healing|ws|buff|bard|geo|cor start|stop|statusEquivalent module-first form.
//mg pausePause this character's automation immediately.
//mg connectReconnect to the local broker and remain paused.
//mg ws apply 1000 "Savage Blade" offApply TP/WS choices and start WS. Replace off with am1, am2 or am3 and optionally add a quoted aftermath WS.
//mg ws tp 1500
//mg ws engage on|off
Change TP or engagement requirements without an implicit Start.
//mg buff list
//mg buff apply WAR_SAM
List or select a bundled buff set.
//mg buff prepare|cancelRequest or cancel preparation.
//mg bard sing|cancel
//mg geo bolster
Request/cancel singing or explicitly request Bolster.
//mg overlay on|off
//mg overlay pos X Y
//mg overlay lock on|off
Visibility, position and locking.
//mg overlay size N
//mg overlay opacity N
//mg overlay filter party|all-connected
//mg overlay reset
Font size, background opacity, roster filter and reset.

Module aliases include heal/cure for healing and buff/buffs/self_buffs for self buffs. Manage other addons separately; Maru-gun does not stop unrelated automation for you.

Saved definitions and application settings

The expandable tables list accepted module-definition fields and their validation limits. A range is an allowed input, not a recommendation. An asterisk names a map entry; square brackets name list entries. Optional fields may be absent. Advanced fields are normally supplied through presets/imported settings rather than a separate control in every editor.

Profiles contain the party group, per-character module selections, job variants and reusable module libraries. Keep exported identities and schema-version fields intact. Historic assignment, simulation and application-policy fields may remain in saved files for compatibility; their presence does not enable a current UI feature or automatic activation.

Action records

Spell/ability/WS selectors save action records. Eligibility still depends on the character's learned actions and current game state.

All action definition fields
SettingExplanationAllowed values
kindAction type: spell, ability, WS, item, ranged attack or equipment.spell, ability, ws, item, ranged, equipment
idWindower resource ID identifying the action.1 to 65535
labelHuman-readable action name; the resource ID identifies the actual action.string

Healing buff assignments

All assignment definition fields
SettingExplanationAllowed values
providerIdentity of the character providing this buff.string
purposeBuff purpose selected for this recipient assignment.string
targets[]Recipient identities for the assignment.string
aoeWhether to request an area application where the spell/job supports it.boolean

Installation and updates

Install the tool in a writable application folder and select the existing Windower addons folder separately. Startup checks the signed app/addon versions. Download/update stages verified files; installation waits for clients and applications to exit. Windows and Linux/Wine installers are available on the downloads page.

Use named party saves or exports before changing a complex setup. Public report uploads are not enabled on this website. Installing or updating never starts gameplay automation.

← Back to base