Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Reetus/ClassicAssist

Assistant for ClassicUO with UOSteam-like interface and macro syntax.
https://github.com/Reetus/ClassicAssist

Last synced: 3 months ago
JSON representation

Assistant for ClassicUO with UOSteam-like interface and macro syntax.

Awesome Lists containing this project

README

        

![Build status](https://github.com/Reetus/ClassicAssist/actions/workflows/release.yaml/badge.svg)

# ClassicAssist

Assistant for [ClassicUO](https://github.com/andreakarasho/ClassicUO) with UOSteam-like interface and macro syntax.

![hotkeys](https://github.com/Reetus/ClassicAssist/assets/6239195/b40e8e20-c097-48e6-8447-a1ca35114860)

## Installation

Add the full path to ClassicAssist.dll to the plugin section of the ClassicUO settings.json config file.

Alternatively, use ClassicAssist.Launcher.exe and it will launch ClassicUO with the required path to the plugin.

[Installation Video](https://www.youtube.com/watch?v=SQ5QhR1TS1U&feature=youtu.be)

## Macros

Macros have similar function names as UOSteam but uses Python as the language, to learn the language syntax, refer to Python beginner guides on the internet such as [https://stackabuse.com/python-tutorial-for-absolute-beginners/](https://stackabuse.com/python-tutorial-for-absolute-beginners/)

![assist2](https://user-images.githubusercontent.com/6239195/73602829-d8166e80-45b4-11ea-8132-61c29fce3862.png)

## Compatibility

ClassicAssist uses [WPF](https://en.wikipedia.org/wiki/Windows_Presentation_Foundation) as the UI framework which is only compatible with Windows.

## Linux / MacOS

There has been some effort to port ClassicAssist to Avalonia, but this requires more development effort, if you are a developer and want to contribute, please see [ClassicAssist.Avalonia](https://github.com/Reetus/ClassicAssist.Avalonia)

## Community

Join our discord channel on the official ClassicUO discord server [here](https://discord.gg/DKgfjMqH)

## Issues / Feature Requests

If you encounter any issues or require a feature not currently added, please raise an issue on GitHub with as much information as possible.

## Documentation

Full documentation is still a work-in-progress but documentation on Macro Commands can be found here... [Macro Commands](https://github.com/Reetus/ClassicAssist/wiki/Macro-Commands)

## Translation

If your native language isn't English and you'd like to contribute a translation into your language, send a pull request or open an issue.

![korean](https://github.com/Reetus/ClassicAssist/assets/6239195/409bd5e8-8d76-4755-8402-5351b4d0d498)

Existing supported languages can be edited on POEditor
* [UI](https://poeditor.com/join/project/64bC3Q4fdt)
* [Macros](https://poeditor.com/projects/view?id=671853)

## License

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see .

## Credits

Icons made by [FreePik](https://www.flaticon.com/authors/freepik) from [FlatIcon](https://www.flaticon.com/)

Icons made by [SmashIcons](https://www.flaticon.com/authors/smashicons) from [FlatIcon](https://www.flaticon.com/)