Skip to content

Open-RSC/IdleRSC

Repository files navigation

idlersc logo

IdleRSC

openrsc badge

releases badge pipeline badge discord badge

openrsc wiki badge idlersc wiki badge idlersc api badge

IdleRSC is a bot for the OpenRSC coleslaw and uranium worlds that uses code injection and reflection. It has its own custom scripting API called IdleScript, as well as backwards compatibility with APOS and SBot scripts. It also provides staker bot functionality!

main window screenshot


Rules

DO NOT use this client to bot on non-botting servers.

The only allowed OpenRSC botting servers are Coleslaw and Uranium.

Using this client on disallowed OpenRSC servers will result in a BAN.


Requirements

Download and install Java 8 for your device.

Download the Open Runescape Classic Launcher.

Note: If you're still not able to run OpenRSC.jar after installing Java 8 try running jarfix.

You can also ask for help in the #setup-help or botting-client-development channels of the OpenRSC discord


Account Security

Please be aware that account property files are not encrypted.

If someone has your properties file, they have access to your account.

Don't run scripts from untrusted sources

Running a rogue .class file is akin to running a .exe file on your computer.

IF YOU DO NOT TRUST IT, READ THE SOURCE CODE BEFORE COMPILING IT!!!


Lost Items, Accounts, etc

Developers of IdleRSC and OpenRSC are not responsible for ruined, banned, hacked accounts, or anything else. ALWAYS use unique passwords for different services. All passwords are hashed and salted on server side for security purposes.


More Info

Commands and Shortcuts

In-Game Commands and Shortcuts

In-Game commands are typed into the game chat box.

help menu screenshot

CLI Startup Commands

Command Line Interface (CLI) commands can be included following a command line startup for example java -jar IdleRSC.jar, or added to the run_windows.bat or run_linux.sh script files that execute the same startup command.

 --auto-start - Auto start bot, bypassing Account Selection window
   Must include either:
     --account
     --username and --password
 --account <account> - Load from saved account
 --script-arguments <arguments> - pass arguments to the script (e.g. dragonstone)
 --auto-login - Enable automatic log-in with credentials (--username, --password)
 --debug - Enable debug logging
 --log-window - Display log window
 --disable-gfx - Disable graphics refresh
 --help - Show help menu (F12)
 --hide-side-panel - Hide side panel
 --init-cache <server> - Initialise cache for specified server (coleslaw|uranium)
 --interlace - Enable graphics interlacing
 --ocr-type <type> - Configure OCR sleeper (internal|remote|manual)
 --ocr-server <url> - OCR server URL for remote sleep solver
 --log-window - Display log window
 --script-name <name> - Name of the script to run
 --password <password> - Account password
 --script-selector - Display script selector window
 --username <username> - Account username
 --unstick - Unstick side panel from main window
 --version - Show version
 --attack-items <item1,item2> - stake switcher attack item swapping
 --defence-items <item1,item2> - stake switcher defence items swapping
 --strength-items <item1,item2> - stake switcher strength items swapping
 --spell-id <id> - Spell id for stake switcher casting

Stake Switcher

The stake switcher can only be configured by use of command-line parameters. Inside your run_windows.bat or run_linux.sh script, add the following lines:

--attack-items 123,456
--strength-items 123,456
--defence-items 123,456
--spell-id 2

e.g. java -jar IdleRSC.jar --attack-items 123,456 and so on.

Restart the bot. Press F5, F6, F7, F8 to validate.


Compiling Scripts

Linux

1. Put the .java file in the src/scripting/(idlescript or sbot) folder
2. Run `./gradlew build`

Windows

Native Scripts and SBot: (Eclipse Method)

1. Open up the project in Eclipse
2. Add a new script to the `scripting` package.
3. Compile Jar with (compile_windows.bat) or (compile_linux.sh)
4. Run client with (run_windows.bat) or (run_linux.sh)

Native Scripts and SBot: (IntelliJ Gradle Method)

1. Open up the project in IntelliJ
2. Save all script changes
3. Build project Class files with Gradle "Build Project"
4. Compile Jar with (compile_windows.bat) or (compile_linux.sh)
5. run client with (run_windows.bat) or (run_linux.sh)

APOS/SBot

Easy Method: (NOT PREFERRED IF YOU ARE WANTING TO DEVELOP SCRIPTS)
WARNING: This will delete your JAR file!!!

1. Place your script in src/scripting/apos/
2. Run compile_windows.bat (or compile_linux.sh)
3. Ensure no issues compiling (they will be towards the top.)
4. Re-run the bat file.

Read "converting SBot scripts" section for compilation issues.

Converting Scripts

Converting APOS Scripts

APOS scripts require several changes in order to be made compatible. Please see changes made to scripts which were added.

Converting SBot Scripts

1. Open SBot script in a text editor.
2. Place these lines at the top of the file:
  package scripting.sbot;
  import compatibility.sbot.Script;

3. Remove the mudclient constructor.
For example, for alch.java, you would want to remove the following lines:
  public alch(mudclient rs)
  {
    super(rs);
  }

Compile using Eclipse or IntelliJ Gradle (preferred) or the included compilation script (compile_windows.bat)


About IdleRSC

This started as a project in April 2020 due to a distinct lack of botting clients available for RSC post-closure.

After Jagex decided to nerf the blowpipe in OSRS, the original coder gained renewed interest in January 2021, and the project was resurrected and released.

The original owner is no longer part of this fork of the project. However, credit for writing the original client goes to DvorakKeys.

The RSC botting scene WILL NEVER DIE! IdleRSC is the next iteration after APOS, STS, SBot, and AutoRune!


FAQ
Q: Can I donate to this project?
A: No donations nor subscriptions are accepted. We don't want any money.
  We also don't believe that dumping player money into ads will make any
  difference for long term player growth and retention.
  The best way to help the team is to help with submitting bug reports,
  submitting GitLab merge requests, and spreading the word about us to
  your friends so they will want to be a part of this too!

Discussion and Contributing

Feel free to join the #botting-client-development channel in the OpenRSC discord.

Other channels are not tied to botting, so please do not discuss botting in those channels.

If you would like to contribute to IdleRSC, but don't know where to start check out the documentation.


Reporting Issues

Please submit issues, questions, bugs on GitLab's issue tracker.

Provide stack traces for crashes, etc.

Please submit pull requests to GitLab.


Contributors

IdleRSC Contributors

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages