outleap 0.8.2
Tools for using asyncio to control a Second Life viewer over the LEAP protocol
License: MIT License
Requires Python: >=3.8

# outleap

[![codecov](https://codecov.io/gh/SaladDais/outleap/branch/master/graph/badge.svg?token=FWRKJNNJSZ)](https://codecov.io/gh/SaladDais/outleap)

A Python library using asyncio to control a Second Life viewer over the LEAP protocol.

See <https://bitbucket.org/lindenlab/leap/src/main/> for more details on LEAP.

## Installing

`pip install outleap`, or `pip install -e .` to install from source.

If you want to use the LEAP REPL or UI inspector, do `pip install outleap[tools]`, or `pip install -e .[tools]`.

## Usage

Look in the "[examples](https://github.com/SaladDais/outleap/tree/master/examples)" directory.

You can run a LEAP script with `your_viewer --leap some_script.py` if you have the executable bit set.

```python
import asyncio
import sys

from outleap import LEAPClient, LLViewerControlAPI


async def amain():
    # Create a client speaking LEAP over stdin/stdout and connect it
    async with await LEAPClient.create_stdio_client() as client:
        # Use our typed wrapper around the LLViewerControl LEAP API
        viewer_control_api = LLViewerControlAPI(client)
        # Ask for a config value and print it in the viewer logs
        print(await viewer_control_api.get("Global", "StatsPilotFile"), file=sys.stderr)


asyncio.run(amain())
```

If you just want to play around with the LEAP APIs:

```bash
$ outleap-repl
# ... in another terminal ...
$ viewer --leap outleap-agent
```

will give you an interactive REPL with a LEAP `client` object, with all the
API wrappers already imported:

```ipython
>>> floater_api = LLFloaterRegAPI(client)
>>> floater_api.show_instance(name="preferences")
>>> window_api = LLWindowAPI(client)
>>> prefs_path = UIPath.for_floater("Preferences")
>>> pprint.pp(await window_api.get_info(prefs_path))
{'available': True,
 'class': '19LLFloaterPreference',
 'enabled': 1,
 'enabled_chain': 1,
 'path': '/main_view/menu_stack/world_panel/Floater View/Preferences',
 'rect': {'bottom': 234, 'left': 593, 'right': 1255, 'top': 762},
 'value': None,
 'visible': 1,
 'visible_chain': 1}
```

Similarly, there's an interactive UI tree inspector available through `outleap-inspector`.
It can be launched through `viewer --leap outleap-inspector`.

![Screenshot of outleap-inspector](https://github.com/SaladDais/outleap/blob/master/static/inspector_screenshot.png?raw=true)

## What viewers does LEAP even work in?

Due to the fact that LEAP has only historically been used internally for testing, or for
integration with the official viewer's updater, many viewers have disabled LEAP
both intentionally or accidentally.

The code in the upstream viewer also appears to refuse to launch LEAP scripts if the updater
isn't present, which I don't entirely understand. I can't compile it to check.

### Does it work in Firestorm?

No, the code to launch LEAP scripts is [commented out](https://vcs.firestormviewer.org/phoenix-firestorm/files/cf85e854/indra/newview/llappviewer.cpp#L1398-1420).
If you do your own build with those lines uncommented it'll work fine.

### Does it work in Alchemy?

[Probably not, and definitely not on Linux](https://git.alchemyviewer.org/alchemy/alchemy-next/-/blob/4f3b0d10e2f9db30e9e16bedbc4602b6d7bb5dda/indra/newview/llappviewer.cpp#L1183-1281).
Alchemy does the same SL updater presence checks as upstream before attempting to launch LEAP scripts, which
I imagine wouldn't succeed. Haven't tried.

### Does it work in LL's official viewer?

Yeah, probably.

### Does it work in `<other viewer>`?

No, probably not.

## Credits

The project scaffolding is based on code from https://github.com/MatthieuDartiailh/bytecode