v0.7.0-alpha

This is a slight rebrand to the new name: OS Bot COLOR.

What's Changed

• Rebrand by @kelltom in #168

Full Changelog: v0.6.0-alpha...v0.7.0-alpha

v0.6.0-alpha

Upgrades to UI, OCR, Sprite Scraper, & More

NOTE: If you are upgrading to this version, please reinstall dependencies with pip install -r requirements.txt.

This update introduces a bunch of QoL improvements. Behind the scenes, we've cleaned up the Sprite Scraper to use an official API instead of scraping HTML, and OCR has received some reliability enhancements.

On the surface, the UI has seen some long-awaited improvements, such as scrollable frames, tooltips, and better fonts.

What's Changed

• Add chi-squared distribution to Random Util by @AdamAtPurpose in #139
• Add StatusSocket methods for checking skill levels by @filen1 in #152
• Removes pag mouse calls and uses Mouse class by @ThatOneGuyScripts in #151
• Add Is Inventory Empty Method to Morg API by @WillowsDad in #146
• Improve OCR (font cropping, false positive prevention) by @ThatOneGuyScripts in #159
• Remastered the Sprite Scraper utility (swapped BS4 for API + improvements) by @v0rkath in #157
• Add MorgAPI method to get first occurrence of item(s) in inventory by @WillowsDad in #147
• Upgrade to CustomTkinter 5 (scrolling frames, UI improvements) by @kelltom in #166

New Contributors

• @AdamAtPurpose made their first contribution in #139
• @filen1 made their first contribution in #152
• @WillowsDad made their first contribution in #146
• @v0rkath made their first contribution in #157

Full Changelog: v0.5.1-alpha...v0.6.0-alpha

v0.5.1-alpha (bugfix)

Bugfix

This update fixes an issue involving the game_launcher utility attempting to launch new versions of RuneLite with deprecated arguments.

Pull Requests

• Fix invalid launcher argument by @kelltom in #145

Full Changelog: v0.5.0-alpha...v0.5.1-alpha

v0.5.0-alpha

Added Support for RuneLite Profile Manager

This update addresses RuneLite update 1.9.11.2, which introduces the Profile Manager feature. The game_launcher utility can now launch RuneLite using this new manager, as well as the legacy method.

Some significant changes were made to the structure of this file, and how the utility is used. Scripts that offer a custom-launch tool will need to be revised.

Example usage:

import utilities.game_launcher as launcher
...
# Example usage for OSRS, using Profile Manager
# Launch the game
launcher.launch_runelite(
    properties_path=<path_to_properties_file>,
    game_title=self.game_title,
    use_profile_manager=True,
    profile_name="OSBCCombat",  # Supply a profile name if you'd like to save it to the Profile Manager
    callback=self.log_msg,
)

In this example, we are loading a typical .properties file into RuneLite's Profile Manager, where it will exist as OSBCCombat. This is useful for those who want to swap between bots that require custom settings. You won't need to launch via OSBC every time you change scripts; instead, you can just swap the profile from this menu.

Alternatively, you can choose not to provide a name, and it will be saved as a temp profile instead.

Pull Requests

• Fix incorrect inventory slot spacing by @ThatOneGuyScripts in #140
• Runelite launcher overhaul by @kelltom in #143

Full Changelog: v0.4.1-alpha...v0.5.0-alpha

v0.4.1-alpha (bugfix)

Bugfix

This update fixes an issue with the Sprite Scraper that was improperly cropping images for image search usage in bank interfaces. This update also improves that algorithm by adding padding to the bank image to better cover its containing bank slot.

What's Changed

• Fixed Sprite Scraper bank variant algorithm by @kelltom in #137

Full Changelog: v0.4.0-alpha...v0.4.1-alpha

v0.4.0-alpha

How to Upgrade

For those who are upgrading to this release, be sure to run pip install -r requirements.txt to update dependencies.
This update will not have side effects on your existing scripts. It is safe to merge.

What's New

We have a fancy new Sprite Scraper feature (thanks to @oliverpatrick for the initial legwork). You can use the main menu GUI to launch the Sprite Scraper interface to easily download images from the OSRS Wiki!

