mirror of
https://github.com/bdnugget/IdleRSC.git
synced 2026-11-07 07:57:27 +00:00
README Rewrite
This commit is contained in:
Seatta authored and Ellie committed
1 parent
03d18cfe47
commit
d2f69d9cbe
6 files changed
+180
-156
No files matched your search
@@ -1,94 +1,116 @@
|
||||
# IdleRSC
|
||||
<div align="center">
|
||||
|
||||
IdleRSC is a bot for [Open RSC][open-rsc]. It uses code injection and
|
||||
|
||||
|
||||
# IdleRSC
|
||||
[][launcher]
|
||||
[][releases] [][commits] [][discord]
|
||||
|
||||
IdleRSC is a bot for the [OpenRSC][OpenRSC] coleslaw and uranium worlds that uses code injection and
|
||||
reflection. It has it's own custom scripting API called IdleScript, as well as
|
||||
backwards compatibility with APOS and SBot scripts. It also provides staker
|
||||
bot functionality!
|
||||
|
||||
|
||||
|
||||
## Starting IdleRSC
|
||||
|
||||
|
||||
---
|
||||
Releases are automatically generated upon every commit to the GitLab
|
||||
[repository][repository], the last successful build can be downloaded
|
||||
[here][download]. Javadoc can be found [here][github-pages]
|
||||
|
||||
1. Modify run.bat/sh.
|
||||
1. Select which server you want.
|
||||
1. **Optional**: if playing on a different server which allows botting,
|
||||
modify Cache/ip.txt and Cache/port.txt if needed.
|
||||
1. Run .bat/.sh file!
|
||||
### Rules
|
||||
***DO NOT*** use this client to bot on non-botting servers.
|
||||
|
||||
## Commands
|
||||
The only allowed openRSC botting servers are Coleslaw and Uranium.
|
||||
|
||||
Using this client on disallowed OpenRSC servers will result in a ***BAN***.
|
||||
|
||||
---
|
||||
|
||||
|
||||
### In-game
|
||||
### Requirements
|
||||
Download and install [Java 8][java8] for your device.
|
||||
|
||||
* `::bothelp` - show help menu with all in-game commands & keyboard shortcuts
|
||||
* `::show` - show the bot side-pane
|
||||
* `::gfx` - toggle graphics rendering
|
||||
* `::screenshot` - take a screenshot
|
||||
* `::hidepaint`/`::showpaint` - toggle paint left-side menu
|
||||
* `::toggleid` - toggle item/object/npc IDs on right-click
|
||||
* `::interlace` - toggle graphics interlacing
|
||||
Download the [Open Runescape Classic Launcher][launcher].
|
||||
|
||||
### Shortcuts
|
||||
*Note: If you're still not able to run OpenRSC.jar after installing Java 8 try running [jarfix][jarfix].*
|
||||
|
||||
* `F1` - toggle graphics interlacing
|
||||
* `F2` - toggle left-side sub menu
|
||||
* `F3` - return camera zoom to default setting
|
||||
* `F4` - toggles between first & third person view
|
||||
* `F5`/`F6`/`F7` - attack/defense/strength item swapping (stake switching)
|
||||
* `F8` - spell id casting
|
||||
* `F9` - take a screenshot
|
||||
* `F10` - lock the client's camera position until `F10` is pressed or
|
||||
mouse click
|
||||
* `F11` - stop the current script and load a new one
|
||||
* `F12` - show help menu with all in-game commands & keyboard shortcuts
|
||||
|
||||
### CLI Startup Commands
|
||||
*You can also ask for help in the **#setup-help** or **botting-client-development** channels of the [OpenRSC discord][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
|
||||
|
||||
<details><summary>Commands and Shortcuts</summary>
|
||||
|
||||
---
|
||||
#### In-Game Commands and Shortcuts
|
||||
In-Game commands are typed into the game chat box.
|
||||
|
||||
|
||||
|
||||
#### 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`
|
||||
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.
|
||||
<div align="left">
|
||||
|
||||
* `--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 sleepr (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
|
||||
```
|
||||
--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
|
||||
```
|
||||
</div>
|
||||
|
||||
---
|
||||
### 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:
|
||||
<div align="left">
|
||||
|
||||
```
|
||||
--attack-items 123,456
|
||||
@@ -96,76 +118,58 @@ lines:
|
||||
--defence-items 123,456
|
||||
--spell-id 2
|
||||
```
|
||||
</div>
|
||||
|
||||
e.g. `java -jar IdleRSC.jar --attack-items 123,456` and so on.
|
||||
|
||||
Restart the bot. Press `F5`, `F6`, `F7`, `F8` to validate.
|
||||
|
||||
## Rules
|
||||
|
||||
---
|
||||
|
||||
User will NOT use this client to bot on non-botting servers. The only
|
||||
allowed openRSC botting servers are Coleslaw and Uranium. Use of this
|
||||
client to bot on Cabbage or Preservation will result in a BAN of the
|
||||
accounts.
|
||||
</details>
|
||||
|
||||
## Sleeping
|
||||
|
||||
---
|
||||
|
||||
Note: The below paragraph is out of date. The sleeper server no longer
|
||||
runs, and the local OCR functionality has not *yet* been tested by the
|
||||
current developers.
|
||||
|
||||
IdleRSC uses a sleeper server which is provided free of charge. However,
|
||||
if you would like, you can run the FOCR sleeper locally with --localOCR
|
||||
on the command line. Get the latest copy of FOCR [here][focr].
|
||||
|
||||
## Account Security
|
||||
|
||||
---
|
||||
|
||||
Please be aware that run.bat is not encrypted. If someone has your
|
||||
run.bat, they have your username and password.
|
||||
Please be aware that you should not run any .class files from sources
|
||||
you do not trust. Running a rogue .class file is akin to running a .exe
|
||||
file on your computer. IF YOU DON'T TRUST IT, READ THE SOURCE CODE AND
|
||||
COMPILE IT!!!
|
||||
|
||||
### Lost Items, Accounts, etc
|
||||
|
||||
Developers of IdleRSC are not responsible for ruined, banned, hacked accounts,
|
||||
or anything else.
|
||||
|
||||
## Compiling Scripts
|
||||
<details><summary>Compiling Scripts</summary>
|
||||
|
||||
---
|
||||
|
||||
### Linux
|
||||
<div align="left">
|
||||
|
||||
```
|
||||
1. Put the .java file in the src/scripting/(idlescript or sbot) folder
|
||||
2. Run `./gradlew build`
|
||||
```
|
||||
</div>
|
||||
|
||||
### Windows
|
||||
|
||||
#### Native Scripts and SBot: (Eclipse Method)
|
||||
<div align="left">
|
||||
|
||||
```
|
||||
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)
|
||||
```
|
||||
</div>
|
||||
|
||||
#### Native Scripts and SBot: (IntelliJ Gradle Method)
|
||||
<div align="left">
|
||||
|
||||
```
|
||||
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)
|
||||
```
|
||||
</div>
|
||||
|
||||
#### APOS/SBot
|
||||
<div align="left">
|
||||
|
||||
```
|
||||
Easy Method: (NOT PREFERRED IF YOU ARE WANTING TO DEVELOP SCRIPTS)
|
||||
WARNING: This will delete your JAR file!!!
|
||||
|
||||
@@ -174,9 +178,13 @@ WARNING: This will delete your JAR file!!!
|
||||
3. Ensure no issues compiling (they will be towards the top.)
|
||||
4. Re-run the bat file.
|
||||
|
||||
Read "converting SBot scripts" section for compilitation issues.
|
||||
Read "converting SBot scripts" section for compilation issues.
|
||||
```
|
||||
</div>
|
||||
|
||||
## Converting Scripts
|
||||
---
|
||||
</details>
|
||||
<details><summary>Converting Scripts</summary>
|
||||
|
||||
---
|
||||
|
||||
@@ -187,87 +195,103 @@ Please see changes made to scripts which were added.
|
||||
|
||||
### Converting SBot Scripts
|
||||
|
||||
<div align="left">
|
||||
|
||||
```
|
||||
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);
|
||||
}
|
||||
```
|
||||
package scripting.sbot;
|
||||
import compatibility.sbot.Script;
|
||||
```
|
||||
</div>
|
||||
|
||||
3. Remove the mudclient constructor. For example, for alch.java, you would want to remove the following lines:
|
||||
Compile using Eclipse or IntelliJ Gradle (preferred) or the included compilation script (compile_windows.bat)
|
||||
|
||||
```
|
||||
public alch(mudclient rs)
|
||||
{
|
||||
super(rs);
|
||||
}
|
||||
```
|
||||
---
|
||||
</details>
|
||||
|
||||
4. Compile using Eclipse or IntelliJ Gradle (preferred) or the included compilation script (compile_windows.bat)
|
||||
|
||||
## Compiling IdleRSC.jar
|
||||
|
||||
<details><summary>About IdleRSC</summary>
|
||||
|
||||
---
|
||||
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!
|
||||
|
||||
---
|
||||
</details>
|
||||
|
||||
<details><summary>FAQ</summary>
|
||||
|
||||
---
|
||||
|
||||
1. Clone the repository from [GitLab](https://gitlab.com/open-runescape-classic/idlersc).
|
||||
2. Open the project in Eclipse or IntelliJ, set up eclipse or gradle (preferred) compiler.
|
||||
3. If client JAR is out of date, run patcher utility from the Gitlab [repository](https://gitlab.com/open-runescape-classic/tools/idlersc_patcher) (follow README in that project).
|
||||
- Only typically necessary when a server-side update adds sprites/textures/etc.
|
||||
4. Test the compile process:
|
||||
a. Save all script changes
|
||||
b. "Build" project Class files with Gradle Build or Eclipse
|
||||
c. Compile Jar with (compile_windows.bat) or (compile_linux.sh)
|
||||
d. run client with (run_windows.bat) or (run_linux.sh)
|
||||
<div align="left">
|
||||
|
||||
If you have problems, you can create a new issue or ask for help in the OpenRSC Discord.
|
||||
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!
|
||||
|
||||
|
||||
## Contributing
|
||||
</div>
|
||||
</details>
|
||||
|
||||
---
|
||||
### Discussion and Contributing
|
||||
|
||||
* Please submit issues, questions, bugs on GitLab's [issue tracker][issue-tracker].
|
||||
* Provide stack traces for crashes, etc.
|
||||
* Please submit pull requests to [GitLab][merge-requests].
|
||||
Feel free to join the **#botting-client-development** channel in the [OpenRSC discord][discord].
|
||||
|
||||
## Discussion
|
||||
|
||||
---
|
||||
|
||||
Please join the [OpenRSC discord][discord] and post in the
|
||||
`#botting-client-development` channel. Other channels are not tied to botting,
|
||||
Other channels are not tied to botting,
|
||||
so please do not discuss botting in those channels.
|
||||
|
||||
## Donations
|
||||
If you would like to contribute to IdleRSC, but don't know where to start check out the [documentation][documentation].
|
||||
|
||||
---
|
||||
### Reporting Issues
|
||||
Please submit issues, questions, bugs on GitLab's [issue tracker][issue-tracker].
|
||||
|
||||
Like [Open RSC][open-rsc], donations are not accepted. IdleRSC is
|
||||
provided for free under [GPLv3](LICENSE), due to passion for RSC botting.
|
||||
Provide stack traces for crashes, etc.
|
||||
|
||||
## About
|
||||
Please submit pull requests to [GitLab][merge-requests].
|
||||
|
||||
---
|
||||
---
|
||||
|
||||
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.
|
||||
### Contributors
|
||||
<a href="https://gitlab.com/open-runescape-classic/idlersc/-/graphs/master?ref_type=heads">
|
||||
<img src="https://contrib.rocks/image?repo=open-rsc/idlersc" alt="IdleRSC Contributors" title="IdleRSC Contributors" width="400"/>
|
||||
</a>
|
||||
|
||||
The original owner is no longer part of this fork of the project. However,
|
||||
credit for writing the original client goes to DvorakKeys.
|
||||
Credit also goes to many developers including but not limited to:
|
||||
Damrau, Grawlinson, JonathanB31, Kaila Btw, Kkoemets, Searos, and Seatta.
|
||||
|
||||
The RSC botting scene WILL NEVER DIE! IdleRSC is the next iteration after
|
||||
APOS, STS, SBot, and AutoRune!
|
||||
</div>
|
||||
|
||||
[github-pages]: https://open-runescape-classic.gitlab.io/idlersc
|
||||
[open-rsc]: https://rsc.vet
|
||||
[openrsc]: https://rsc.vet
|
||||
[discord]: https://discord.gg/CutQxDZ8Np
|
||||
[commits]: https://gitlab.com/open-runescape-classic/idlersc/-/commits/master
|
||||
[repository]: https://gitlab.com/open-runescape-classic/idlersc
|
||||
[documentation]: https://open-runescape-classic.gitlab.io/idlersc
|
||||
[releases]: https://gitlab.com/open-runescape-classic/idlersc/-/releases
|
||||
[launcher]: https://rsc.vet/downloads/OpenRSC.jar
|
||||
[issue-tracker]: https://gitlab.com/open-runescape-classic/idlersc/-/issues
|
||||
[merge-requests]: https://gitlab.com/open-runescape-classic/idlersc/-/merge_requests
|
||||
[discord]: https://discord.gg/CutQxDZ8Np
|
||||
[focr]: https://gitlab.com/open-runescape-classic/tools/focr-resurrection
|
||||
[download]: https://gitlab.com/open-runescape-classic/idlersc/-/jobs/artifacts/master/browse?job=build
|
||||
[contributors]: https://gitlab.com/open-runescape-classic/idlersc/-/graphs/master?ref_type=heads
|
||||
[java8]: https://adoptium.net/temurin/releases/?version=8&package=jdk
|
||||
[jarfix]: https://johann.loefflmann.net/downloads/jarfix.exe
|
||||
File renamed without changes.
Binary file not shown.
|
After Width: | Height: | Size: 1.6 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 157 KiB |
File renamed without changes.
File renamed without changes.
Reference in new issue
Block a user