Plug-in system for Latikai's client

[Kandarim]

What it's all about

I have extended my client with a plug-in system which should allow all of you to build your own plug-ins to hook into the client (to some extent).
They are accessible under the Xtended menu (originally implemented by Ender).

They are typically limited to one-shot actions, although I'm sure people will find a way to leverage it for more, hmm, long-term benefit. Regardless, I've decided that I will publish this anyhow. Those that want to can always build bots in a purely private client anyway.

Using plugins
This part is simple! You download the plug-in and place it in ~/Salem/plugins.
I am planning to maintain a list of plug-ins on this first post of which I have personally verified the source code (not guaranteeing that it will do what it says, but guaranteeing that it won't do anything nasty).

hello world pluginhttps://github.com/DonnEssime/SalemFuelPlugin/raw/master/dist/SalemFuelPlugin.jar

All this plugin does is print a "hello world"-like message to the system log of the client. Intended as the starting point for your own plug-ins.
Github page: https://github.com/DonnEssime/SampleSalemPlugin
Direct link: https://github.com/DonnEssime/DonnEssime.github.io/raw/master/Salem/plugins/SamplePlugin.jar

pickup plugin

Implemented by me, this plug-in will right click the nearest forageable item. Intended as an example of how to build a plug-in based on the example.
Github page: https://github.com/DonnEssime/SalemPickupPlugin
Direct link: https://github.com/DonnEssime/DonnEssime.github.io/raw/master/Salem/plugins/PickupPlugin.jar

seller plugin

Implemented by me, this plug-in will left click all of the items in your main inventory exactly once, one every 150 milliseconds. This should relieve your wrists without setting an awkward peak load on the server.
Github page: https://github.com/DonnEssime/StallSellerPlugin
Direct link: https://github.com/DonnEssime/StallSellerPlugin/raw/master/dist/StallSellerPlugin.jar

frog/small kritter plugin

Implemented by me, this plug-in will perform a single rightclick on the closest small kritter in your neighbourhood. Should help with tunnel vision issues.
Github page: https://github.com/DonnEssime/SalemFrogPlugin
Direct link: https://github.com/DonnEssime/SalemFrogPlugin/raw/master/dist/FrogPlugin.jar

fuel filler plugin

Implemented by Chrumps, this plug-in will perform 10 rightclicks on the closest object that requires fuel (think smelter/oven/brazier/torchpost/...).
You are responsible for having the right fuel on hand. Note that it uses forced shift-clicks, so don't have singing old logs in your inventory when fueling fires, and the like.

Github page: https://github.com/DonnEssime/SalemFuelPlugin
Direct link: https://github.com/DonnEssime/SalemFuelPlugin/raw/master/dist/SalemFuelPlugin.jar

distiller plugin

This plug-in will automatically empty and fill distillers in the alchemy table you have open.

Github page: https://github.com/DonnEssime/DistillerPlugin
Direct link: https://github.com/DonnEssime/DistillerPlugin/raw/master/dist/DistillerPlugin.jar

Creating your own plug-ins
I have tried to make this as painless as possible, but unfortunately there are quite a few steps involved.
You will find a comprehensive guide in the README of the PickupPlugin git repository.
I have (against better habits ) committed ALL of the changes from SampleSalemPlugin to SalemPickupPlugin in a single commit. You can view it here, to double check whether you have all changes. Everything is listed in the README, though.
Note that, through the "load" method, it is also possible for plug-ins to permanently influence client behaviour without ever being activated once.

Your turn
Now it's up to you!
Some extensions to my client I will make accessible as plug-ins rather than as full-fledged client extensions, depending on where they best fit. One hopeful dream is to, one day, have some kind of central plug-in list and a full updater GUI for both the client and any and all plug-ins you may enjoy. One day.

[nico54k9]

Awesome work Kandarim and a great idea.

I'd love to give it a go if i had the imagination to think of a plug in haha.
Still, hope to see some good ones from the public.

[Nsuidara]

@pickup plugin, how work ?
mean - is pick up (cheat) or other ?

[Kandarim]

you just press the button and it right clicks the closest item. You can find it, like any other plugins, under the XTended menu (with the timers and so on).

[Kralith]

Okay, this sounds very good.... but....

Whats the limits of this pluginsystem?
How we can prevent that this system will abused for fights, means too powerful plugins that is near to be cheating or botting?

Are there a implemented system that prevent some actions?

Okay, i have overseen the hiding text in first section. But still the questions stay the same.

[Kandarim]

Whats the limits of this pluginsystem?

Your imagination!

How we can prevent that this system will abused for fights, means too powerful plugins that is near to be cheating or botting?

We can't. But this is a void argument, because we can't stop the same from happening without the plug-in system: people that can/want to implement 'powerful plugins' can do so in their own private client too, anyhow.

Are there a implemented system that prevent some actions?

Such as? Plug-ins are mainly intended at one-shot actions (like the pick-up closest item). Permanent changes to the client are possible to some extent, but there aren't particularily many hooks in the client to make this easy.

[Forungi]

Great initiative Kandarim!

I'll make sure to dust off the old Java knowledge and make something useful.

[Heffernan]

great, hope this makes everything easier, not sure of someone working on similar stuff already but would someone make a script that whenever a private chat opens a prerecorded text is displayed to them? id pay fror such a thing.

[Darwoth]

and this is how pvp on most UO emulators got ruined overnight once everyone figured out how to make focus fire plug ins and started multiboxing 4 - 5 alts with a sync drop between them to one shot everyone. salem really needed this.

[Taipion]

For Eclipse:

- Create a new Java Project
- Get the project (as zip or what you prefer) from git
- Import the project as Archive File (zip) or Project (unpacked) into the project you just created
- right-click the build.xml (ant symbol) and run as / Ant build

In case it (ant) says your JAVA_HOME is pointing at a wrong direction, don't mess with your environmental variables, simply go to (in eclipse) windos/preferences/java/installed JREs replace the (probably) JRE there with a JDK.