Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/slyautomation/osrs_basic_botting_functions
Functions for automating osrs botting using Python.
https://github.com/slyautomation/osrs_basic_botting_functions
automation botting color-detection colorbot image-recognition imagebot ocr oldschoolrunescape osrs pyautogui-automation python runescape template-matching tesseract-ocr
Last synced: 6 days ago
JSON representation
Functions for automating osrs botting using Python.
- Host: GitHub
- URL: https://github.com/slyautomation/osrs_basic_botting_functions
- Owner: slyautomation
- Created: 2021-03-27T10:50:54.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T10:34:47.000Z (about 1 year ago)
- Last Synced: 2025-01-08T12:07:14.096Z (13 days ago)
- Topics: automation, botting, color-detection, colorbot, image-recognition, imagebot, ocr, oldschoolrunescape, osrs, pyautogui-automation, python, runescape, template-matching, tesseract-ocr
- Language: Python
- Homepage:
- Size: 19.2 MB
- Stars: 203
- Watchers: 20
- Forks: 75
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Old School Botting Functions
Full tutorial on creating Functions for automation using Python for osrs botting.
The example used will be woodcutting, where the script will use colour detection using opencv and use pyautogui to move the mouse, click and use the keyboard to drop items using an image recognition module that will detect the wood icons in the inventory.
Consider donating if you found the project fun and learnt more about python: https://www.buymeacoffee.com/slyautomatG
Other python files will also use tesseract-OCR to detect text within images using tesseract-OCR image to text recognition functions.
Need help with installing python, pycharm and cloning a repo? read this article for help: https://www.slyautomation.com/blog/install-pycharm-and-python-clone-a-github-project/
## Setup
```diff
Note: PC Monitor settings - change resolution to 1920x1080 panel and text of apps was set to 100%.
```
Right click and select Display Settings
In the Scale And Layout section - Change size of text to 100% and Set Display Resolution to 1920 x 1080 for best results.
### Installing Pycharm
pycharm
How to add Project with Pycharm
Editing how to ensure venv (virtual environment) is active
## core.py and function.py
For the full video tutorial click link: https://www.youtube.com/watch?v=C7ZY4KYpFII
This video is more about how it was created at the start core.py is how to make the python script focus on the old school runescape application and adjust the window size so all the scripts run as intended. Then functions.py is where all the different kinds of shortcut functions are placed to reference the mini map, or a piece of code to do color detection or open the inventory.
## Quick module install Steps
in terminal type:
pip install -r requirements.txt
tesseract-ocr = https://digi.bib.uni-mannheim.de/tesseract/?C=M;O=D
if that website is down use 5.3: https://drive.google.com/file/d/1acZJSm3BEmCORSB4NDmpaaT5WC1FNu2s/view?usp=sharing
or use original version 3.0.2: https://drive.google.com/file/d/1mCgYueVKRVbPg-ICz8BjrAWH5oOLjp55/view?usp=sharing
Tutorial on installing tesseract-OCR: https://youtube.com/watch?v=X3snnwzJfEw&t=25m15s
## Runelite Setup
Tutorial on runelite setup click link: https://youtube.com/watch?v=JO2FvkJwppA
Also make sure that the transparent side panels and chatbox is unchecked:
Make sure the tool bar is enabled and showing on the right had side of the client window (press the arrow to enable the toolbar as visable):
### pybot-config.yaml (configuration file)
client_title: Is the title of the application window usually Runelite if you have completed the steps for the Runelite Setup, if not then enter RuneLite - username or OpenOSRS
To disable the username in the client window using the toolbar search for runelite plugin and in the settings make sure 'Show display name title' is unchecked.
enable_on_start: if you don't want the config window to pop up each time, enter as false
file_path_to_client: the head folder where the OSRS client is stored usually .runelite or .openosrs
pc_profile: is the user profile of the pc so it can find runelite or openosrs
tesseract_path: Is the folder address to tesseract-ocr program
```diff
- Note: copy the format below make sure to include the slashes (\).
```
In Runescape setting, set the following:
- Ideally under display, enable hide roofs, camera zoom, screen brightness matching below.
- Under controls, enable shift click to drop items, and set inventory shortcut to ESC keystroke.
- Under Interfaces ensure Game Client layout is Resizable - Modern Layout
- Show data orbs enabled
Make sure the info boxes are filled and the standard brown color, use the toolbar and search Runelite. In the settings under overlay section select the 'Overlay color'.
Change Interface font to 'Bold'.
Change Infobox font to 'Bold'.
Change opacity to 255 and the hex color to #FF463D32:
## Woodcutting
### features
Cuts woods and makes fire
- Use object marker plugin to highlight trees red, green or yellow.
- Make sure to have an axe equipped and a tinderbox if firemaking.
- Turn on woodcutting plugin
- Turn off Show weight in item stats
Tutorial on firemaking code click link: https://youtu.be/bHZCQUChG_k
- Pick a object marker color, a wood type and how long in hours to run for
## fishing.py
- Turn on fishing plugin.
- Make sure to have net for prawn fishing or a rod and bait/feathers for fish.
Tutorial on fishing code click link: https://youtube.com/watch?v=5K-nMy9Pdvg
## mining.py
- Turn on mining plugin.
- Mark ore spots using the object marker to green.
- Make sure to equip a pick axe.
- enter the ore type, the marker color and how long to run in hours (Change Run_Duration_hours)
Tutorial on mining code click link: https://youtube.com/watch?v=dkD5gXcgQYI
## combat.py
- Turn on NPC Indicators plugin and Opponent Information plugin
- Change Highlight colour to #ff00ffff
- Hold Shift and Right Click on NPC/Mob and select Tag-All
- In the Combat script change the first value to the NPC/Mob name
- Change Run_duraction_hours to the number of hours to run script for
- To add or use a NPC/Mob not on the list add it to the monster_array as ['each iteration captured by the combat_text'] and add to monster_list the name
Tutorial on combat code click link: https://youtube.com/watch?v=llGbhVfU1Bc
## thieving.py
### steal_man() Works with Knights, Goblins and Thieves etc.
- Turn on NPC Indicators plugin
- Change Highlight colour to #ff00ffff
- Hold Shift and Right Click on NPC/Mob and select Tag etc.
- Make sure pickpocket will be actioned on left click (some npcs even on always right click have 'talk to' as left click option)
- To stop script hold down the capslock key
### Improvements to add
- Stop or eat when health is low (warning this does not stop when health is low)
### steal_tea()
- Hold shift and mark object Tea Stall (Make sure the color is red)
## Clay Money Maker
This only works at the Rimmington mine and banks at Port Sarim deposit box.
- Turn on mining plugin.
- Make sure to equip a pick axe.
- The Start location when running the clay_beginner_money_maker.py is at the Rimmington Mine start next to the clay deposits
```diff
- IMPORTANT! Set compass directly north, click the on the compass to reset straight.
Otherwise the walker from deposit box to rimmington mine won't work.
```
- Mark clay spots next to the east fence line using the object marker to green (optional are red or amber).
- Mark the deposit box at Port Sarim using the object marker to red.
This is the path that is takes:
Make sure to select the color that you highlighted the clay ores and set the Run Duration to the number of hours:
## smithing.py
Tutorial on smithing code click link: https://youtube.com/watch?v=YezEeVjoP6o
## magic.py
### features
High alching
Superheat item
Tutorial on magic code click link: https://youtube.com/watch?v=Vyhy2CpfK7I
## osrs_walker.py
Tutorial: TBA
- Located in jar_files: Add httpplug-1.0.3.jar to C:\Users\ \.openosrs \plugins
- Located in jar_files: Add shortestagility-5.0.2.jar to C:\Users\ \.openosrs \plugins
### Setup
- Create txt file on desktop paths.txt, the modified plugin shortestagility-5.0.2.jar saves the coordinates when a path target is made in osrs.
- 
- 
- 
- Use main map and right click then select 'set target', run server.py and then run osrs_walker.py.
- 
## Troubleshooting
python venv/Scripts/pywin32_postinstall.py -install
## Wiki
[Wiki page on function descriptions and purpose](https://github.com/slyautomation/osrs_basic_botting_functions/wiki/Purpose-and-Definition-of-Functions-including-argument-s-usage)
Using the top banner in pycharm under file goto setttings.
Then in settings under the tools section click on terminal. and you'll need to change the shell path to cmd.exe. at the moment your default terminal is powershell
Image
You'll now be able to type in the pip command no issues