README.md

Spark

Spark is an open source automation framework for modifying and retrieving values in an Old School RuneScape Client. This library can be used to reverse engineer the Runescape client or serve as a foundation to creating a Bot or Enhanced Client.

Installation

This project uses Java 8 and is built with Gradle. You can install Java with Homebrew using the following command:

$ brew cask install java
$ brew tap adoptopenjdk/openjdk
$ brew cask install adoptopenjdk8

In order to download and add the necessary dependencies to the classpath you should install Gradle with Homebrew

$ brew install gradle

Building the Project

To build the project run:

$ gradle build

Usage

To use spark simply

class Main {
public static void main(String[] args) {
        System.out.println("TODO");
    }
    
}

Running Tests

To run the unit tests simply run:

$ gradle test

Integration Tests

This section will be filled out at a later date.

Performance Tests

This section will be filled out at a later date.

Deploying

This section will be filled out at a later date.

Built With

Spark was built with the following tools!

• Java 8 - Programming Language Used
• Gradle - Build tool and dependency management
• ASM - Bytecode Manipulation Library

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

Acknowledgements

• ASM For making a great Bytecode manipulation library