# 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_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

  fakeinput
  cacheparser
  miscform
  overrides
  walker
  dotfilters
  rsclient
  mousezoom

-----------

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

  sailing_minimap
  minimap
  interface
  iteminterface
  interfacearea
  xpbar
  chooseoption
  slotinterface
  interfacecontrols

-----------

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

  login
  worldswitcher
  lobby

-----------

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

  prayer_form
  inventory_form
  gear_form
  consumables
  inventory_layout
  gear_layout

-----------

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

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

-----------

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

  chatoptions
  chattabs
  make
  chat

-----------

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

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

-----------

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

  hpbars
  colorfinder
  hitsplats

-----------

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

  grandexchange_chat
  grandexchange_history
  grandexchange_offer
  grandexchange

-----------

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

  antibantasks
  antiban
  antibanform
  biometrics

-----------

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

  prayerfinder
  overheadfinder
  itemfinder
  spellfinder
  house_layout_finder

-----------

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

  data

-----------

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

  houseutils
  house_form
  houseloader
  house

-----------

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

  transporter
  entities
  maploader
  mapdebugger
  mapjson
  map
  objects

-----------

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

  imagemap

-----------

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

  projection
  camera
  mm2ms
```