# WaspLib
WaspLib is a library used to bot a popular MMORPG 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.


- - -

## Compiler Directives
```pascal
{$DEFINE WL_DISABLE_FAKE_INPUT}
{$DEFINE WL_READ_ONLY}
{$DEFINE WL_GENERATE_GRAPH_ALWAYS}
{$DEFINE WL_DEBUG_MAPLOADER}
{$DEFINE WL_DEBUG_MOUSE}
{$DEFINE WL_DEBUG_KEYBINDS}
{$DEFINE WL_DEBUG_UPTEXT}
{$DEFINE WL_DEBUG_INTERFACES}
{$DEFINE WL_DEBUG_MAP}
{$DEFINE WL_DEBUG_TRANSPORTER}
{$DEFINE WL_DEBUG_CHAT_LISTENER}
{$DEFINE WL_DEBUG_LEVELUP_LISTENER}
{$DEFINE WL_DEBUG_RECORDER}
```
These are the main compiler directives available in the library.

They should be self-explanatory.

`WL_READ_ONLY` makes WaspLib's setup send no input to the client: fake input is
disabled and the camera and options fixes done on login are skipped.

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/main.simba}
```
Otherwise WaspLib won't be aware of them.

```{eval-rst}
.. toctree::
  :maxdepth: 2
  :caption: MAIN -> LISTENERS

  levelup_listener
  listeners
  chat_listener

-----------

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

  biometrics
  antiban
  antibantasks

-----------

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

  entities
  map(main_position_map)
  mapdebugger
  mapnpcs
  mapobjects
  transporter
  objects(main_position_map)
  maploader

-----------

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

  imagemap

-----------

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

  houseutils
  house
  houseloader

-----------

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

  camera
  mm2ms
  projection

-----------

.. toctree::
  :maxdepth: 2
  :caption: MAIN

  dotfilters
  cacheparser
  walker
  overrides
  client
  fakeinput
  mousezoom

-----------

.. toctree::
  :maxdepth: 2
  :caption: MAIN -> FORMS

  inventory_form
  misc_form
  gear_form
  goals_form
  waspclient_form
  llm_form
  antiban_form
  prayer_form
  house_form
  recorder_form

-----------

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

  recorder_subprocess
  recorder

-----------

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

  itemfinder
  spellfinder
  overheadfinder
  house_layout_finder
  prayerfinder

-----------

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

  data

-----------

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

  xpbar
  sailing_minimap
  iteminterface
  debugging
  interface
  slotinterface
  minimap
  interfacecontrols
  chooseoption
  interfacearea

-----------

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

  inventory_layout
  consumables
  gear_layout

-----------

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

  lobby
  worldswitcher
  login

-----------

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

  make
  chattabs
  chat
  chatoptions

-----------

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

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

-----------

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

  hpbars
  colorfinder
  hitsplats

-----------

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

  grandexchange_chat
  grandexchange_history
  grandexchange
  grandexchange_offer

-----------

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

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