Skip to main content

FAVELLA 1 — l'italiano come linguaggio di programmazione narrativa: scrivi, compila e gioca avventure testuali in italiano.

Project description

FAVELLA 1

FAVELLA 1 — versione 1.0.0 — L'italiano è il linguaggio di programmazione

FAVELLA 1 è un motore di gioco per narrativa interattiva (Interactive Fiction) che ti permette di creare mondi virtuali scrivendo semplici frasi in italiano.

È un progetto sperimentale con una missione ambiziosa: rendere lo sviluppo di avventure testuali accessibile a tutti, specialmente a scrittori e game designer, usando la lingua italiana come un vero e proprio linguaggio di programmazione.


✨ Filosofia

  • Il Codice è Prosa: Dimentica la sintassi complessa. Se puoi descrivere una scena, puoi programmarla. Esempio: La biblioteca è una stanza.
  • Semplicità per l'Autore: L'obiettivo è massimizzare la semplicità per chi scrive. Tutta la complessità tecnica è nascosta e gestita dal compilatore e dall'interprete di FAVELLA.
  • Sviluppo Iterativo: Il linguaggio è in costante evoluzione. Partiamo da un piccolo sottoinsieme della lingua italiana per poi espanderlo passo dopo passo, aggiungendo nuove funzionalità a ogni versione.

📦 Installazione

Dalla v0.29.0 FAVELLA è distribuita come installer multipiattaforma: scarica quello del tuo sistema dall'ultima Releasenon serve clonare il repo né installare Python.

Sistema File Note
Windows favella1-setup-*-windows-x64.exe installer; crea le scorciatoie nel Menu Start
macOS (Apple Silicon) favella1-*-macos-arm64.dmg trascina la cartella in Applicazioni
Linux favella1-*-linux-x86_64.AppImage rendi eseguibile e lancia

Dopo l'installazione:

favella1 gioca storia.fav        # gioca una storia
favella1 playground              # editor + motore nel browser (offline)
favella1 collaudo storia.fav     # collaudatore statico
favella1 compila storia.fav      # solo diagnostica
favella1 esporta storia.fav      # genera un .html giocabile e condivisibile

Gli eseguibili non sono firmati: al primo avvio accetta l'avviso di SmartScreen (Windows) o Gatekeeper (macOS). Dettagli e procedura di rilascio in PACKAGING.md.

Oppure con pip (per chi ha Python ≥ 3.10)

pip install favella1
favella1 versione
favella1 galleria              # le storie brevi incluse
favella1 galleria gioca il-faro
favella1 libreria              # i moduli .fav riusabili

Il pacchetto pip porta con sé la libreria standard di moduli Includi-bili e la galleria di storie (vedi sotto): favella1 libreria copia <nome> e favella1 galleria copia <id> te li copiano nella cartella corrente.


🏁 Stato Attuale: v1.0.0 — Il linguaggio è completo e definitivo

FAVELLA 1 ha raggiunto la versione 1.0.0: il linguaggio è dichiarato completo e chiuso. Sono stati portati a termine i Livelli 1-8 della roadmap, il Consolidamento (v0.18.0), l'intero Asse A — «Il mondo vivo» (v0.19.0→v0.26.0), una revisione totale di solidità (v0.27.0→v0.28.1) e tutte le espansioni del piano di completamento: il Cassetto A (v0.30.0) e i quattro Temi — Tema 1 «i contatori si parlano» (v0.31.0), Tema 2 «casualità d'autore» (v0.32.0), Tema 4 «il mondo che cambia in scena» (v0.33.0) e Tema 3 «lo stato che parla allo stato» (v0.34.0). La 1.0.0 non introduce modifiche di grammatica rispetto alla 0.34.0: è il traguardo che sancisce la maturità del linguaggio.

La grammatica resta LALR(1) non ambigua per costruzione (parser a due passate: symbol-table → LALR con i nomi come token chiusi), con una guardia anti-ambiguità permanente nella suite (verifica Earley a zero alberi ambigui). Suite di 681 asserzioni del linguaggio + 43 del collaudatore statico, tutte verdi (pytest: 312 passati). Spec tecnica: documentazione/grammatica-1.0.0.md.

