Metadata-Version: 2.4
Name: yreflow
Version: 0.2.4.dev20260427
Summary: Wolfery console client
Project-URL: Homepage, https://github.com/TenjouUtena/yreflow
Project-URL: Repository, https://github.com/TenjouUtena/yreflow
Project-URL: Bug Tracker, https://github.com/TenjouUtena/yreflow/issues
Author-email: Kredden <kredden@proactiveapathy.com>
License-Expression: MIT
License-File: LICENSE
Keywords: client,console,mud,textual,tui,wolfery
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Communications
Classifier: Topic :: Games/Entertainment :: Role-Playing
Requires-Python: >=3.11
Requires-Dist: base91>=1.0.1
Requires-Dist: httpx>=0.27
Requires-Dist: pillow>=12.1.1
Requires-Dist: pyspellchecker>=0.9
Requires-Dist: requests>=2.32.5
Requires-Dist: textual-image>=0.8.5
Requires-Dist: textual>=8.1.1
Requires-Dist: unicodeitplus>=0.3.1
Requires-Dist: websockets>=16.0
Provides-Extra: spellcheck-enchant
Requires-Dist: pyenchant>=3.2; extra == 'spellcheck-enchant'
Provides-Extra: spellcheck-macos
Requires-Dist: pyobjc-framework-cocoa>=10.0; extra == 'spellcheck-macos'
Description-Content-Type: text/markdown

# yreflow

A console client for [Wolfery](https://wolfery.com), built with [Textual](https://textual.textualize.io/).

Wolfery is a text-based roleplaying platform. yreflow gives you a terminal UI for connecting to it -- character selection, room navigation, chat commands, spellcheck, and Wolfery markup preview.

![Screenshot](docs/yreflow.png)


## Install

Requires Python 3.11+.    Requires the [uv](https://docs.astral.sh/uv/getting-started/installation/) installation tool.

```
uv tool install yreflow
```

Then run it:

```
yreflow
```

Or run it directly without installing:

```
uvx yreflow
```

## Usage

On first launch, yreflow shows a login screen. Enter your Wolfery username and password. After authentication, pick a character and you're in.

Type commands directly in the input bar. A few examples:

```
"Hello there!              # say something
:waves                     # pose an action
w Alice=Hey, over here     # whisper to someone
look                       # examine the room
go north                   # move through an exit
```

See [docs/COMMANDS.md](docs/COMMANDS.md) for the full command reference.

## Configuration

Settings are stored in `~/.config/yreflow/config.toml`. This file is created automatically on first login. See [docs/SECURITY.md](docs/SECURITY.md) for details on how credentials are handled.

## AI Disclosure

This project was developed with the assistance of [Claude Code](https://claude.ai/), Anthropic's AI programming tool.

## License

[MIT](LICENSE)
