Votre livre est un dossier que vous pouvez ouvrir sans nous.

Ce que contient le dossier

Le port/
  Manuscript/
    01 Arrivée/
      01 Le port.md
      02 La douane.md
  Notes/
  World/
    Characters/
      Hortense.md
  Templates/
  Inbox/
  .shiro/
  .trash/

Les noms de dossiers restent en anglais quelle que soit la langue de l’interface, car ils font partie du format. Les essais et les récits de vie ont Research/ à la place de World/. Les numéros en tête de nom donnent l’ordre, et ce qu’ils ne savent pas exprimer va dans .shiro/order.json. Une scène ressemble à ceci :

---
id: 7f3a9c
synopsis: Hortense débarque avec les mauvais papiers.
status: Premier jet
---

Le douanier regarda le tampon plus longtemps qu’un tampon ne le mérite.

Tous les mots sont là, dans des fichiers lisibles. .shiro/ garde ce qui les entoure : réglages du projet, instantanés, commentaires et registre de paternité. .trash/ conserve ce que vous supprimez, à son emplacement d’origine.

Un fichier brut n’est pas pour autant vierge de toute marque. En ouvrant une scène ailleurs, vous pourrez croiser des liens [[Hortense]] vers le Monde, des %%notes privées%% et des suggestions en CriticMarkup. Ce sont de simples caractères, faciles à retirer le cas échéant. Si Shiro disparaissait demain, il vous resterait un dossier rangé et une ponctuation étrange. Nous préférons que l’expérience n’ait pas lieu. Le code qui lit et écrit ce format est sous licence MIT, au cas où quelqu’un voudrait prendre le relais.

Modifier un fichier hors de Shiro

Ouvrez une scène dans Obsidian, dans VS Code ou dans le vieux logiciel de votre vieil ordinateur, puis enregistrez. La suite dépend de ce que faisait Shiro.

• La scène dormait. Shiro la recharge et vous le signale.
• Le texte a changé des deux côtés. Les modifications fusionnent à trois voies. Là où les mêmes mots ont changé des deux côtés, ceux de Shiro l’emportent et l’autre version devient un instantané.
• Vous étiez en pleine phrase quand le fichier a changé. L’enregistrement se met en pause et Shiro demande quelle version garder. Vous pouvez les comparer, et celle que vous écartez part dans les instantanés.

Dans tous les cas, aucune version ne se perd. Un texte modifié hors de Shiro compte comme non enregistré dans le registre de paternité, puisque Shiro n’était pas là pour le voir.

Hors ligne et sans compte

L’application de bureau tourne sur Mac, Windows et Linux sans compte, et n’appelle aucun serveur avant votre connexion. Nous le testons : un test de navigateur échoue si l’application envoie une requête hors de votre machine pendant que vous parcourez l’accueil, les lentilles et les réglages. Elle ne collecte aucune donnée d’usage et n’envoie aucun rapport de plantage. Un TER entre deux antennes est une configuration prise en charge.

Les instantanés automatiques et les sauvegardes zip restent sur votre disque, et vous pouvez ajouter des sauvegardes chiffrées protégées par une phrase secrète. Si vous voulez aussi de l’IA, elle peut tourner sur votre ordinateur.

Passer au cloud, et en revenir

Passer au cloud envoie le projet et ouvre désormais la copie cloud. Le dossier reste sur votre ordinateur en guise de sauvegarde, mais ce n’est plus le livre : il n’existe pas de synchronisation de dossier dans les deux sens, et ce que vous modifierez ensuite dans ces fichiers n’ira nulle part.

Un projet cloud est un document Yjs, fusionné caractère par caractère sans copies de conflit et gardé en cache sur chaque appareil. Vous pouvez l’ouvrir dans l’application web et écrire à plusieurs. L’historique remonte à 7 jours avec un compte gratuit, à 90 jours avec une formule payante.

Télécharger en dossier en refait un dossier Markdown à l’endroit de votre choix, puis retire la copie cloud. L’indication de qui a écrit quoi n’est pas conservée, car seuls les livres cloud la possèdent.

Les projets cloud ne sont pas chiffrés de bout en bout. Le serveur les lit pour assurer l’historique, les webhooks et les agents. Si vous écrivez le récit de vie que votre sœur n’a pas encore lu, ou quoi que ce soit que vous ne laisseriez pas sur le serveur d’un autre, restez en local. Un projet local reste sur votre disque, sauf décision contraire de votre part.

Les questions qu’on nous pose

Faut-il écrire en Markdown ?

Non. Vous écrivez dans un éditeur normal, avec italique, notes de bas de page et menu des commandes, et Shiro enregistre le résultat en Markdown. Vous ne croiserez la syntaxe qu’en ouvrant le fichier ailleurs.

Shiro fonctionne-t-il sans connexion ?

Oui. Sur Mac, Windows et Linux, l’application de bureau n’a besoin ni de connexion ni de compte pour les projets locaux. Elle n’appelle aucun serveur Shiro avant votre connexion.

Puis-je mettre mon livre dans Git ?

Oui. Les scènes sont des fichiers texte, donc les différences se lisent, et vous verrez ce que vous avez fait à la fin du livre en mars dernier.

Les projets cloud sont-ils chiffrés ?

Pas de bout en bout. Ils circulent sur des connexions chiffrées, mais le serveur de Shiro peut les lire, car l’historique, les webhooks et les agents en ont besoin. Si cela vous gêne pour ce livre, gardez le projet en local.