Metadata-Version: 2.4
Name: screenstocks-bridge
Version: 0.2.0
Summary: Python client for the local Screen Stocks BepInEx bridge
License-Expression: MIT-0
Project-URL: Homepage, https://github.com/fuubox/screen-stocks-bridge
Project-URL: Documentation, https://github.com/fuubox/screen-stocks-bridge#readme
Project-URL: Repository, https://github.com/fuubox/screen-stocks-bridge
Project-URL: Issues, https://github.com/fuubox/screen-stocks-bridge/issues
Keywords: screen-stocks,bepinex,game-modding,bridge
Classifier: Development Status :: 3 - Alpha
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# Screen Stocks Python Bridge

The `screenstocks-bridge` package is a Python client for the local API exposed
by the Screen Stocks Bridge BepInEx plugin. It requires the plugin to be
installed in the game and the game to be running. The package itself does not
install or contact the game backend; it connects to the plugin on loopback.

## Install

```powershell
python -m pip install screenstocks-bridge
```

Install the matching BepInEx plugin from the
[GitHub releases](https://github.com/fuubox/screen-stocks-bridge/releases),
then launch Screen Stocks. The default bridge address is `127.0.0.1:48721`.
Read the token from `BepInEx/config/screenstocks.bridge.cfg` or the BepInEx
log.

## Connect

```python
from screenstocks_bridge import BridgeClient

with BridgeClient(token="YOUR_TOKEN") as bridge:
    state = bridge.snapshot()
    print(state["ready"], state["cash"])
    print(bridge.upgrades())
```

The client supports state and activity reads, trades, upgrade purchases, and
auto-action controls. See the
[bridge usage guide](https://github.com/fuubox/screen-stocks-bridge/blob/main/docs/bridge-usage.md)
for the full API and its online behavior.
