Metadata-Version: 2.4
Name: larp-lib
Version: 0.4.1
Summary: Look like you know what you're doing.
Author: Montgomery Brown
License: MIT
Project-URL: Repository, https://github.com/MintyTheCoder/larp-lib
Keywords: terminal,cli,fun,prank,ascii,demo
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Terminals
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# larp

Zero-dependency, stdlib-only terminal (and optional GUI) eye-candy. Loading
bars that go nowhere, fake boot sequences, matrix rain, glitch reveals,
live "metrics" dashboards, fabricated stack traces, a technobabble
generator, and a matching CLI. For demos, streams, screen recordings, and
anyone who needs to look extremely busy for four seconds.

## Two ways to use this

**No coding required** — run pre-built effects straight from a terminal:

```
pip install larp-lib
larp boot --name REACTOR
```

Full command list: **[docs/CLI.md](docs/CLI.md)**

**Write your own scripts** — import the library, call its functions with
your own content, and actually learn some Python while you do it:

```python
import larp

larp.banner("PROJECT CHIMERA")
larp.boot_sequence("CHIMERA", steps=["Linking libchimera.so", "Flashing bootloader"])
```

Full function reference + a from-scratch walkthrough: **[docs/GUIDE.md](docs/GUIDE.md)**

Short version of the difference: the CLI is larp's functions with the
arguments already filled in for you. Writing a script is filling them in
yourself.

## Install

```
pip install larp-lib
```

For local development: `pip install -e .` from the repo root.

## GUI

`from larp import gui` gets you fake installers, splash screens, toast
notifications, and a fullscreen BSOD gag — needs tkinter (bundled with
Windows/Mac Python, `sudo apt install python3-tk` on Linux). Covered in
[docs/GUIDE.md](docs/GUIDE.md#gui-vs-terminal) and [docs/CLI.md](docs/CLI.md#gui-requires-tkinter).

## Demos

`demos/` has scripted showcases. `python demos/showcase.py [name|all]` runs
everything back to back — useful for recording a GitHub README gif.

## Tests

```
pip install pytest
pytest
```

## Project layout

```
larp/
  effects.py    loading, boot_sequence, glitch_text, banner, countdown, notification
  terminal.py   hacker_typer, fake_terminal, matrix_rain, network_scan
  codegen.py    code_scroll, print_stack_trace, commit_log
  dashboard.py  dashboard, multi_progress
  jargon.py     babble, term, commit_message, pr_title, var_name, stack_trace
  gui.py        tkinter windows: installer, splash, dialog, bsod, terminal, matrix, toast, dashboard
  cli.py        argparse CLI wiring every function above, including gui-* subcommands
docs/
  CLI.md        every CLI command, its flags, and an example
  GUIDE.md      library usage, function reference, and a learn-to-code walkthrough
```