Da qui in avanti l'evoluzione del progetto è di ecosistema (distribuzione, libreria di moduli Includi-bili, galleria di storie, pacchetto installabile), non più di linguaggio. I Temi 5a (quantità con plurali) e 5b (template di entità) restano deliberatamente fuori: la semplicità per l'autore è una feature (una scorta è già esprimibile come contatore; vedi il CHANGELOG).

Capacità del linguaggio (panoramica)

  • Italiano ricco: copula plurale, genitivi/partitivi, preposizioni articolate, accenti affidabili (NFC) nei nomi; dire opzionale nelle regole a sola conseguenza.
  • Espressività: condizione e teletrasporto sulla posizione del giocatore; testo d'esito personalizzato (vinci "Sei libero!"); negazione di gruppi non ( A e B ); verbi personalizzati anche multi-parola; sinonimi di verbo.
  • I contatori si parlano (Tema 1): una quantità può essere un numero, il valore di un altro contatore o un'estrazione casuale — diminuisci la vita di [forza], … di un numero fra 2 e 6; confronti fra grandezze dinamici — se la vita è meno di [soglia].
  • Casualità d'autore (Tema 2): scelta casuale fra valori di stato — il meteo diventa uno fra sereno, pioggia, nebbia; condizione probabilistica — Ogni turno se càpita (1 su 4): …. Tutto riproducibile e ANNULLA-safe.
  • Mondo che cambia in scena (Tema 4): buio commutabile — la radura diventa buia/illuminata; battuta di dialogo condizionale — Anna al nodo "x" dice "…" se ….
  • Lo stato parla allo stato (Tema 3): indirezione fra stati — copia il corteggiato diventa il preferito e confronto se il corteggiato è come il preferito.
  • Mondo vivo: stati e contatori, eventi a tempo, demoni (if-then autonomi), buio/luce, NPC che si muovono, dialoghi ramificati, pronomi/anafora, ANNULLA/ANCORA.

Storia completa in CHANGELOG.md. Le sezioni seguenti documentano le tappe precedenti della roadmap.

📌 Versioni (linea unica)

Dalla v0.18.0 il progetto adotta un unico numero di versione per tutto il linguaggio: non esiste più uno schema separato «Grammatica vX». Motore, compilatore e specifica della grammatica avanzano insieme (fonte di verità: strutture.VERSIONE_MOTORE).

Componente Versione Riferimento
Motore / interprete (gioco.py) 1.0.0 header di modulo
Compilatore (compilatore.py) 1.0.0 header di modulo
Strutture dati (strutture.py) 1.0.0 VERSIONE_MOTORE + Mondo.__str__
Libreria azioni (libreria_azioni.py) 1.0.0 header di modulo
Collaudatore statico (collaudo.py) 1.0.0 usa VERSIONE_MOTORE
Specifica formale della grammatica 1.0.0 documentazione/grammatica-1.0.0.mdgrammatica invariata dalla 0.34.0
Suite di test 1.0.0 681 asserzioni linguaggio + 43 collaudo (pytest 312)
Sidecar di compilazione (favella_server.py) VERSIONE_MOTORE 1.0.0

La 1.0.0 è una milestone: la grammatica è invariata rispetto alla 0.34.0, quindi la spec di traguardo grammatica-1.0.0.md ne è una copia con la nota di chiusura. Le etichette di versione più vecchie nelle sezioni storiche qui sotto (es. «Grammatica v0.4.0», «v0.7.0») sono conservate come cronaca e non riflettono lo stato attuale, che è v1.0.0 su tutta la linea. Il manuale d'autore completo, in PDF tipografico, è in documentazione/manuale/ (manuale.pdf) — la 2ª edizione è allineata alla v0.29.0 e verrà rigenerata sul linguaggio 1.0.0.


Stato storico: v0.7.0 — Disambiguazione Strutturale (Alpha)

Il progetto segue una roadmap evolutiva del linguaggio in 6 livelli. La v0.7.0 completa il Livello 2.5 — Disambiguazione strutturale: la grammatica di FAVELLA è ora non ambigua per costruzione. Il compilatore è stato riscritto in due passate (symbol-table → parsing LALR(1) con i nomi come token chiusi), eliminando alla radice l'ambiguità formale [G1] che prima era solo mitigata da priorità di regola.