NOTE: This feature does not work well with IPv6. If you are having issues, simply disable IPv6 on your computer.

Code_x35fAkfaZm.mp4

You can also use this utility directly from your scripts. This allows you to share scripts with others without having to bundle images with them!

scraper = SpriteScraper()
scraper.search_and_download(
    search_string = "molten glass, bucket of sand",
    image_type = 1,
    destination = imsearch.BOT_IMAGES.joinpath("bank"),
    notify_callback = self.log_msg,
)

Lastly, an experimental patch has been added as a workaround for the issue where OCR fails within right-click menus.

Pull Requests

• Bump pillow from 9.2.0 to 9.3.0 by @dependabot in #127
• Added OSRS Wiki Sprite Scraper by @oliverpatrick in #108
• Potential fix for OCR failure on crowded text by @ThatOneGuyScripts in #135

New Contributors

• @dependabot made their first contribution in #127
• @oliverpatrick made their first contribution in #108
• @ThatOneGuyScripts made their first contribution in #135

Full Changelog: v0.3.8-alpha...v0.4.0-alpha

v0.3.8-alpha

What's Changed

• Allow list of ids when checking equipped items by @Rurquhart in #129
  • Useful for checking if you're wearing charged jewelry
• Add inventory full check for Morg API by @Rurquhart in #131
  • Replaces the need to use StatusSocket plugin for this feature
• Add Rectangle sorting key function and improve RuneLiteBot loot function by @dubalols in #130
  • Looting is now less janky, Rectangles can be sorted based on distance from player

New Contributors

• @Rurquhart made their first contribution in #129
• @dubalols made their first contribution in #130

Full Changelog: v0.3.7-alpha...v0.3.8-alpha

v0.3.7-alpha

Summary

This update offers a small (but significant) bug fix involving the self.stop() function, as well as a potential fix for the false-positive keylogger flagging some users have reported from Windows Defender. FYI, antivirus was being triggered by OSBC's new settings feature, which allows users to record custom key binds for starting/stopping bots.

What's Changed

• Fixed the Bot.stop() function from failing when called explicitly within script by @kelltom in #125
• Potential fix for false-positive antivirus trigger by @gabrielfoo in #126

Full Changelog: v0.3.6-alpha...v0.3.7-alpha

v0.3.6-alpha

Summary

This update adds a few QoL features!

There is now a settings window that lets you change the key bind for starting/stopping bots!

All bots now have a camera movement function:

# Rotate camera 180 degrees to the left, and 90 degrees up
self.move_camera(horizontal = -180, vertical = 90):

You can now reliably check if a mouse click had a red X:

if self.mouse.click(check_red_click=True):
    print("The click had a red X")

Some improvements were made to the Morg API utility:

# You can check the most recent message in the chat box
print(f"Latest chat message: {api.get_latest_chat_message()}")
# You can also check if you have an item equipped, and its quantity
print(f"Is bronze axe equipped?: {api.get_is_item_equipped(ids.BRONZE_AXE)}")
print(f"How many bronze arrows equipped?: {api.get_equipped_item_quantity(ids.BRONZE_ARROW)}")

---

What's Changed

• Add camera rotation function by @MataiRepublic in #87
• Reimplement detect red clicks by @gabrielfoo in #112
• API improvements for equipment by @redtortuga19 in #104
• Added function to get latest chat message by @kelltom in #122
• Add global settings page by @kelltom in #113

Minor Fixes

• Update .pre-commit-config.yaml by @kelltom in #120
• Update pre-commit.yml by @guidodobboletta in #114

New Contributors

• @gabrielfoo made their first contribution in #112
• @redtortuga19 made their first contribution in #104

Full Changelog: v0.3.5-alpha...v0.3.6-alpha

v0.3.5-alpha (bugfix)

Summary

Some type annotation inconsistencies were fixed which could have caused some runtime errors for some people. This fix is safe to pull into projects with custom scripts. If you aren't having issues with your current build, you can ignore this update.

What's Changed

• Fixed type annotation flaw by @kelltom in #110

Full Changelog: v0.3.4-alpha...v0.3.5-alpha