User Tools

Site Tools


kipc

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
kipc [2021/11/15 00:19] – kitanoikipc [2021/11/22 15:49] (current) – kitanoi
Line 2: Line 2:
  
 ====What is it?==== ====What is it?====
-An addon that can send functions to all FFXIV windows running on the same computer.+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.
  
-===How?=== +<WRAP center round important 60%> 
-Using Minions shortcut system, you can add code such as:+Untested on KR due to not being able to create accounts. 
 +</WRAP> 
 + 
 +<WRAP center round important 60%> 
 +Use the 2 day trial before you purchase. 
 +</WRAP> 
 + 
 + 
 + 
 +====How?==== 
 +Floating Buttons or using Minions shortcut system, you can add code such as:
 <code> <code>
 kIPC.Send(who[str], command[str], delay[bool][optional], delaytimer[int][optional]) kIPC.Send(who[str], command[str], delay[bool][optional], delaytimer[int][optional])
  
  
-kIPC.Send("all", 'd("Hello World")') +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('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")')
 kIPC.Send("Char Name@Server", 'd("Hello Char Name")') kIPC.Send("Char Name@Server", 'd("Hello Char Name")')
Line 28: Line 38:
 If you are sending a string inside of the function, encase the function in ', and the string in " If you are sending a string inside of the function, encase the function in ', and the string in "
  
-  * Correct : <color #22b14c>kIPC.Send("all",'AddonName.SendString("string")')</color> +  * Correct : <color #22b14c>kIPC.Send('all','AddonName.SendString("string")')</color> 
-  * Incorrect : <color #ed1c24>kIPC.Send("all","AddonName.SendString('string')")</color>+  * Incorrect : <color #ed1c24>kIPC.Send('all',"AddonName.SendString('string')")</color>
  
 ==Example== ==Example==
Line 35: Line 45:
  
  
-===UI===+====UI====
  
 {{:kitanoi:ui_ipc_new_1.png?nolink|}} {{:kitanoi:ui_ipc_new_1.png?nolink|}}
Line 49: Line 59:
   - Save Functions needs to be pressed after each edit you make to update the buttons.   - Save Functions needs to be pressed after each edit you make to update the buttons.
   - Counter to change how many buttons are shown on each line at the bottom of the UI.   - 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. +  - 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 *+  - Free button that can be placed anywhere on your screen. Need to add local floatingbutton = true inside the function. See *
  
-===Built In Functions===+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 
 + 
 +{{:kitanoi:kipc-funcs.png?nolink|}} 
 + 
 +Floating Buttons: 
 + 
 +{{:kitanoi:floatingbuttons.png?nolink|}} 
 + 
 +{{:kitanoi:floatingbuttonscolors.png?nolink|}} 
 + 
 +====Built In Functions====
  
 -Move To Closest Inn-  -Move To Closest Inn- 
-<code>kIPC.Send("all","kIPC.MoveToInn()")</code>+<code>kIPC.Send('all',"kIPC.MoveToInn()")</code> 
 +------------------------------------------------------- 
 +-Move To Grand Company Barracks- 
 +<code>kIPC.MoveToSquadronBase()</code> 
 +------------------------------------------------------- 
 +-Move To Zone and Coordinates- 
 +<code>kIPC.MoveTo(x,y,z,mapid)</code> 
 +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. 
 +<code>kIPC.Send('all','kIPC.WorldHop("Sargatanas")') 
 + 
 +kIPC.Send('thischarSomeWorld','kIPC.WorldHop("Return Home")') 
 +</code>
 ------------------------------------------------------- -------------------------------------------------------
 -Reload LUA- -Reload LUA-
-<code>kIPC.Send("all","Reload()",true,2000)</code>+<code>kIPC.Send('all',"Reload()",true,2000)</code>
 ------------------------------------------------------- -------------------------------------------------------
 -Shutdown all clients and MinionApp- -Shutdown all clients and MinionApp-
