Wingman is an open source Oldschool RuneScape client.
Here are some of the features Wingman has to offer:
- Secure and respects your privacy
- Anyone can review the code
- Plugin support
- Very fast and efficient game API
- Easy-to-use event listener system
- Supports JARed plugins
- Sidebars and settings screen
- Entries easily insertable by plugins
- Allows any content, but a design helper API exists
- Ability to add/remove game code using ASM
- Add powerful event callbacks
- Customize your gameplay
- And lots more..
If you like your Wingman kept up to date, consider using the launcher which downloads the latest Wingman release and sets you up with a few default plugins. The plugins are carefully chosen and are easy to disable.
The plugin loader attempts to find and register all @Plugin annotated classes visible by the class loader. The class loader knows of all files in the client + user.home/Wingman/plugins.
More information is available on the wiki.
Wingman uses Gradle for dependency management and building. Building from your own PC is really simple.
The project uses the us.kirchmeier.capsule plugin for packing the source and dependencies into a fully runnable JAR. Try this code to generate Wingman-capsule.jar*, which will reside in /build/libs:
gradlew fatCapsule
In order to build the project without dependencies, you can replace gradle fatCapsule with gradle build, as shown below.
gradlew build
(*Note that Wingman-capsule.jar is named Wingman.jar in the releases.)
The versions of releases consist of three parts delimited by a dot:
- The current major version (incremented with big changes)
- The current OSRS gamepack revision
- The current minor release version (starts at 0 for each gamepack revision)
The client version is displayed in the title of the client. It is by default "Developer" if you have compiled the client yourself.
Contributing to the development of the client can be done by forking the project, making a change and then creating a pull request. You are also highly welcome to submit a new issue when something has gone wrong or when you want to suggest a new feature.