uoinfusion / infusion

Ultima Online assistant similar to Injection or Razor or Phoenix focused on easy scripting in C# and Yoko Injection script. Compatible with classic client, CrossUO and OrionUO.

Infusion

Infusion is an Ultima Online assistant similar to Injection. Infusion focuses on powerful and easy scripting features. You can write scripts in C# using either built in code editor that has source code highlighting, auto-complete and REPL (Read Eval Print Loop) which makes getting started with script authoring much easier.

Infusion supports all clients - write your scripts once and run them on official client or on CrossUO/OrionUO/ClassicUO. You don't need to rewrite them if you want switch your client.

If you are not familiar with programming you can start using example scripts which covers many repetitive task in the game. They are designed to be easy to use and they guide you through a configuration process. You don't need to change any code to start using them.

You can use Visual Studio or Visual Studio Code if you are a skilled developer and you want to enjoy their excellent refactoring and debugging capabilities.

Yoko Injection Scripts

Infusion can interpret Yoko Injection scripts. To get started, watch a video how to push a button on a gump from Yoko Injection Script.

If you want make writing Yoko Injection scripts a lot easier, you can install Injection script extension for Visual Studio Code.

Have you ever scratch your head because of "impossible" bugs? Make your live easier and debug your scripts directly from Infusion - watch a video how to do that.

If you find any missing feature or API, please create an issue here on Github.

Getting Started with C# Scripts

• Read Getting Started.
• If you know Injection, take a look to a brief comparison with Infusion.
• Look at example scripts.

You may take a look at some videos:

• Debugging scripts with Visual Studio 2017 Community edition
• Using Hotride/UOPatcher to enable FPS patch

Current C# API is in alpha release. It means that APIs are not stable yet and there may be some breaking changes.

Client support

Infusion works with official clients and CrossUO/OrionUO/ClassicUO. Infusion supports encryption and is able to connect to OSI servers.

Please, create an issue if you find any bug, missing feature or server/client combination that doesn't work for you.

UOErebor

We develop, test and regularly use Infusion in game on highly customized shard UOErebor (Czech only). Which means that Infusion is pretty stable on this shard and there is a lot of example scripts you can immediately start using:

• Display status bar of your friends in an external window. These status bars never disappear so you always see how many HP your friends have.
• Hiding with always walk feature to utilize stealth.
• Targeting red karma only, skipping own summon/pets.
• Fast and reliable walking from script.
• Read status of spell chargers from script.
• Damage notification.
• Show experience in game window title.
• Open bank using banker or house menu.
• Using travel stones.
• Filtering sounds, overall light and weather effect.
• Looting.
• Chasing and shaving sheep.
• Easier item manipulation (moving food/regs only, moving the same type).
• Predefined names for many item types/color combinations (spell scrolls, food, regs, tools, resources, doors and many others).
• Popular UO client patches (like FPS patch) using UOPatcher.

infusion's Issues

Macro for tracking (UOErebor)

Do not display password on launcher dialog and store it securely

Shame, shame on me, that it is still not implemented.

Help display commands with and without documentation separately

Undocumented commands should be displayed on one line so documented commands are more visible and undocumented commands doesn't take so much vertical space in console.

Do not turn on TwoStateAbility with low stamina

Update to most up to date version of RoslynPad

Main point of updating is to get line numbers in stack trace from scripts.

Ripping ignores specific corpse types

To avoid ripping mount bodies, otherwise they cannot be resurrected and tamed again.

Add search to ,help command

If ,help cannot find the specified command, it should list all commands containing specified text in their name.

Filter cancelling WaitTargetObject when client requests skill/spell/use

If a script calls WaitTargetObject, but server doesn't request a target for some reason, then WaitTargetObject sends the target to server even when user does a targeted action. Example (UOErebor)

1. Healing calls WaitTargetObject(UO.Me); and uses bandages.
2. A player doesn't have any clean bandages so server never asks for a target.
3. The player casts a spell and WaitTargetObject kicks in - targets the player.

Script must handle these cases but Injection could be a little bit more safe.

The filter prohibits conscious use of this behavior - it could be supported by a new argument of WaitTargetObject (filter on/filtr off).

Track and expose item flags

http://docs.polserver.com/packets/index.php?Packet=0x1A

Wear off potion countdown

Initial script for each profession

Unregister commands when reloading

Wrong handling of already logged in character

If player logs out, his/her character stays in game a little while. If user relogs, then it is not required to select a character. Infusion doesn't handle this case well and (at least) Sphere closes the network connection.

Reimplement "always walk" feature by filtering walk request packets

Example script implements "always walk" feature by using stamina filter. If you turn on "always walk" then the stamina filter sets stamina to 1 on a client and the client tries to walk then. This is kind of a hack and is it is not very reliable. Stamina is not always restored after turning off "always walk".

Do not put back duplicate command when picking the last command from history

Publish skill changed event

It would be nice to make the notification message more visible in Infusion console - e.g. use the same color as client by default does. Still it must be written to log file as well.

The benefit is also that the message will not be part of LegacyApi.