Novità del Linguaggio (v0.7.0 — Livello 2.5)

  • Grammatica non ambigua per costruzione: parser LALR(1) + entità risolte da una symbol-table (longest-match). Un corpus che prima generava fino a 7 alberi per frase ora ne produce uno solo (guardia anti-ambiguità permanente nei test).
  • Errori d'autore chiari: un'entità mai dichiarata dà «Entità sconosciuta: "porta" non è mai stata dichiarata…» (con suggerimento del nome corretto in caso di refuso), non più un parse error criptico.
  • Nomi con parole-chiave finalmente usabili: via est, cosa preziosa, porta di ferro.
  • Nota: le proprietà di stato sono ora monoparola (è chiusa); i nomi multiparola restano supportati per le entità (cella di contenimento).

Dal Livello 2 (v0.6.0 — Logica Composita)

  • Condizioni AND / OR: se la porta è chiusa e il giocatore ha la chiave, se la cassa è chiusa oppure è sigillata. Precedenza OR < AND < atomo, con parentesi per raggruppare. (Si usa oppure, non o, riservato a ovest.)
  • Negazione: se il giocatore non ha la chiave, se la porta non è aperta.
  • Conseguenze multiple: ... e adesso la porta è aperta e adesso la chiave è nel nulla.

Già presenti dal Livello 1 (v0.5.0)

  • Posizione iniziale esplicita: Il giocatore comincia in [stanza].
  • Diagnostica d'autore: avvisi su refusi nelle proprietà, verbi sconosciuti, condizioni sempre false.
  • Grammatica disambiguata + suite di test (python test_linguaggio.py), stringhe con escape, tolleranza tipografica.

Core del Linguaggio (storico — etichettato all'epoca «Grammatica v0.4.0»)

  • Conservazione dell'Estetica Originale: I nomi di stanze e oggetti conservano gli articoli e la capitalizzazione originali scritti dall'autore (es. "Una keycard magnetica", "La cella di contenimento"), pur mantenendo l'ID normalizzato per la logica.
  • Preposizioni Tolleranti: Tolleranza ed eliminazione del problema "guess-the-preposition" nei comandi a due oggetti (es. usa la keycard con la porta si mappa automaticamente a usa la keycard su la porta).
  • Conseguenze Dinamiche: Regole che modificano il mondo (... e adesso la porta è aperta).
  • Interazioni a Due Oggetti: Supporto per comandi come usa chiave con porta.
  • Logica Condizionale: Supporto completo per regole Invece di ... se ....
  • Mondo Dinamico: Stanze, oggetti, contenitori e proprietà.

🎮 Come Iniziare

FAVELLA si usa da riga di comando: il compilatore e l'interprete sono in Python puro (unica dipendenza: lark). Esempi pronti in esempi/ — su tutti la demo ufficiale «Il Relitto Silente» in esempi/demo/relitto-silente/ e una storia con un errore voluto in esempi/test debug/storia-con-errore.fav.

  1. Clona il Repository:

    git clone https://github.com/Pitz72/FAVELLA1.git
    cd FAVELLA1
    
  2. Scrivi la tua Storia: Apri il file storia.fav con un editor di testo e modificalo, oppure creane uno nuovo. Esempio con puzzle:

    # Definizione del mondo
    La prigione è una stanza.
    La descrizione della prigione è "Una cella umida con una porta di ferro a nord.".
    
    # Oggetti interattivi
    Una porta di ferro è una cosa.
    La porta di ferro è in prigione.
    La porta di ferro è chiusa.
    
    Una chiave arrugginita è una cosa.
    La chiave arrugginita è in prigione.
    La chiave arrugginita è prendibile.
    
    # Regole condizionali per creare un puzzle
    # IMPORTANTE: Usa sempre la forma imperativa (apri, non aprire)
    Invece di apri la porta di ferro: dire "È chiusa a chiave.".
    Invece di apri la porta di ferro se il giocatore ha la chiave arrugginita: dire "La porta si apre!".
    
  3. Esegui il Gioco: Lancia il gioco dal terminale, passandogli il nome del tuo file di storia:

    python gioco.py esempi/demo/relitto-silente/relitto.fav
    

    Apparirà il mondo che hai creato (o la demo ufficiale, se lanci quella). Inserisci comandi come:

    • nord o n per muoverti tra le stanze
    • prendi chiave per raccogliere oggetti
    • inventario o i per vedere cosa possiedi
    • esamina porta per ispezionare oggetti
    • apri porta per interagire (le regole condizionali reagiranno al contesto!)
    • guarda per ristampare la descrizione della stanza
    • aiuto per vedere tutti i comandi disponibili

    Per uscire, digita esci.

  4. Esempio di Gameplay:

    > apri porta
    È chiusa a chiave.
    
    > prendi chiave
    Preso: chiave arrugginita.
    
    > apri porta
    Usi la chiave arrugginita. La serratura scatta e la porta si apre!
    

    Le regole condizionali reagiscono automaticamente allo stato del gioco!


🗺️ Roadmap

Il linguaggio è completo: con la v1.0.0 è dichiarato chiuso e definitivo. Sono stati portati a termine i Livelli 1-8, il Consolidamento (v0.18.0), l'intero Asse A — «Il mondo vivo» (v0.19.0→v0.26.0), la revisione totale di solidità (v0.27.0→v0.28.1) e tutte le espansioni del piano di completamento (Cassetto A v0.30.0 + Temi 1-4 e Tema 3, v0.31.0→v0.34.0). Sono disponibili azioni a due oggetti (usa X su Y, con clausola se), condizioni composte (AND/OR/NOT con parentesi), contenitori e supporti, modifiche dinamiche del mondo (e adesso …), stati e contatori che si parlano (aritmetica e confronti fra grandezze), casualità d'autore (estrazioni, scelte di stato, probabilità), indirezione fra stati, buio commutabile e battute di dialogo condizionali, NPC con dialoghi ramificati e movimento, eventi a turni e demoni, pronomi/anafora e ANNULLA. Il percorso completo è in CHANGELOG.md e nei documenti per-versione in documentazione/.

L'evoluzione non riguarda più il linguaggio, ma il suo ecosistema:

  • Pacchetto installabile (pip install favella1), libreria standard di moduli Includi-bili (favella1/libreria/) e galleria di storie (favella1/galleria/) — fatti. Confezione PyPI pronta (pyproject.toml, LICENSE MIT), verificata con build + twine check e in venv pulito; la pubblicazione su PyPI è l'ultimo passo manuale (vedi PACKAGING.md).
  • 📘 Manuale d'autore rigenerato sul linguaggio 1.0.0 (oggi la 2ª edizione in PDF, in documentazione/manuale/, è allineata alla v0.29.0), con «La Casa di Via Stradivari» / «Il Relitto Silente» come esempi guida.
  • Eventuale internazionalizzazione e strumenti d'autore (l'IDE è in cantiere).