-<code>kIPC.Send("all","kIPC.Shutdown()")</code>+<code>kIPC.Send('all',"kIPC.Shutdown()")</code>
 This uses powershell to kill clients and minionapp This uses powershell to kill clients and minionapp
 ------------------------------------------------------- -------------------------------------------------------
 -Toggle Rendering- -Toggle Rendering-
-<code>kIPC.Send("all","Hacks:Disable3DRendering(not gDisableDrawing) gDisableDrawing=not gDisableDrawing")</code>+<code>kIPC.Send('all',"Hacks:Disable3DRendering(not gDisableDrawing) gDisableDrawing=not gDisableDrawing")</code>
 ------------------------------------------------------- -------------------------------------------------------
 -Toggle Minion- -Toggle Minion-
-<code>kIPC.Send("all","ml_global_information.ToggleRun()")</code>+<code>kIPC.Send('all',"ml_global_information.ToggleRun()")</code>
 ------------------------------------------------------- -------------------------------------------------------
 -Set Bot Mode- -Set Bot Mode-
-<code>kIPC.Send("all",'kIPC.SetMinionMode("mode[str]")')</code>+<code>kIPC.Send('all','kIPC.SetMinionMode("mode[str]")')</code>
 mode is case dependent, "Assist", not "assist". "Grind", not "grind" etc mode is case dependent, "Assist", not "assist". "Grind", not "grind" etc
 ------------------------------------------------------- -------------------------------------------------------
 -Open KitanoiFuncs tabs- -Open KitanoiFuncs tabs-
-<code>kIPC.Send("all",'KitanoiFuncs.OpenTab("dungeon framework")')</code>+<code>kIPC.Send('all','KitanoiFuncs.OpenTab("dungeon framework")')</code>
 case irrelevant - same name as the tab shows. Not sure how client language will affect it. case irrelevant - same name as the tab shows. Not sure how client language will affect it.
 ------------------------------------------------------- -------------------------------------------------------
Line 81: Line 126:
 <code>KitanoiFuncs.EnableAddon(name[str],setas[bool])</code> <code>KitanoiFuncs.EnableAddon(name[str],setas[bool])</code>
     --names - dungeon framework, usp dungeons, usp tank, usp pony, usp lanner, treasure hunt, party follow, light farm, rathalos farm,      --names - dungeon framework, usp dungeons, usp tank, usp pony, usp lanner, treasure hunt, party follow, light farm, rathalos farm, 
-<code>kIPC.Send("all",'KitanoiFuncs.EnableAddon("party follow",true)')</code>+<code>kIPC.Send('all','KitanoiFuncs.EnableAddon("party follow",true)')</code>
 ------------------------------------------------------- -------------------------------------------------------
 -Use Items- -Use Items-
Line 92: Line 137:
 This will stop the loop. This will stop the loop.
 ------------------------------------------------------- -------------------------------------------------------
-===Limitations===+====Limitations====
   * It only works when you are running the characters on the same computer.   * 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.   * Requests are not queued. There is no buffer. It stores the last request until it is complete then removes the request.
  
-===Requirements===+====Requirements====
   * KitanoiFuncs - free on store.   * KitanoiFuncs - free on store.
   * A Minion settings profile correctly created for each character that you use.   * A Minion settings profile correctly created for each character that you use.
 +
 +====Issues====
 +
 +Any errors in the console, first try entering the following:
 +<code>
 +Settings.kIPC.TableCreated = false
 +</code>
 +Reload lua, and press the [Run Set Up] button.
 +
 +Failing this, you can run the following in the console to force create a record:
 +<code>
 +kIPC.CreateRecord()
 +</code>
 +
 +====Help and Requests====
 +
 +For further help, or to make function requests, please use Discord.
 +
 +Discord: https://discord.gg/EzpG9zsbAH
 +
  
kipc.1636935598.txt.gz · Last modified: 2021/11/15 00:19 by kitanoi

Page Tools