User Tools

Site Tools



kipc

kIPC

What is it?

An addon that can send functions to all FFXIV windows running on the same computer. It is designed for multiboxers and people who only use one character will have no use for this.

Untested on KR due to not being able to create accounts.

Use the 2 day trial before you purchase.

How?

Floating Buttons or using Minions shortcut system, you can add code such as:

kIPC.Send(who[str], command[str], delay[bool][optional], delaytimer[int][optional])


kIPC.Send('all', 'd("Hello World")')
kIPC.Send('all', 'd("Hello")', true, 3000) -- each character will put hello in the console with a 3 second delay between each.
kIPC.Send("Char Name Server", 'd("Hello Char Name")')
kIPC.Send("Char Name@Server", 'd("Hello Char Name")')
who
  1. all - Sends to all characters and will be processed by all characters that have the addon enabled
  2. specific name - will only send to that character - This must be formatted in as: firstname secondname server - any case, punctuation is optional as I remove it
command

Any command that you can run in the console can be passed here. Must either pass a function of equivalency statement.

  • 'd(“Hello Char Name”)'
  • MyAddonName.Enable = true
  • MyAddonName.FunctionName()

If you are sending a string inside of the function, encase the function in ', and the string in “

  • Correct : kIPC.Send('all','AddonName.SendString(“string”)')
  • Incorrect : kIPC.Send('all',”AddonName.SendString('string')“)
Example

UI

  • First image's UI will show each time you log in on a new character (Settings profile) - click the [Run Set Up] button
  • Second image's UI will show after you have clicked [Run Set Up]
  1. Enable - Enables the addon to recieve requests. This does not need to be enabled to send requests.
  2. Pulse timer is set to 1000ms (1s) by default. The slider accepts 250 - 15000ms. The upper limit is there due to commands only being processed if they are less than 30 seconds old.
  3. Code Editor to create your functions - each function is self contained and cannot see the other functions in the code editor. If you are wanting one function to call multiple functions you'll need to use your own library addon to hold them.
  4. Save Functions needs to be pressed after each edit you make to update the buttons.
  5. Counter to change how many buttons are shown on each line at the bottom of the UI.
  6. Button for each of your functions in #3. The name on the button matches the name of the function.
  7. Free button that can be placed anywhere on your screen. Need to add local floatingbutton = true inside the function. See *

If you have the quick toggles interface open in KitanoiFuncs. You will see the addition of an 'E' and 'IV' text after the FPS.

Clicking this 'E' or 'IV' will toggle the kIPC UI's visibility.

These indicate status of kIPC.

  • E - Enabled
  • IV - Init or Verification. This happens every 30 seconds to verify the connection.

When logging in, this IV status can remain for around 30 seconds. Once it completes for the first time you will see in the console:

[Kitanoi Functions] - [IPC] - Adding Character Record

Floating Buttons:

Built In Functions

-Move To Closest Inn-

kIPC.Send('all',"kIPC.MoveToInn()")

-Move To Grand Company Barracks-

kIPC.MoveToSquadronBase()

-Move To Zone and Coordinates-

kIPC.MoveTo(x,y,z,mapid)

This will use Minions navigation system to move you to the zone you specify and to a randomized position within 5 yalms of the specified xyz you provide.


-World Hopper Integration-

World Hopper UI is changed when this addon is installed. It adds an [All] button next to each world which you can click to send all accounts to that world.

kIPC.Send('all','kIPC.WorldHop("Sargatanas")')

kIPC.Send('thischarSomeWorld','kIPC.WorldHop("Return Home")')

-Reload LUA-

kIPC.Send('all',"Reload()",true,2000)

-Shutdown all clients and MinionApp-

kIPC.Send('all',"kIPC.Shutdown()")

This uses powershell to kill clients and minionapp


-Toggle Rendering-

kIPC.Send('all',"Hacks:Disable3DRendering(not gDisableDrawing) gDisableDrawing=not gDisableDrawing")

-Toggle Minion-

kIPC.Send('all',"ml_global_information.ToggleRun()")

-Set Bot Mode-

kIPC.Send('all','kIPC.SetMinionMode("mode[str]")')

mode is case dependent, “Assist”, not “assist”. “Grind”, not “grind” etc


-Open KitanoiFuncs tabs-

kIPC.Send('all','KitanoiFuncs.OpenTab("dungeon framework")')

case irrelevant - same name as the tab shows. Not sure how client language will affect it.


-Start/Stop my addons-

KitanoiFuncs.EnableAddon(name[str],setas[bool])
  1. -names - dungeon framework, usp dungeons, usp tank, usp pony, usp lanner, treasure hunt, party follow, light farm, rathalos farm,
kIPC.Send('all','KitanoiFuncs.EnableAddon("party follow",true)')

-Use Items-

kIPC.Use("MGP Platinum Card")

Name must match the name exactly (case irrevelant). EN/FR/DE/CN/KR all work

It will continue looping until you don't have any more of the items.

kIPC.Use("stop")

This will stop the loop.


Limitations

  • It only works when you are running the characters on the same computer.
  • Requests are not queued. There is no buffer. It stores the last request until it is complete then removes the request.

Requirements

  • KitanoiFuncs - free on store.
  • A Minion settings profile correctly created for each character that you use.

Issues

Any errors in the console, first try entering the following:

Settings.kIPC.TableCreated = false

Reload lua, and press the [Run Set Up] button.

Failing this, you can run the following in the console to force create a record:

kIPC.CreateRecord()

Help and Requests

For further help, or to make function requests, please use Discord.

Discord: https://discord.gg/EzpG9zsbAH

kipc.txt · Last modified: 2021/11/22 15:49 by kitanoi