# WaspLib
WaspLib is a library used to bot OldSchool RuneScape with Simba 2.0.
WaspLib is heavily inspired in previous work done by the SRL Community.

This library is meant to do the job of both [SRL-T](https://github.com/Torwent/SRL-T)
and the original [WaspLib](https://github.com/Torwent/WaspLib) in Simba 1.4 in a lighter,
less confusing way.


- - -

## Compile Directives
```pascal
{$DEFINE WL_DEBUG_MOUSE}
{$DEFINE WL_DISABLE_FAKE_INPUT}
{$DEFINE WL_KEYBINDS_DEBUG}
{$DEFINE WL_DEBUG_UPTEXT}
{$DEFINE WL_DEBUG_INTERFACES}
{$DEFINE WL_GENERATE_GRAPH_ALWAYS}
{$DEFINE WL_DEBUG_MAP}
{$DEFINE WL_TRANSPORTER_DEBUG}
```
These are the main compiler directives available in the library.

They should be self-explanatory.

You also have the following to override versions, for more information read {ref}`Version`
```pascal
{$DEFINE SCRIPT_SIMBA_VERSION := 'version_hash'}
{$DEFINE SCRIPT_WASPLIB_VERSION := 'version_hash'}
```

For the {ref}`WaspClient` you also have the following:
```pascal
{$DEFINE WASP_LOCAL_DEVELOPMENT}
{$DEFINE WASP_REFRESH_TOKEN := 'refresh_token'}
{$DEFINE SCRIPT_ID := 'script_UUID'}
{$DEFINE SCRIPT_REVISION := 'script_revision'}
```
They also should be self-explanatory but you can read more about them in
{ref}`WaspClient`.

All of the directives above must be added **before** including the library to
use them, for example:
```pascal
{$DEFINE WL_DISABLE_FAKE_INPUT}
{$I WaspLib/osrs.simba}
```
Otherwise WaspLib won't be aware of them.

```{eval-rst}
.. toctree::
  :maxdepth: 2
  :caption: OSRS

  mousezoom
  rsclient
  walker
  fakeinput
  cacheparser
  miscform
  overrides
  dotfilters

-----------

.. toctree::
  :maxdepth: 2
  :caption: OSRS -> FINDERS

  overheadfinder
  prayerfinder
  spellfinder
  itemfinder
  house_layout_finder

-----------

.. toctree::
  :maxdepth: 2
  :caption: OSRS -> ANTIBAN

  antiban
  antibantasks
  antibanform
  biometrics

-----------

.. toctree::
  :maxdepth: 2
  :caption: OSRS -> RECORDER

  recorder_subprocess
  recorder

-----------

.. toctree::
  :maxdepth: 2
  :caption: OSRS -> POSITION

  imagemap

-----------

.. toctree::
  :maxdepth: 2
  :caption: OSRS -> POSITION -> HOUSE

  houseloader
  house
  houseutils
  house_form

-----------

.. toctree::
  :maxdepth: 2
  :caption: OSRS -> POSITION -> MAP

  objects
  mapjson
  entities
  maploader
  transporter
  mapdebugger
  map

-----------

.. toctree::
  :maxdepth: 2
  :caption: OSRS -> PROJECTION

  mm2ms
  camera
  projection

-----------

.. toctree::
  :maxdepth: 2
  :caption: OSRS -> INTERFACES

  interfacecontrols
  xpbar
  iteminterface
  chooseoption
  minimap
  interface
  interfacearea
  debugging
  sailing_minimap
  slotinterface

-----------

.. toctree::
  :maxdepth: 2
  :caption: OSRS -> INTERFACES -> HANDLERS

  inventory_layout
  gear_layout
  consumables
  gear_form
  inventory_form
  prayer_form

-----------

.. toctree::
  :maxdepth: 2
  :caption: OSRS -> INTERFACES -> GAMETABS

  options
  sailing
  achievements
  gametabs
  emotes
  friends
  worldswitcher
  stats
  music
  magic
  prayer
  inventory
  houseoptions
  logout
  combat
  equipment

-----------

.. toctree::
  :maxdepth: 2
  :caption: OSRS -> INTERFACES -> LOGIN

  worldswitcher(osrs_interfaces_login)
  login
  lobby

-----------

.. toctree::
  :maxdepth: 2
  :caption: OSRS -> INTERFACES -> CHAT

  make
  chattabs
  chatoptions
  chat

-----------

.. toctree::
  :maxdepth: 2
  :caption: OSRS -> INTERFACES -> MAINSCREEN

  cargohold
  mainscreen
  goldscreen
  houseviewer
  bankpin
  bank
  anvil
  collectionbox
  depositbox
  lamp
  shop
  silverscreen
  fairyring
  interface_template

-----------

.. toctree::
  :maxdepth: 2
  :caption: OSRS -> INTERFACES -> MAINSCREEN -> FINDERS

  hpbars
  hitsplats
  colorfinder

-----------

.. toctree::
  :maxdepth: 2
  :caption: OSRS -> INTERFACES -> MAINSCREEN -> GRANDEXCHANGE

  grandexchange
  grandexchange_offer
  grandexchange_chat
  grandexchange_history

-----------

.. toctree::
  :maxdepth: 2
  :caption: OSRS -> DATA

  data
```