code.pablomurad.com

prami-pet

Community virtual pet that lives as a Mastodon account

README.md raw 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# Prami

A federated community virtual pet that lives as a Mastodon account. It polls for
mentions, replies to commands, drifts its state over time, and posts on its own now
and then.

## Run

```bash
cp .env.example .env
# set MASTODON_BASE_URL, MASTODON_ACCESS_TOKEN and BOT_ACCOUNT_ACCT
docker compose up -d
docker compose logs -f prami
```

Stop with `docker compose stop`. Reset the database with `docker compose down -v`.

## Try it locally first (no Mastodon needed)

```bash
python -m prami.cli status
python -m prami.cli feed --user @alice@example.com
python -m prami.cli shell
```

Full guide: [docs/local-testing.en.md](docs/local-testing.en.md) ·
[docs/local-testing.pt-br.md](docs/local-testing.pt-br.md)

## Documentation

Start at the [docs index](docs/README.md). Highlights:
- [Local testing](docs/LOCAL_TESTING.md) — drive Prami with no Mastodon
- [Game design](docs/GAME_DESIGN.md) — stats, commands, social features
- [Moderation & safety](docs/MODERATION.md) — favourites, boosts, teach approval
- [Admin commands](docs/ADMIN_COMMANDS.md) — runtime controls
- [Mastodon setup](docs/MASTODON_SETUP.md) — going live

## License

AGPL-3.0-or-later. See [LICENSE](LICENSE).