📝 Note per gli Autori

Convenzione Importante per le Regole:

Quando scrivi regole Invece di, usa sempre la forma imperativa del verbo (come la digiterebbe il giocatore):

CORRETTO:

Invece di apri la porta: dire "È chiusa.".
Invece di prendi la spada: dire "È troppo pesante.".
Invece di esamina il libro: dire "Le pagine sono vuote.".

ERRATO:

Invece di aprire la porta: dire "È chiusa.".
Invece di prendere la spada: dire "È troppo pesante.".
Invece di esaminare il libro: dire "Le pagine sono vuote.".

🤝 Contribuire

Questo progetto è un esperimento aperto. Se l'idea ti affascina, sei invitato a contribuire in qualsiasi modo: segnalando bug, suggerendo nuove funzionalità grammaticali o scrivendo codice. Apri una issue o una pull request per iniziare!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

favella1-1.0.0.tar.gz (183.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

favella1-1.0.0-py3-none-any.whl (141.4 kB view details)

Uploaded Python 3

File details

Details for the file favella1-1.0.0.tar.gz.

File metadata

  • Download URL: favella1-1.0.0.tar.gz
  • Upload date:
  • Size: 183.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for favella1-1.0.0.tar.gz
Algorithm Hash digest
SHA256 b35e08e0c5dda731b6cd7a5f66cef30206e18ab1883ca301543c93027b61d4a9
MD5 b1f59f52db352c71854c170a03392402
BLAKE2b-256 3d341785ee1195c28a45b3ac511e5de51306c4c8485ded2691a8b99d8ef76212

See more details on using hashes here.

File details

Details for the file favella1-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: favella1-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 141.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for favella1-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f92ca8f11b4c1208875c6924bcac33acbba9662c8c43d9d0bc62de93b021ea39
MD5 2db2b99aebcd3d487651f708b306a554
BLAKE2b-256 35a963f78f8e636af0536ec6539d175ab3ae0dc71ae6d5baa919159cb9207f96

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page