From 7b5cb4b7c42989ccce42df047d050677b0bba990 Mon Sep 17 00:00:00 2001 From: atom0s Date: Fri, 25 Nov 2016 12:14:22 -0800 Subject: [PATCH] Initial code commit. --- bluemage.lua | 353 +++++++++++++++++++++++++++++++++++++++++++++++++++ blusets.lua | 201 +++++++++++++++++++++++++++++ 2 files changed, 554 insertions(+) create mode 100644 bluemage.lua create mode 100644 blusets.lua diff --git a/bluemage.lua b/bluemage.lua new file mode 100644 index 0000000..7e196e5 --- /dev/null +++ b/bluemage.lua @@ -0,0 +1,353 @@ +--[[ +* Ashita - Copyright (c) 2014 - 2016 atom0s [atom0s@live.com] +* +* This work is licensed under the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. +* To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-nd/4.0/ or send a letter to +* Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. +* +* By using Ashita, you agree to the above license and its terms. +* +* Attribution - You must give appropriate credit, provide a link to the license and indicate if changes were +* made. You must do so in any reasonable manner, but not in any way that suggests the licensor +* endorses you or your use. +* +* Non-Commercial - You may not use the material (Ashita) for commercial purposes. +* +* No-Derivatives - If you remix, transform, or build upon the material (Ashita), you may not distribute the +* modified material. You are, however, allowed to submit the modified works back to the original +* Ashita project in attempt to have it added to the original project. +* +* You may not apply legal terms or technological measures that legally restrict others +* from doing anything the license permits. +* +* No warranties are given. +]]-- + +---------------------------------------------------------------------------------------------------- +-- Variables +---------------------------------------------------------------------------------------------------- +local bluemage = {}; -- The overall table this library uses. +bluemage.queue = {}; -- The queue to handle events this library does. +bluemage.delay = 0.65; -- The delay to prevent spamming packets. +bluemage.timer = 0; -- The current time used for delaying packets. +bluemage.mem = {}; -- The table holding memory specific data. +bluemage.mem.offset1 = 0; -- The value for the current set blue spells. +bluemage.mem.offset2 = 0; -- The memory location for the current blue magic point info. + +---------------------------------------------------------------------------------------------------- +-- func: msg +-- desc: Prints out a message with the addon tag at the front. +---------------------------------------------------------------------------------------------------- +function msg(s) + local txt = '\31\200[\31\05' .. _addon.name .. '\31\200]\31\130 ' .. s; + print(txt); +end + +---------------------------------------------------------------------------------------------------- +-- func: err +-- desc: Prints out an error message with the addon tag at the front. +---------------------------------------------------------------------------------------------------- +function err(s) + local txt = '\31\200[\31\05' .. _addon.name .. '\31\200]\31\39 ' .. s; + print(txt); +end + +---------------------------------------------------------------------------------------------------- +-- func: initialize +-- desc: Prepares this library for usage. +---------------------------------------------------------------------------------------------------- +function bluemage.initialize() + -- Locate the pointers needed for this library.. + local pointer1 = ashita.memory.findpattern('FFXiMain.dll', 0, 'C1E1032BC8B0018D????????????B9????????F3A55F5E5B', 10, 0); + local pointer2 = ashita.memory.findpattern('FFXiMain.dll', 0, 'A1????????33C98A4E5E33D28A565D5F5E8950148948185B83C414C20400', 1, 0); + + -- Ensure the patterns were found.. + if (pointer1 == 0 or pointer2 == 0) then + err('Failed to locate required pattern(s).'); + return false; + end + + -- Read the first pointers value.. + local offset1 = ashita.memory.read_uint32(pointer1); + if (offset1 == 0) then + err('Failed to read required pointer value. (1)'); + return false; + end + + -- Read the first pointers value.. + local offset2 = ashita.memory.read_uint32(pointer2); + if (offset2 == 0) then + err('Failed to read required pointer value. (2)'); + return false; + end + + -- Store the values.. + bluemage.mem.offset1 = offset1; + bluemage.mem.offset2 = offset2; +end + +---------------------------------------------------------------------------------------------------- +-- func: is_blue_main +-- desc: Determines if the players main job is blue mage. +---------------------------------------------------------------------------------------------------- +function bluemage.is_blue_main() + return (AshitaCore:GetDataManager():GetPlayer():GetMainJob() == 16); +end + +---------------------------------------------------------------------------------------------------- +-- func: is_blue_sub +-- desc: Determines if the players sub job is blue mage. +---------------------------------------------------------------------------------------------------- +function bluemage.is_blue_sub() + return (AshitaCore:GetDataManager():GetPlayer():GetSubJob() == 16); +end + +---------------------------------------------------------------------------------------------------- +-- func: get_spent_points +-- desc: Obtains the current spent blue magic points. +---------------------------------------------------------------------------------------------------- +function bluemage.get_spent_points() + -- Determine if the blue points offset is valid.. + if (bluemage.mem.offset2 == 0) then + err('Cannot read blue spell points; pointer is invalid.'); + return -1; + end + + -- Read the pointer.. + local pointer = ashita.memory.read_uint32(bluemage.mem.offset2); + if (pointer == 0) then + return -1; + end + + -- Return the spent count.. + return ashita.memory.read_uint8(pointer + 0x14); +end + +---------------------------------------------------------------------------------------------------- +-- func: get_max_points +-- desc: Obtains the max available blue magic points. +---------------------------------------------------------------------------------------------------- +function bluemage.get_max_points() + -- Determine if the blue points offset is valid.. + if (bluemage.mem.offset2 == 0) then + err('Cannot read blue spell points; pointer is invalid.'); + return -1; + end + + -- Read the pointer.. + local pointer = ashita.memory.read_uint32(bluemage.mem.offset2); + if (pointer == 0) then + return -1; + end + + -- Return the spent count.. + return mem.ashita.memory.read_uint8(pointer + 0x18); +end + +---------------------------------------------------------------------------------------------------- +-- func: get_spells +-- desc: Obtains the current blue mage spells that are set. +---------------------------------------------------------------------------------------------------- +function bluemage.get_spells() + local spells = {}; + local offset = 0x04; + + -- Determine if the blue spell offset is valid.. + if (bluemage.mem.offset1 == 0) then + err('Cannot read blue spells; pointer is invalid.'); + return {}; + end + + -- Offset shifts 0xA0 if player is subbed blue.. + if (bluemage.is_blue_sub()) then + offset = 0xA0; + end + + -- Read the inventory pointer.. + local pointer = ashita.memory.read_uint32(AshitaCore:GetPointerManager():GetPointer('inventory')); + if (pointer == 0) then + return {}; + end + + -- Read the inventory pointer.. + pointer = ashita.memory.read_uint32(pointer); + if (pointer == 0) then + return {}; + end + + -- Read the spell data.. + return ashita.memory.read_array((pointer + bluemage.mem.offset1) + offset, 0x14); +end + +---------------------------------------------------------------------------------------------------- +-- func: get_spell_names +-- desc: Obtains the current blue mage spells that are set. (Names) +---------------------------------------------------------------------------------------------------- +function bluemage.get_spell_names() + -- Obtain the current spell list.. + local spells = bluemage.get_spells(); + if (spells == nil or #spells == 0) then + return {}; + end + + -- Loop the spells and obtain their names.. + local names = {}; + for k, v in pairs(spells) do + -- Obtain only valid set spells.. + if (v ~= 0) then + -- Obtain the spell.. + local spell = AshitaCore:GetResourceManager():GetSpellById(v + 512); + if (spell == nil) then + err(string.format('Failed to obtain spell name for spell id: %d', v + 512)); + else + table.insert(names, spell.Name[0]); + end + end + end + + return names; +end + +---------------------------------------------------------------------------------------------------- +-- func: reset_all_spells +-- desc: Resets all current set spells to nothing. +---------------------------------------------------------------------------------------------------- +function bluemage.reset_all_spells() + -- Obtain the current spells.. + local spells = bluemage.get_spells(); + if (spells == nil or #spells == 0) then + return; + end + + -- Prepare some packet variables.. + local isSubBlu = 0; + if (bluemage.is_blue_sub() == 16) then + isSubBlu = 1; + end + + -- Build the packet.. + local packet = string.char(0x02, 0x53, 0x00, 0x00) .. string.char(0x00, 0x00, 0x00, 0x00, 0x10, isSubBlu, 0x00, 0x00); + for x = 1, 20 do + packet = packet .. string.char(spells[x]); + end + packet = packet .. string.rep(string.char(0x00), 0x84); + packet = packet:totable(); + + -- Add the packet to our queue.. + table.insert(bluemage.queue, { 0x102, packet }); +end + +---------------------------------------------------------------------------------------------------- +-- func: set_spell +-- desc: Sets a blue mage spell. (Or removes one if the id is 0.) +---------------------------------------------------------------------------------------------------- +function bluemage.set_spell(id, index) + -- Determine if the blue spell offset is valid.. + if (bluemage.mem.offset1 == 0) then + err('Cannot set blue spell; pointer is invalid.'); + return false; + end + + -- Obtain the current spells.. + local spells = bluemage.get_spells(); + if (spells == nil or #spells == 0) then + return false; + end + + -- If the id is 0, we want to remove the spell in the given slot.. + if (id == 0) then + -- Obtain the current spell at the given index.. + local spell = spells[index]; + if (spell == nil or spell == 0) then + return true; + end + + -- Prepare some packet variables.. + local isSubBlu = 0; + if (bluemage.is_blue_sub() == true) then + isSubBlu = 1; + end + + -- Build the packet.. + local packet = string.char(0x02, 0x53, 0x00, 0x00) .. string.char(0x00, 0x00, 0x00, 0x00, 0x10, isSubBlu, 0x00, 0x00); + packet = packet .. string.rep(string.char(0x00), index - 1) .. string.char(spell); + packet = packet .. string.rep(string.char(0x00), 0x98 - index); + packet = packet:totable(); + + -- Add the packet to our queue.. + table.insert(bluemage.queue, { 0x102, packet }); + else + -- Calculate the spell id.. + local spell = id - 512; + if (spell < 0) then + err(string.format('Cannot set blue spell; invalid spell id given. (%d)', spell)); + return false; + end + + -- Prepare some packet variables.. + local isSubBlu = 0; + if (bluemage.is_blue_sub() == true) then + isSubBlu = 1; + end + + -- Build the packet.. + local packet = string.char(0x02, 0x53, 0x00, 0x00) .. string.char(spell, 0x00, 0x00, 0x00, 0x10, isSubBlu, 0x00, 0x00); + packet = packet .. string.rep(string.char(0x00), index - 1) .. string.char(spell); + packet = packet .. string.rep(string.char(0x00), 0x98 - index); + packet = packet:totable(); + + -- Add the packet to our queue.. + table.insert(bluemage.queue, { 0x102, packet }); + end +end + +---------------------------------------------------------------------------------------------------- +-- func: set_spell_by_name +-- desc: Sets a blue mage spell by name. (Or removes one if the name is empty.) +---------------------------------------------------------------------------------------------------- +function bluemage.set_spell_by_name(name, index) + -- Remove the spell if the name is null or empty.. + if (name == nil or name == '') then + return bluemage.set_spell(0, index); + end + + -- Obtain the spells information by its name.. + local spell = AshitaCore:GetResourceManager():GetSpellByName(name, 0); + if (spell == nil) then + err('Failed to obtain spell information for spell: ' .. name); + return; + end + + -- Ensure this is a blue mage spell.. + if (spell.Index < 512 or spell.Index > 1024) then + err('Failed to set spell: ' .. name .. ' - Spell is invalid or not a blue mage spell.'); + return; + end + + -- Set the spell.. + bluemage.set_spell(spell.Index, index); +end + +---------------------------------------------------------------------------------------------------- +-- func: process_queue +-- desc: Processes the packet queue to be sent. +---------------------------------------------------------------------------------------------------- +function bluemage.process_queue() + if (os.time() >= (bluemage.timer + bluemage.delay)) then + bluemage.timer = os.time(); + + -- Ensure the queue has something to process.. + if (#bluemage.queue > 0) then + -- Obtain the first queue entry.. + local data = table.remove(bluemage.queue, 1); + + -- Send the queued object.. + AddOutgoingPacket(data[1], data[2]); + end + end +end + +---------------------------------------------------------------------------------------------------- +-- Returns the blue mage table. +---------------------------------------------------------------------------------------------------- +return bluemage; \ No newline at end of file diff --git a/blusets.lua b/blusets.lua new file mode 100644 index 0000000..11eda74 --- /dev/null +++ b/blusets.lua @@ -0,0 +1,201 @@ +--[[ +* Ashita - Copyright (c) 2014 - 2016 atom0s [atom0s@live.com] +* +* This work is licensed under the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. +* To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-nd/4.0/ or send a letter to +* Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. +* +* By using Ashita, you agree to the above license and its terms. +* +* Attribution - You must give appropriate credit, provide a link to the license and indicate if changes were +* made. You must do so in any reasonable manner, but not in any way that suggests the licensor +* endorses you or your use. +* +* Non-Commercial - You may not use the material (Ashita) for commercial purposes. +* +* No-Derivatives - If you remix, transform, or build upon the material (Ashita), you may not distribute the +* modified material. You are, however, allowed to submit the modified works back to the original +* Ashita project in attempt to have it added to the original project. +* +* You may not apply legal terms or technological measures that legally restrict others +* from doing anything the license permits. +* +* No warranties are given. +]]-- + +_addon.author = 'atom0s'; +_addon.name = 'blusets'; +_addon.version = '3.0.0'; + +require 'common' +blu = require 'bluemage' + +---------------------------------------------------------------------------------------------------- +-- func: print_help +-- desc: Displays a help block for proper command usage. +---------------------------------------------------------------------------------------------------- +local function print_help(cmd, help) + -- Print the invalid format header.. + print('\31\200[\31\05' .. _addon.name .. '\31\200]\30\01 ' .. '\30\68Invalid format for command:\30\02 ' .. cmd .. '\30\01'); + + -- Loop and print the help commands.. + for k, v in pairs(help) do + print('\31\200[\31\05' .. _addon.name .. '\31\200]\30\01 ' .. '\30\68Syntax:\30\02 ' .. v[1] .. '\30\71 ' .. v[2]); + end +end + +---------------------------------------------------------------------------------------------------- +-- func: load +-- desc: Event called when the addon is being loaded. +---------------------------------------------------------------------------------------------------- +ashita.register_event('load', function() + -- Initialize the Blue Mage library.. + if (blu.initialize() == false) then + err('Failed to initialize required library.'); + return; + end +end); + +---------------------------------------------------------------------------------------------------- +-- func: render +-- desc: Event called when the addon is being rendered. +---------------------------------------------------------------------------------------------------- +ashita.register_event('render', function() + -- Process the blue packet queue.. + blu.process_queue(); +end); + +---------------------------------------------------------------------------------------------------- +-- func: command +-- desc: Event called when a command was entered. +---------------------------------------------------------------------------------------------------- +ashita.register_event('command', function(command, ntype) + -- Get the command arguments.. + local args = command:args(); + local commands = { '/blusets', '/bluesets', '/bluset', '/blueset', '/bs' }; + + -- Ensure this is a valid command this addon should handle.. + if (table.hasvalue(commands, args[1]) == false) then + return false; + end + + -- List - Lists all available saved sets. + ---------------------------------------------------------------------------------------------------- + if (#args >= 2 and args[2] == 'list') then + local files = ashita.file.get_dir(_addon.path .. '/sets/', '*.txt', false); + if (files ~= nil and #files > 0) then + for _, v in pairs(files) do + msg('Found spell set file: \31\04' .. v:gsub('.txt', '')); + end + else + msg('No saved spell sets found.'); + end + return true; + end + + -- Load - Loads a saved spell list from disk. + ---------------------------------------------------------------------------------------------------- + if (#args >= 3 and args[2] == 'load') then + local name = command:gsub('([\/%w]+) ', '', 2):trim(); + if (name:endswith('.txt') == false) then + name = name .. '.txt'; + end + + if (ashita.file.file_exists(_addon.path .. '/sets/' .. name) == false) then + msg('Cannot load spell list, file does not exist: \31\04' .. name); + return true; + end + + blu.reset_all_spells(); + + local data = ashita.settings.load(_addon.path .. '/sets/' .. name); + for k, v in pairs(data) do + blu.set_spell_by_name(v, k); + end + + msg('Loaded blue spell set: \31\04' .. name); + return true; + end + + -- Save - Saves a saved spell list to disk. + ---------------------------------------------------------------------------------------------------- + if (#args >= 3 and args[2] == 'save') then + local name = command:gsub('([\/%w]+) ', '', 2):trim(); + if (name:endswith('.txt') == false) then + name = name .. '.txt'; + end + + local spells = blu.get_spell_names(); + local data = ashita.settings.JSON:encode_pretty(spells, nil, { pretty = true, align_keys = false, indent = ' ' }); + + ashita.file.create_dir(_addon.path .. '/sets/'); + + local f = io.open(_addon.path .. '/sets/' .. name, 'w'); + if (f == nil) then + err('Failed to save blue spell set.'); + return true; + end + + f:write(data); + f:close(); + + msg('Saved blue spell set: \31\04' .. name); + return true; + end + + -- Delete - Deletes a saved spell list from disk. + ---------------------------------------------------------------------------------------------------- + if (#args >= 3 and args[2] == 'delete') then + local name = command:gsub('([\/%w]+) ', '', 2):trim(); + if (name:endswith('.txt') == false) then + name = name .. '.txt'; + end + + if (ashita.file.file_exists(_addon.path .. '/sets/' .. name) == false) then + msg('Cannot delete spell list, file does not exist: \31\04' .. name); + return true; + end + + os.remove(_addon.path .. '/sets/' .. name); + msg('Deleted blue spell set: \31\04' .. name); + return true; + end + + -- Unset - Unsets all currently set spells. + ---------------------------------------------------------------------------------------------------- + if (#args >= 2 and args[2] == 'unset') then + blu.reset_all_spells(); + msg('Unset all current blue spells.'); + return true; + end + + -- Set - Sets a blue spell. + ---------------------------------------------------------------------------------------------------- + if (#args >= 4 and args[2] == 'set') then + local index = tonumber(args[3]); + if (index <= 0 or index > 20) then + err('Invalid spell index; must be 1 to 20.'); + return true; + end + + local spell = tonumber(args[4]); + if (spell == nil or spell < 512 and spell ~= 0) then + err('Invalid spell id, blue spells start at id 512.'); + return true; + end + + blu.set_spell(spell, index); + return true; + end + + -- Prints the addon help.. + print_help('/blusets', { + { '/blusets list', '- Lists all the known sets saved to disk.' }, + { '/blusets load [name]', '- Loads a blue magic spell set from the given file name.' }, + { '/blusets save [name]', '- Saves the current set blue magic spells to the given file name.' }, + { '/blusets delete [name]', '- Deletes the given saved blue magic spell set.' }, + { '/blusets unset', '- Unsets all current set blue magic spells.' }, + { '/blusets set [index] [spellid]', '- Sets a blue magic spell to the given index.' }, + }); + return true; +end); \ No newline at end of file