Git Product home page Git Product logo

unethicalite's Introduction

Unethicalite

A non-compliant fork of OpenOSRS. This client is slightly modified in order to be compatible with our api. Updates to OpenOSRS are directly synced with this fork.

All existing OpenOSRS or RuneLite plugins ARE compatible with this client.

Features

Extended RuneLite API

  • RuneLite classes such as Actor, TileObject, Item, are extended with an Interactable api, which allow interaction with the object (ex. NPC.interact("Attack"))
  • Mixins are customized and optimized for the api & client

OpenOSRS extensions

  • The external plugin manager now also supports private GitHub repositories.

Definitions/Compositions

  • Methods such as getName(), getActions(), etc. of Items, TileObjects and NPCs rely on retrieving their composition from the client, which in some cases needs to be run on the client thread. We have modified the client in such a way that compositions get cached, so that client thread lookups are only needed if the composition is not cached. This allows for stuff like Widget.isVisible() and TileObject.getName() to work off client thread.

Packets

  • Our api exposes most of the available client packets, which can be used to for example directly send interactions to the server. An example use case is stacking multiple npc dialogs in one tick (Example)
  • These packets are very easy to use with our Packet api. (ex. ItemPackets.createFirstAction(widget, id, slot).send())

Pathfinding

  • The client has a pathfinding api which covers the majority of the map. All collision data is crowdsourced using the internal Regions plugin. The data can be accessed from our backend.
  • Besides walking, Transports and Teleports are also supported.

Automation

  • The client has different methods of interaction: invokes, clicks, packets. Using the Interaction plugin, all sorts of interaction settings can be customized.
  • Our API has classes such as LoopedPlugin and TaskPlugin, for easy creation of automation plugins.

Natural mouse

  • The interaction api supports the NaturalMouse library. Can be toggled in the Interaction plugin.

Game API

  • We have a simplified game api that helps developers to retrieve things such as entities, inventories, widgets, etc. from the client. (ex. Inventory.getFirst("Coins") NPCs.getNearest("Goblin") Magic.cast("Wind strike") etc.)

Bot environment

  • The client can also be built as a typical bot client, meaning without all the RuneLite stuff such as plugins. The bot environment may be ideal for people who want to run a script and preserve cpu/ram usage.
  • Check out the discord to see how to build using the bot environment.


There's much more that this fork offers which simply can't be fit into this small readme.

unethicalite's People

Contributors

adam- avatar deathbeam avatar owain94 avatar abextm avatar nightfirecat avatar xkylee avatar zeruth avatar ganom avatar thatgamerblue avatar lucwousin avatar therealnull avatar enriath avatar openosrs avatar buracc avatar f0rmatme avatar alexanderhenne avatar stone-wall avatar github-actions[bot] avatar sdburns1998 avatar lostworlds avatar srljustin avatar broooklyn avatar raiyni avatar sethtroll avatar kamielvf avatar thestonedturtle avatar magicftail avatar alexsuperfly avatar dekvall avatar psikoi avatar

Watchers

James Cloos 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.