Skip to main content

Getting Started

Octarine​

Octarine is a private cheat for Dota 2 that allows you to create your own scripts using a TypeScript API.

Getting Started​

warning

The documentation is written for people who know the basics of TypeScript / JavaScript and have practical experience. Please do not contact support with questions regarding the documentation, as they will remain unanswered.

If you have any questions about the API, please ask on our Discord server. There, you will receive answers directly from the cheat developers.

Preparation​

  1. Install NodeJS.
  2. Restart the Octarine Client.
  3. Enable developer mode on the website.
  4. Create the necessary folders as shown below:
disk or folder:
├── github.com
│   ├── octarine-public
│   └── your-login-github
  1. Clone the repository https://github.com/octarine-public/wrapper into the octarine-public folder.
  2. Make a copy of the repository https://github.com/octarine-public/example-repo and clone it into the your-login-github folder.
  3. Install yarn for both wrapper and example-repo:
yarn install

  1. Add the copy of "example-repo" to local scripts on the website, example link: https://github.com/qzore/example-repo@main

    To add a private repository, use a GitHub token, example link:
    https://qzore:ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx@github.com/qzore/example-repo@main

Afterwards, your folder structure should look like this:

disk or folder:
├─── github.com
│    ├── octarine-public
│    │   └── wrapper
│    └── qzore  
│        └── example-repo
│            ├── index.ts
│            └── other files and folders...
caution

Octarine and Dota 2 must be running for the following steps.

  1. To ensure everything is set up correctly and the script is installed, open the console. Enter chrome://inspect in the address bar and select Open dedicated DevTools for Node. Go to http://localhost:9222/json. Find "Main Worker" and click on devtoolsFrontendUrl.

    If everything is correct, you should see Hello World! and GameStarted when entering the map.

index.ts
import { EventsSDK } from "github.com/octarine-public/wrapper/index"

console.log("Hello World!")

EventsSDK.on("GameStarted", () => {
  console.log("GameStarted")
})
  1. To apply changes, commit and reload scripts. This can be done through the Octarine menu in-game: Settings -> Reload Scripts.

To receive notifications about available changes and know when to reload scripts, enable the Notifications -> Update Alerts option.

info

Examples of other scripts: https://github.com/octarine-public