osrs-python-bot


Nameosrs-python-bot JSON
Version 0.2.1 PyPI version JSON
download
home_pagehttps://github.com/osrs-bots/osrs-python-bot
Summary
upload_time2024-01-28 14:57:49
maintainer
docs_urlNone
authorosrs-bots
requires_python
license
keywords osrs-bots
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            
# OSRS Python Bot

- [How to Use OSRS Python Bot](#how-to-use-osrs-python-bot)
  - [Setup Guide](#setup-guide)
    - [System Requirements](#system-requirements)
    - [Getting Everything Ready](#getting-everything-ready)
    - [Actually Running Scripts](#actually-running-scripts)
  - [Contributing to the Project](#contributing-to-the-project)
- [Skill Categories](#skill-categories)
  - [Combat ðŸĪš](#combat-)
    - [NMZ Prayer Flicking](#nmz-prayer-flicking)
  - [Herblore ðŸŒŋ](#herblore-)
    - [Making Guthix Rest](#making-guthix-rest)
    - [Cleaning Herbs](#cleaning-herbs)
  - [Magic 🧙‍♂ïļ](#magic-ïļ)
    - [Casting High Alchemy](#casting-high-alchemy)

## Setup Guide

### System Requirements
- Windows PC ðŸ’ŧ
- [RuneLite](https://runelite.net/) ⚔ïļ
- [git](https://git-scm.com/download/win) 😚
- [python](https://www.python.org/downloads/) & [pip](https://pip.pypa.io/en/stable/installation/) 🐍
- Basic understanding of programming 🧑‍ðŸ’ŧ
- Ability to run commands from the terminal ðŸ‘Đ‍ðŸ’ŧ

### Getting Everything Ready
======

```
pip install osrs-python-bot
```

**Download**
<a href='' download>runner.py</a>


### Actually Running Scripts
======

Each bot is programmed to click on specific pixels, therefore it requires precise instructions. These instructions may involve the character's orientation, the location of the item in the bank, and even the arrangement of the inventory. It is of utmost importance to follow each script's instructions accurately. These scripts are inteded for private servers. 

**Note:** press space bar to stop a script

*Using these scripts is solely at your own discretion and risk. Employing them may lead to a ban or loss of your old school runescape account. I cannot be held accountable for any misuse or consequences arising from the utilization of this code.*

## Contributing to the Project

Contributions are highly encouraged. I am eager to incorporate computer vision to make the scripts more dynamic. If there are any issues or interest for collaboration please open an issue.

I appreciate the donations, it keeps the coffee flowing ☕😊

## Skill Categories

<!---------------------------------------- COMBAT ----------------------------------------->
### Combat ðŸĪš
---

#### NMZ Prayer Flicking

**Script**

[#nightmare_zone.py](https://github.com/osrs-bots/simple-python-bot/blob/main/scripts/nightmare_zone.py)

**Instructions**

- Cursor is hovering quick prayers button
- Quick prayers set to rapid heal
- Use Dhorak's with rock cake
- Fill up on absorptions
- Turn on run and auto retaliate

**Command**

```
python nightmare_zone.py
```


<!---------------------------------------- HERBLORE ----------------------------------------->
### Herblore ðŸŒŋ

---
<!---------------------------------------- MAKING GUTHIX REST ----------------------------------------->
#### Making Guthix Rest

**Instructions**

- RuneLite client is as small as possible
- RuneLite client is in top left of monitor
- At castle wars bankchest
- Face directly East (right click the compass)
- The viewport is fully zoomed in
- Camera is positioned in the most top down position (hold up arrow key)
- Inventory pane is open and empty
- Bank menu opens to a tab with guthix rest supplies
- The bank menu is closed to start
- Supplies ordered according to the image
- Large inventory of supplies as depletion can break script

**Command**
```
python make_guthix_rest.py
```

**Images**

![guthix rest bank setup](https://github.com/osrs-bots/docs/blob/main/website/static/img/guthix_rest_maker_bank_setup.gif?raw=true?raw=true)

hot cup of water / guam / marrentill / harralander

---
<!---------------------------------------- CLEANING HERBS ----------------------------------------->
#### Cleaning Herbs

**Instructions**

- RuneLite client is as small as possible
- RuneLite client is in top left of monitor
- Character is at castle wars bankchest
- Character is facing directly East (right click the compass)
- The viewport is fully zoomed in (scroll)
- Camera is positioned in the most top down position (hold up arrow key)
- Inventory pane is open and empty
- Bank menu opens to a tab with supplies
- The bank menu is closed to start
- Herb in top right bank slot
- Large inventory of supplies as depletion can break script

**Command**
```
python clean_herbs.py
```
  
<!---------------------------------------- MAGIC ----------------------------------------->
### Magic 🧙‍♂ïļ
---

#### Casting High Alchemy

**Instructions**

- Mouse is hovering high alchemy spell
- High alchemy item is in the designated spot

**Command**

```
python high_alchemy.py
```

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/osrs-bots/osrs-python-bot",
    "name": "osrs-python-bot",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "osrs-bots",
    "author": "osrs-bots",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/db/d7/a662287330a9869c7e6824c679360b43e3b1046b17bc3466fd190cb48fd3/osrs-python-bot-0.2.1.tar.gz",
    "platform": null,
    "description": "\n# OSRS Python Bot\n\n- [How to Use OSRS Python Bot](#how-to-use-osrs-python-bot)\n  - [Setup Guide](#setup-guide)\n    - [System Requirements](#system-requirements)\n    - [Getting Everything Ready](#getting-everything-ready)\n    - [Actually Running Scripts](#actually-running-scripts)\n  - [Contributing to the Project](#contributing-to-the-project)\n- [Skill Categories](#skill-categories)\n  - [Combat \ud83e\udd3a](#combat-)\n    - [NMZ Prayer Flicking](#nmz-prayer-flicking)\n  - [Herblore \ud83c\udf3f](#herblore-)\n    - [Making Guthix Rest](#making-guthix-rest)\n    - [Cleaning Herbs](#cleaning-herbs)\n  - [Magic \ud83e\uddd9\u200d\u2642\ufe0f](#magic-\ufe0f)\n    - [Casting High Alchemy](#casting-high-alchemy)\n\n## Setup Guide\n\n### System Requirements\n- Windows PC \ud83d\udcbb\n- [RuneLite](https://runelite.net/) \u2694\ufe0f\n- [git](https://git-scm.com/download/win) \ud83d\ude3a\n- [python](https://www.python.org/downloads/) & [pip](https://pip.pypa.io/en/stable/installation/) \ud83d\udc0d\n- Basic understanding of programming \ud83e\uddd1\u200d\ud83d\udcbb\n- Ability to run commands from the terminal \ud83d\udc69\u200d\ud83d\udcbb\n\n### Getting Everything Ready\n======\n\n```\npip install osrs-python-bot\n```\n\n**Download**\n<a href='' download>runner.py</a>\n\n\n### Actually Running Scripts\n======\n\nEach bot is programmed to click on specific pixels, therefore it requires precise instructions. These instructions may involve the character's orientation, the location of the item in the bank, and even the arrangement of the inventory. It is of utmost importance to follow each script's instructions accurately. These scripts are inteded for private servers. \n\n**Note:** press space bar to stop a script\n\n*Using these scripts is solely at your own discretion and risk. Employing them may lead to a ban or loss of your old school runescape account. I cannot be held accountable for any misuse or consequences arising from the utilization of this code.*\n\n## Contributing to the Project\n\nContributions are highly encouraged. I am eager to incorporate computer vision to make the scripts more dynamic. If there are any issues or interest for collaboration please open an issue.\n\nI appreciate the donations, it keeps the coffee flowing \u2615\ud83d\ude0a\n\n## Skill Categories\n\n<!---------------------------------------- COMBAT ----------------------------------------->\n### Combat \ud83e\udd3a\n---\n\n#### NMZ Prayer Flicking\n\n**Script**\n\n[#nightmare_zone.py](https://github.com/osrs-bots/simple-python-bot/blob/main/scripts/nightmare_zone.py)\n\n**Instructions**\n\n- Cursor is hovering quick prayers button\n- Quick prayers set to rapid heal\n- Use Dhorak's with rock cake\n- Fill up on absorptions\n- Turn on run and auto retaliate\n\n**Command**\n\n```\npython nightmare_zone.py\n```\n\n\n<!---------------------------------------- HERBLORE ----------------------------------------->\n### Herblore \ud83c\udf3f\n\n---\n<!---------------------------------------- MAKING GUTHIX REST ----------------------------------------->\n#### Making Guthix Rest\n\n**Instructions**\n\n- RuneLite client is as small as possible\n- RuneLite client is in top left of monitor\n- At castle wars bankchest\n- Face directly East (right click the compass)\n- The viewport is fully zoomed in\n- Camera is positioned in the most top down position (hold up arrow key)\n- Inventory pane is open and empty\n- Bank menu opens to a tab with guthix rest supplies\n- The bank menu is closed to start\n- Supplies ordered according to the image\n- Large inventory of supplies as depletion can break script\n\n**Command**\n```\npython make_guthix_rest.py\n```\n\n**Images**\n\n![guthix rest bank setup](https://github.com/osrs-bots/docs/blob/main/website/static/img/guthix_rest_maker_bank_setup.gif?raw=true?raw=true)\n\nhot cup of water / guam / marrentill / harralander\n\n---\n<!---------------------------------------- CLEANING HERBS ----------------------------------------->\n#### Cleaning Herbs\n\n**Instructions**\n\n- RuneLite client is as small as possible\n- RuneLite client is in top left of monitor\n- Character is at castle wars bankchest\n- Character is facing directly East (right click the compass)\n- The viewport is fully zoomed in (scroll)\n- Camera is positioned in the most top down position (hold up arrow key)\n- Inventory pane is open and empty\n- Bank menu opens to a tab with supplies\n- The bank menu is closed to start\n- Herb in top right bank slot\n- Large inventory of supplies as depletion can break script\n\n**Command**\n```\npython clean_herbs.py\n```\n  \n<!---------------------------------------- MAGIC ----------------------------------------->\n### Magic \ud83e\uddd9\u200d\u2642\ufe0f\n---\n\n#### Casting High Alchemy\n\n**Instructions**\n\n- Mouse is hovering high alchemy spell\n- High alchemy item is in the designated spot\n\n**Command**\n\n```\npython high_alchemy.py\n```\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "",
    "version": "0.2.1",
    "project_urls": {
        "Homepage": "https://github.com/osrs-bots/osrs-python-bot"
    },
    "split_keywords": [
        "osrs-bots"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2d3712254d076c8a37b0c248b7ee4bdd963b59ccc66769249f31f9970b1c6e3f",
                "md5": "c01ea08165690b0d0343bfe2a135c804",
                "sha256": "fd7f02bec2ce17719183bb719e72afbfbb3443ac3da99d3ecf25f2b9ca88d129"
            },
            "downloads": -1,
            "filename": "osrs_python_bot-0.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c01ea08165690b0d0343bfe2a135c804",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 8259,
            "upload_time": "2024-01-28T14:57:48",
            "upload_time_iso_8601": "2024-01-28T14:57:48.931879Z",
            "url": "https://files.pythonhosted.org/packages/2d/37/12254d076c8a37b0c248b7ee4bdd963b59ccc66769249f31f9970b1c6e3f/osrs_python_bot-0.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dbd7a662287330a9869c7e6824c679360b43e3b1046b17bc3466fd190cb48fd3",
                "md5": "a993493e36f18d44fcfbf3591654d286",
                "sha256": "b6f8bad0aece2ac30678d2ce5002cffb97d8a03e7cf451df27809b4d47862ae6"
            },
            "downloads": -1,
            "filename": "osrs-python-bot-0.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "a993493e36f18d44fcfbf3591654d286",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 8419,
            "upload_time": "2024-01-28T14:57:49",
            "upload_time_iso_8601": "2024-01-28T14:57:49.927062Z",
            "url": "https://files.pythonhosted.org/packages/db/d7/a662287330a9869c7e6824c679360b43e3b1046b17bc3466fd190cb48fd3/osrs-python-bot-0.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-28 14:57:49",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "osrs-bots",
    "github_project": "osrs-python-bot",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "osrs-python-bot"
}
osrs-bots
Elapsed time: 1.58937s