yreflow 0.1.0__tar.gz

yreflow-0.1.0/.gitignore

@@ -0,0 +1,17 @@
+# Samples
+/Samples/
+/logs/
+
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+.claude/
+test_http_auth.py

yreflow-0.1.0/.python-version

@@ -0,0 +1 @@
+3.11

yreflow-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kredden
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

yreflow-0.1.0/PKG-INFO

@@ -0,0 +1,83 @@
+Metadata-Version: 2.4
+Name: yreflow
+Version: 0.1.0
+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: httpx>=0.27
+Requires-Dist: pyspellchecker>=0.8
+Requires-Dist: textual>=8.0.0
+Requires-Dist: websockets>=16.0
+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.
+
+## Install
+
+Requires Python 3.11+.
+
+```
+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)

yreflow-0.1.0/README.md

@@ -0,0 +1,53 @@
+# 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.
+
+## Install
+
+Requires Python 3.11+.
+
+```
+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)

yreflow-0.1.0/config.toml.example

@@ -0,0 +1,8 @@
+# yreflow configuration
+# Place at ~/.config/yreflow/config.toml
+#
+# All settings are optional. The app works without a config file
+# (you'll be prompted to log in on startup).
+
+# Optional: skip the login screen by providing a token.
+# token = "your-wolfery-auth-token-here"

yreflow-0.1.0/docs/COMMANDS.md

@@ -0,0 +1,272 @@
+# Commands
+
+## Communication
+
+### say
+
+Send dialogue to everyone in the room.
+
+| Aliases | `say`, `"`, `\u201c`, `\u201d` |
+|---------|------|
+| Syntax  | `say <message>` or `"<message>` |
+
+```
+say Hello there!
+"Hello there!
+```
+
+### pose
+
+Perform an action or emote in the room (third-person narrative).
+
+| Aliases | `pose`, `:` |
+|---------|------|
+| Syntax  | `pose <action>` or `:<action>` |
+
+```
+pose waves hello
+:waves hello
+```
+
+### ooc
+
+Send an out-of-character message. Add `:` before the message for pose format.
+
+| Aliases | `ooc`, `>:`, `:>`, `>` |
+|---------|------|
+| Syntax  | `ooc <message>` or `ooc :<pose>` or `>:<pose>` or `><message>` |
+
+```
+ooc This is great!
+ooc :nods
+>:agrees
+>just chatting
+```
+
+### whisper
+
+Send a private message to a character in the room.
+
+| Aliases | `w`, `wh` |
+|---------|------|
+| Syntax  | `w <name>=<message>` |
+
+Modifiers before the message: `:` for pose, `>` for ooc, `:>` for both.
+
+```
+w Alice=Hello there!
+wh Bob=:waves
+w Alice=>ooc message
+```
+
+### page
+
+Send a private message (works cross-room).
+
+| Aliases | `p`, `m` |
+|---------|------|
+| Syntax  | `p <name>=<message>` |
+
+Modifiers before the message: `:` for pose, `>` for ooc.
+
+```
+p Alice=Can we talk?
+m Bob=:waves from afar
+```
+
+### address
+
+Direct speech to a specific character in the room.
+
+| Aliases | `address`, `@` |
+|---------|------|
+| Syntax  | `address <name>=<message>` or `@<name>=<message>` |
+
+Modifiers before the message: `:` for pose, `>` for ooc.
+
+```
+address Alice=This is for you
+@Bob=I'm speaking to you
+```
+
+## Movement
+
+### go
+
+Move through a named exit.
+
+| Aliases | `go` |
+|---------|------|
+| Syntax  | `go <exit>` |
+
+```
+go north
+go through door
+```
+
+### home
+
+Teleport to your character's home location.
+
+| Aliases | `home` |
+|---------|------|
+| Syntax  | `home` |
+
+### teleport
+
+Teleport directly to a named location by its key.
+
+| Aliases | `teleport`, `t` |
+|---------|------|
+| Syntax  | `teleport <location>` or `t <location>` |
+
+```
+t tavern
+teleport village
+```
+
+## Information
+
+### look
+
+Examine the current room, or a specific character.
+
+| Aliases | `look`, `l` |
+|---------|------|
+| Syntax  | `look` or `look <name>` |
+
+With no argument, shows the room name, description, exits, and area. With a name, shows that character's details (species, gender, description, tags).
+
+```
+look
+l Alice
+```
+
+### laston
+
+Check when a character was last online.
+
+| Aliases | `laston` |
+|---------|------|
+| Syntax  | `laston <name>` |
+
+```
+laston Alice
+```
+
+### whereat
+
+Display a tree of population in the current area and sub-areas.
+
+| Aliases | `wa`, `whereat` |
+|---------|------|
+| Syntax  | `wa` |
+
+## Social
+
+### lead
+
+Start leading a character (they will follow your movements).
+
+| Aliases | `lead` |
+|---------|------|
+| Syntax  | `lead <name>` |
+
+### follow
+
+Start following a character.
+
+| Aliases | `follow` |
+|---------|------|
+| Syntax  | `follow <name>` |
+
+### join
+
+Join a group led by another character.
+
+| Aliases | `join` |
+|---------|------|
+| Syntax  | `join <name>` |
+
+### summon
+
+Request a character to come to your location.
+
+| Aliases | `summon` |
+|---------|------|
+| Syntax  | `summon <name>` |
+
+## Character Management
+
+### profile
+
+Switch to a different character profile/form. With no argument, opens the profile selector. Matches by keyword first, then by name.
+
+| Aliases | `profile`, `morph` |
+|---------|------|
+| Syntax  | `profile` or `profile <profile-name>` |
+
+```
+profile
+morph wolf
+```
+
+### focus
+
+Highlight a character with a color in the UI.
+
+| Aliases | `focus` |
+|---------|------|
+| Syntax  | `focus <name>=<color>` |
+
+```
+focus Alice=red
+```
+
+### unfocus
+
+Remove a character highlight.
+
+| Aliases | `unfocus` |
+|---------|------|
+| Syntax  | `unfocus <name>` |
+
+## Session
+
+### status
+
+Set or clear your character's status message. No argument clears it.
+
+| Aliases | `status` |
+|---------|------|
+| Syntax  | `status` or `status <text>` |
+
+```
+status afk for 5 minutes
+status
+```
+
+### release
+
+Release/suspend your character (log them out).
+
+| Aliases | `quit`, `sleep` |
+|---------|------|
+| Syntax  | `quit` or `sleep` |
+
+### sweep
+
+Clear the room view.
+
+| Aliases | `sweep` |
+|---------|------|
+| Syntax  | `sweep` |
+
+## Name Matching
+
+Commands that target a character (`whisper`, `page`, `address`, `look`, `lead`, `follow`, `join`, `summon`, `focus`, `unfocus`, `laston`) use fuzzy name matching:
+
+1. Exact match (case-insensitive)
+2. Prefix match
+
+If no match or multiple matches are found, an error is shown.