Move wiki source to the main repository

Possible race condition in WaitForItemDragged

Layer is not updated when item is dragged

1. Equip an item to hand.
2. Check that the item is on appropriate layer.
3. Drag the item and check the layer again.

Expected result is that the item has no layer, currently it is on the original layer.

Maybe there are more cases when the layer is not properly updated.

Remove Refresh from GameObjectCollections

Refresh usage can lead to many problems and it is difficult to use properly.

For example you track a monster. If the monster disappears from view, then Refresh returns null and you loose your mobile reference including its id. It is better to maintain id and lookup the mobile directly. The problem is related to the immutable game objects model.

The benefits of immutable model seems to be still strong enough to keep them despite the fact that the programming model is somehow different than in Injection.

Just remove the Refresh method before RC, it can be reintroduced later.

Cannot start script from editor (F5) when the file is not saved on disk yet

Autoclose tracking dialog after specified period when opened from tracking.csx script

Wrong names for GumpInstanceId na GumpId

Semantic is opposite.

General summon support

Installer

Create an installer to install Infusion to Program Files and creates folders in user's home folder for scripts and logs, so it is easy for not experienced users to not mix executable files with files requiring modifications.

Is it possible to track corpse type?

The problem is that all corpses have the same type (0x2006), so you cannot say what the corpse belongs to. Maybe you don't want to loot bodies of other players. Or on UOErebor you don't want to rip a body of mustang, otherwise you would not be able to resurrect him.

You can use the name of the body for this but you have to click the body first. The client needs to know the corpse type to display it properly.

Packet 0xAF (Display Death Action) provides a link between mobile and corpse.

The question is: how client does know how to display a corpse and is it possible to access this information from a script?

Taking screenshots

Rename SpeechAwaiter to SpeechJournalAwaiter

Startup.RegisterStartupCommand starts background commands as normal command

Startup.RegisterStartupCommand should start background commands as background commands.

Console sends speech request with empty text after enter on empty console line

Remember and restore position/size of console window

Looting ignores invisible items

#27 must be implemented first.

Phantom script cannot load phantom location with negative z coordinate

High CPU usage after loosing client connection

Clean-up login.cfg and uo.cfg after launching Infusion

Infusion uses login.cfg and uo.cfg to pass proxy url and user name/password to Ultima Online client. It makes harder to use simultaneously Infusion with Injection or similar tools. Insution uninstalation is more difficult also.

Two Infusion instances writing to the same log/packet file concurrently

How is it handled? Only one instance should be allowed to write to a log/packet file.

Move Infusion.Configuration to Infusion.Legacy

Injection like FPS patch

Command started from startup script is not in command list and can be started again

It means that it is possible to run a command twice in parallel. That is not allowed.

Consider InContainer/UseType to look into subcontainers by default

Current behavior is anti-intuitive and asymmetrical to InBackPack/InBankBox methods.

Potentially breaking change. Has to be solved before RC.

Potion cooldown counter

The basic script is already there, but it needs to be finished, polished and tested.

Currently it detects only usage of specific potion bottle, but more common way is to invoke .potionheal, .potioninvis and so on commands.

potions.csx

"Unknown skill text: 0 0" exception when using LastSkill macro after login

Infusion.Packets.PacketMaterializationException: Packet id = 18 ---> System.NotImplementedException: Unknown skill text: 0 0
   v Infusion.Packets.Client.SkillRequest.Deserialize(Packet rawPacket) v c:\Users\jakub\sources\ultima\Infusion\src\Infusion\Packets\Client\SkillRequest.cs:řádek 184

Race condition in SpeechJournalAwaiter/EventJournalAwaiter

If an message/event arrives after awaiter processes "after last action" entries but before starts waiting for entryReceivedEvent then the message/event is ignored. Awaiter has to have a queue of incomming events.

Move text filters out of Infusion project

Not sure where is the best place for it. Maybe it should be part of LegacyApi, or just drop it.

Z coordinate of Location3D cannot be byte

Z coordinate can be negative - maybe just convert it to int.

Looting script doesn't detect 'Paralyze' effect

If player tries to rip a body before looting, then the script is stuck until timeout, because Sphere doesn't send any information when using an item (doubleclick, 0x06 packet) and player is paralyzed.

This problem could be mitigated by cancelling the script when server sends "You are frozen and can not move." and paralyzed player tries to move.

This is more general problem for all waits after doubleclicking any item.

Toaster notification doesn't work on W10

Use int where possible instead of uint and ushort.

It is less safe from UO protocol perspective, but it is much more convenient for scripting. See all these explicit casts for Locations.

How to automatically handle WaitTargetObject cancellation when server unexpectedly doesn't ask for target

On UOErebor: you are paralyzed or you don't have bandages for healing. How is it solved in Injection/Phoenix/Razor?

Consider using null pattern for GameObjects

So it is not necessary to check a GameObject for null when retrieving it from UO.Items/Mobiles/Corpses.

Something like this should be possible then:

if (UO.Items[myItemId].GetDistance(UO.Me) < 2)
if (UO.Items[myItemId].Exists)