https://github.com/cbartram/spark
Open source automation and reverse engineering library for Runescape.
https://github.com/cbartram/spark
Last synced: 10 months ago
JSON representation
Open source automation and reverse engineering library for Runescape.
- Host: GitHub
- URL: https://github.com/cbartram/spark
- Owner: cbartram
- License: mit
- Created: 2018-01-11T14:54:47.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-09-08T13:52:53.000Z (almost 6 years ago)
- Last Synced: 2025-01-17T09:45:38.486Z (over 1 year ago)
- Language: Java
- Size: 5.96 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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](https://gradle.org/). You can install Java with [Homebrew](https://brew.sh)
using the following command:
```shell script
$ 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](https://gradle.org)
with [Homebrew](https://brew.sh)
```shell script
$ brew install gradle
```
### Building the Project
To build the project run:
```shell script
$ gradle build
```
## Usage
To use spark simply
```java
class Main {
public static void main(String[] args) {
System.out.println("TODO");
}
}
```
## Running Tests
To run the unit tests simply run:
```shell script
$ 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](https://github.com/cbartram/spark/master/blob/LICENSE.txt/)
## Acknowledgements
- **ASM** For making a great Bytecode manipulation library