yreflow-0.1.0/docs/SECURITY.md

@@ -0,0 +1,49 @@
+# Security
+
+How yreflow handles your credentials and connection to Wolfery.
+
+## Authentication Flow
+
+yreflow uses a two-step process:
+
+1. **First login** -- You enter your username and password in the login screen. The password is hashed client-side and sent over HTTPS to Wolfery's auth server. If successful, the server returns an auth token.
+2. **Subsequent launches** -- The token is reused automatically. No password prompt unless the token expires.
+
+## Password Handling
+
+Your password is **never stored** on disk. When you log in:
+
+- The password is hashed with SHA-256 and HMAC-SHA-256 before leaving your machine.
+- The hashes are sent over HTTPS (`https://auth.mucklet.com/login`).
+- The plaintext password exists only briefly in memory during the hashing step.
+
+## Token Storage
+
+After a successful login, the auth token is saved to:
+
+```
+~/.config/yreflow/config.toml
+```
+
+The token is stored as **plaintext** in this file. It is protected only by your operating system's file permissions. Anyone with read access to your home directory could read it.
+
+To remove a stored token, delete the `token` line from your config file or delete the file entirely.
+
+## Transport Security
+
+All network traffic uses TLS:
+
+- **Authentication**: HTTPS to `auth.mucklet.com`
+- **WebSocket**: WSS (TLS-encrypted) to `api.wolfery.com`
+
+No data is sent over unencrypted connections.
+
+## Token Expiry
+
+When a token expires, yreflow automatically clears it from the config file and shows the login screen again. No manual intervention is needed.
+
+## What Is Not Stored
+
+- Passwords (never written to disk)
+- Chat logs or message history
+- Other users' credentials or personal data

yreflow-0.1.0/pyproject.toml

@@ -0,0 +1,43 @@
+[project]
+name = "yreflow"
+version = "0.1.0"
+authors = [
+    { name="Kredden", email="kredden@proactiveapathy.com" }
+]
+readme = "README.md"
+description = "Wolfery console client"
+requires-python = ">=3.11"
+license = "MIT"
+keywords = ["mud", "textual", "console", "client", "wolfery", "tui"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: End Users/Desktop",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Communications",
+    "Topic :: Games/Entertainment :: Role-Playing",
+]
+dependencies = [
+    "textual>=8.0.0",
+    "websockets>=16.0",
+    "httpx>=0.27",
+    "pyspellchecker>=0.8",
+]
+
+[project.urls]
+Homepage = "https://github.com/TenjouUtena/yreflow"
+Repository = "https://github.com/TenjouUtena/yreflow"
+"Bug Tracker" = "https://github.com/TenjouUtena/yreflow/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project.scripts]
+yreflow = "yreflow.main:main"