Giter VIP home page Giter VIP logo

autoos's Introduction

Contributors Forks Stargazers Issues GPL-3.0 License


Logo

AutoHotkey color bot for OldSchool RuneScape.

Table of Contents

About AutoOS

AutoOS is a pure color and math bot, it reads the pixels on your screen, their color, their position, your mouse position and uses math to figure out everything.

Because AutoOS uses color only, you can use it with any client though I only officially support RuneLite and the official client at the moment.

Also, since AutoOS doesn't use reflection nor injection, in theory, it's undetectable.

AutoOS features:

  • Script loader.
  • Player manager.
    • Setup several accounts.
    • Accounts act different from each other.
    • Account sensitive data is encrypted.
  • Asynchronous input.
    • Mouse and keyboard can move and press keys independent from each other and at the same time.
  • DPI scaling.
    • Everything should work and adapt to your screen DPI outside of the box.
  • Great Antiban.
    • Lot's of random variables and several random profiles for everyone.
  • Easy to use.
  • Easy to develop scripts.

Getting Started

To use AutoOS is easy to use and setup.

Prerequisites

  1. Download and install AutoHotkey current version (v1.1.32).
  2. Download and run one of the supported osrs clients.
    • RuneLite.
    • OSRS official client.
    • Different clients should work but are not tested.
  3. Download AutoOS and keep all of it's contents on the same folder.
    • You can optionally make a shortcut of AutoOS.ahk and place it on your desktop.

Setup

  1. Start your osrs client and wait for it to finish loading.
  2. Run AutoOS.ahk
  3. If you want AutoOS to be able to login and unlock the bank by itself type a new master password on the prompt, otherwise you can just press enter leaving it empty.
  4. Open the player manager and add a new player.
    • Your account info is optional.
    • If you want to add your account information the master password will keep your account details encrypted.
    • Add your FKeys the same way you have them setup on you account. This is important.
  5. To use a script, simply press the script launcher and choose the script you want to run!
    • You can download or make new scripts yourself.
    • Place new scripts on the scripts folder.

Make scripts for AutoOS

If you are a developer, AutoOS is basically a large framework with all the boring and hard work already done for you.

To make your own script for AutoOS, first create your script in the scripts folder.

You must name it this way:

[Category]ScriptName.ahk

In Category you can type whatever you want but would be nice if everyone uses a set of standard categories.

Add this lines at the top of your script:

ScriptLoaded := true

RunScript()
{
	; Your script goes here.
	; From here you can either insert your script directly or call functions/methods/etc.
	return
}

Personally I'm a Scite4ahk user, but until you are familiar with AutoOS classes, methods and functions, I would recommend you use AHKStudio. This is because AHKStudio makes an excellent at autocompleting stuff that is included or is in a library while Scite4ahk doesn't do it so well. This is the reason we add the code above at the top of our script, so your IDE/Text editor can fetch AutoOS classes and functions.

After that you can start develop your script.

AutoOS makes it very easy to develop a script, for example if you want your script to click the first inventory slot and turn pray melee on you can just type:

AutoOS.Core.GameTab.Inventory.ClickSlot(1)
AutoOS.Core.GameTab.Prayer.PrayMelee()

You will mostly be using AutoOS.Core class, so you should get familiar with all it's sub-classes and methods. When making a script, AutoOS debug box can be very helpful. It can display all sorts of useful information, like mouse position, color under mouse, etc. And gives you an easy way to copy paste useful data.

Roadmap

See the open issues for a list of proposed features (and known issues). Click here to check the current Roadmap.

Contributing

Contributions are welcome though they should follow this guidelines:

  • Keep the current programming style.
    • local my_variable
    • static MyVariable
    • global MY_VARIABLE
    • class MyClass
    • MyFunction(my_parameter, other_parameter)
  • Readability over speed.
    • Fast code is important but if it's hard to understand, it's also hard to fix something that is not working properly later on.
    • Fast code that is well explained with comments and/or is easy to grasp is very welcome though.
  • There's no need for many way to do the same thing.
  • Get familiar with my versioning.
  • A bot is nothing without good scripts, if you have a script you would like to make public let me know! You can and should display your own ads!

License

Distributed under the GNU GPLv3. See LICENSE for more information.

Contact

AquaShyWasp on Status [email protected]

Project Link: https://github.com/AquaShyWasp/AutoOS

Acknowledgements

autoos's People

Contributors

aquashywasp avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.