Les montages de cache (RUN --mount) exigent BuildKit, que l'ancien docker-compose n'active pas. On s'en passe : la compilation n'est plus mise en cache entre deux constructions, mais l'image se construit partout. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> |
||
|---|---|---|
| crates | ||
| scripts | ||
| .dockerignore | ||
| .gitignore | ||
| Cargo.lock | ||
| Cargo.toml | ||
| Dockerfile | ||
| README.md | ||
README.md
show-me
Dessiner à plusieurs sur l'écran de celui qui stream, pour jouer ensemble à distance à des jeux d'énigmes ou de point and click.
Principe
Un joueur, l'hôte, partage son écran entier dans Discord. show-me affiche chez lui un overlay transparent où apparaissent les traits de tout le monde : comme ils sont sur son écran, tous les spectateurs du stream les voient, sans rien installer.
Les spectateurs qui veulent dessiner lancent show-me par-dessus la vidéo du stream. Leurs traits partent vers l'hôte par un petit serveur relais. Chez eux, un trait ne reste affiché qu'un instant (l'« écho »), le temps que la version dessinée chez l'hôte arrive par le stream.
Linux uniquement : Wayland (compositeurs gérant wlr-layer-shell) et Xorg.
Installation
cargo build --release
Deux binaires sont produits dans target/release/ : show-me (le client) et show-me-server
(le relais). Ils ne dépendent que de la libc.
Serveur relais
show-me-server --listen 127.0.0.1:7878
Le serveur parle WebSocket sans chiffrement : placez-le derrière un reverse proxy (Caddy, nginx)
qui fournit le wss://. Il ne conserve rien ; le code du salon sert de secret partagé.
Avec Docker
Le Dockerfile à la racine construit une image du serveur seul, qui écoute sur le port 7878 :
docker build -t show-me-server .
Extraits à ajouter à votre propre configuration, en remplaçant show-me.example.org par votre
domaine. Le service, dans votre docker-compose.yml :
show-me:
image: show-me-server
restart: unless-stopped
Avec Caddy, dans le même réseau Docker, ajoutez au Caddyfile :
show-me.example.org {
reverse_proxy show-me:7878
}
Avec Traefik, ajoutez plutôt ces labels au service, en adaptant les noms du point d'entrée et du résolveur de certificats aux vôtres :
labels:
- traefik.enable=true
- traefik.http.routers.show-me.rule=Host(`show-me.example.org`)
- traefik.http.routers.show-me.entrypoints=websecure
- traefik.http.routers.show-me.tls.certresolver=letsencrypt
- traefik.http.services.show-me.loadbalancer.server.port=7878
Les deux relaient les WebSockets sans réglage particulier. Les clients se connectent ensuite à
wss://show-me.example.org.
Utilisation
# L'hôte, qui partage son écran entier dans Discord
show-me run --server wss://show-me.example.org --room CODE --host
# Un spectateur
show-me run --server wss://show-me.example.org --room CODE
L'overlay ne capte ni la souris ni le clavier tant qu'on n'est pas en mode dessin. Il se pilote par des commandes, à lier à des raccourcis clavier du bureau :
| Commande | Effet |
|---|---|
show-me toggle |
entre ou sort du mode dessin |
show-me clear |
efface mes traits |
show-me clear --all |
efface les traits de tout le monde |
show-me mode auto [secondes] |
les traits s'estompent tout seuls (5 s par défaut) |
show-me mode manual |
les traits restent jusqu'à un « effacer » |
show-me calibrate |
spectateur : cale la zone de dessin sur la vidéo |
show-me calibrate reset |
spectateur : revient au calage plein écran |
show-me quit |
arrête l'overlay |
En mode dessin, un cadre de couleur entoure la zone : clic gauche maintenu pour tracer, clic droit pour un « ping » (cercle animé). Le mode d'effacement vaut pour tout le salon et se change à tout moment.
Options de show-me run : --name, --color rrggbb, --width (épaisseur du trait),
--echo-secs (durée de l'écho), --monitor N, --region x,y,largeur,hauteur,
--backend wayland|x11.
Caler la zone de dessin (spectateur)
Par défaut, show-me suppose que la vidéo du stream occupe tout l'écran. Si ce n'est pas le cas :
- Lancez
show-me calibrate. L'écran s'assombrit, et des repères blancs apparaissent aux quatre coins de l'écran de l'hôte, donc dans la vidéo. - Glissez la souris d'un repère au repère opposé. Le rectangle est ajusté aux proportions de l'écran de l'hôte ; recommencez autant de fois que nécessaire.
- Validez par un clic droit.
La zone est enregistrée dans ~/.config/show-me/region et reprise aux lancements suivants.
Selon le système d'affichage
- Wayland : le compositeur doit gérer wlr-layer-shell (Sway, Hyprland, niri, River, KDE ; pas
GNOME). Liez les commandes dans sa configuration, par exemple sous Sway
bindsym $mod+d exec show-me toggle. - Xorg : la transparence exige un compositeur (intégré à Cinnamon, KDE, Xfce ;
picomsinon). Liez les commandes dans les raccourcis clavier du bureau.
Limites connues
- L'hôte doit partager son écran entier : une capture de fenêtre ne contient pas l'overlay.
- Le serveur ne garde pas d'historique : un hôte qui relance show-me perd les traits affichés.
- Sous Wayland avec mise à l'échelle (HiDPI), les traits sont rendus à la résolution logique.
- Un changement de résolution en cours de route oblige à relancer show-me.
- Pas encore testé avec une capture Discord réelle ni par-dessus un jeu en plein écran.
Développement
crates/protocol: messages JSON échangés ; coordonnées normalisées de 0 à 1 par rapport à l'écran de l'hôte.crates/server: salons et diffusion.crates/client:scene.rs(traits, estompage, rendu),app.rs(boucle principale),net.rs(connexion au relais),ipc.rs(commandes locales),config.rs(zone enregistrée),backend/(une implémentation par système d'affichage).
cargo test
Le backend Wayland se teste sans session Wayland : Sway peut tourner sans écran
(WLR_BACKENDS=headless), on capture avec grim et on simule la souris avec
crates/client/examples/vptr.rs (cargo build --release --examples). Le XDG_RUNTIME_DIR
utilisé doit avoir un chemin court, sinon Sway ne peut pas créer son socket.
scripts/test-remote.sh MACHINE lance un test à deux machines : serveur et spectateur ici, hôte
Wayland (Sway dans une fenêtre) sur une seconde machine joignable en SSH.