code.pablomurad.com

prami-pet

Community virtual pet that lives as a Mastodon account

docs/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
41
42
43
44
45
46
47
48
49
50
 
# Prami documentation

Index of everything under `docs/`. Most guides come in English and Portuguese.

## Using Prami (community)
How people interact with the pet through Mastodon mentions.
- English — [usage.en.md](usage.en.md)
- Português — [usage.pt-br.md](usage.pt-br.md)

## Local testing (developers)
Run and play with Prami locally via the CLI, with no Mastodon account, token, or server.
- English — [local-testing.en.md](local-testing.en.md)
- Português — [local-testing.pt-br.md](local-testing.pt-br.md)

## Personality
How Prami's tone shifts with its state, and how `PET_PERSONALITY` tunes it.
- English — [personality.en.md](personality.en.md)
- Português — [personality.pt-br.md](personality.pt-br.md)

## Voice & writing guide
For anyone writing response lines — core voice, rules, length, humor, 50+ examples, checklist.
- [VOICE_AND_PERSONALITY.md](VOICE_AND_PERSONALITY.md)

## Architecture
How the action system, registry, and command pipeline fit together (for contributors).
- [ARCHITECTURE.md](ARCHITECTURE.md)

## Game design
The full design — stats, commands, cooldowns, decay, social features, moderation, roadmap.
- [GAME_DESIGN.md](GAME_DESIGN.md)

## Moderation & safety
How favourites, boosts, and the moderated teach queue work, and every safety rule.
- [MODERATION.md](MODERATION.md)

## Admin commands
Runtime controls — pause, toggles, blocks, and reviewing taught memories.
- [ADMIN_COMMANDS.md](ADMIN_COMMANDS.md)

## Mastodon setup
Creating the account, token scopes, and the going-live checklist.
- [MASTODON_SETUP.md](MASTODON_SETUP.md)

## Local testing (full reference)
Every CLI command, including the social features.
- [LOCAL_TESTING.md](LOCAL_TESTING.md)

---

Setup and run instructions live in the [project README](../README.md).