TRiBot Script SDK Official Release

[Naton 1028]

We've heard your complaints - the TRiBot API could be much easier to use. We've been dedicating our time to improving the scripter experience here and spent the past year working on a new and improved API - the TRiBot Script SDK.

 

The TRiBot Script SDK is an easy-to-use library for building TRiBot scripts. It is the recommended approach to building scripts moving forward over the old TRiBot API. It contains all the core things you need to build a script, and a ton of additional helpful stuff to get you using your scripts quicker. See the documentation section for everything offered, and check out the brief overview link too.

 

The SDK was announced in preview here:

 

It is now officially released. The official release guarantees we will support backwards compatibility for some period of time. See the 'backwards compatibility' section below for more info.

 

How to use:

There is multiple options, listed in the order they are recommended.

1) Use the gradle template mentioned below

2) Obtain through gradle

Add this dependency: api("org.tribot:tribot-script-sdk:+")

Add this repository: maven("https://gitlab.com/api/v4/projects/20741387/packages/maven")

3) Take from your local filesystem in your .tribot/install folder. For example, on windows, you'd find it at "C:\Users\[user]\AppData\Roaming\.tribot\install\tribot-client\lib\tribot-script-sdk-[version].jar"

 

Documentation:

Java docs: https://runeautomation.com/docs/sdk/javadocs/index.html?overview-summary.html

Kotlin docs: https://runeautomation.com/docs/sdk/kdocs/index.html

 

Backwards compatibility:

We will be following a deprecation schedule whenever we perform a possible breaking change. We will deprecate the respective methods or classes and announce it in a topic. It will remain deprecated for some period of time (weeks or months), and then removed. This will give you time to fix anything, if we need to make a breaking change.

 

Gradle template:

Easily build scripts with a new pre-configured scripting gradle template

 

Users of the current API:

There is no plans to remove the TRiBot API. It will still be available. However, non-critical bugs probably won't be fixed. The SDK does depend on some of the API so fixing some things in the SDK will indirectly fix the API. However, bugs that have existed in the API for awhile will likely not be fixed. It's recommended to use the SDK moving forward. Let us know if there's something the SDK is missing.

 

Brief overview of the changes:

 

Bug reports:

Post bug reports in the bug reports section of the forums

 

 

Let us know what your thoughts are! If you have questions, feel free to ask below or in discord.

 

Edited May 19, 2022 by Naton