ircyrano

reenact cyrano de bergerac on an IRC server
git clone https://a3nm.net/git/ircyrano/
Log | Files | Refs | README

README (2030B)

      1 This is the code used to reenact Cyrano de Bergerac on IRC, cf
      2 <https://inutile.club/index.php?n=Activites.Cyrano> for details.
      3 
      4 To run it, you should install irctk <https://a3nm.net/git/irctk> and compile
      5 writer.c with "gcc -o writer writer.c" (sorry about the warning). Then, tweak in
      6 run.sh the path to irctk. Run it with:
      7 
      8   ./run.sh HOST characters script_final CHAN
      9 
     10 where HOST is the HOST and CHAN the channel of the IRC server. When prompted
     11 with "Waiting...", hit enter to start.
     12 
     13 The code will create many FIFOs in the folder (one per character). Note that
     14 copies of irctk may hang around after the end (or if interrupted), you can kill
     15 them with something like:
     16 
     17   ps aux | grep -- "/path/to/irctk/irctk -i 0 -R" | grep -v grep |
     18     awk '{print $2}' | xargs kill
     19 
     20 If you run into trouble, consider checking whether throttling on your IRC server
     21 is causing problems.
     22 
     23 Here are some explanations about the files:
     24 
     25 - Files required to reenact the performance:
     26 
     27   - run.sh: root program
     28   - writer.c: C program to write input lines on diverse FIFOs,
     29     used to send each message of the script to the corresponding irctk
     30     invocation.
     31   - script_final: final script for Cyrano de Bergerac
     32   - characters: description of the various characters
     33 
     34 - Files that were used at some point to prepare the script:
     35   (sorry, I don't have the exact pipeline I used for that, but it included
     36   manual intervention)
     37 
     38   - length.pl: used so that the "..." used to split verses are neatly aligned in
     39     a reasonable IRC client like irssi (taking into account nick length, etc.)
     40   - mkscript.sh: probably used to add some final annotations(?)
     41   - prefix.pl: probably identify what should be said as stage directions, some
     42     allocated to characters, some allocated to ER (for Edmond Rostand), who
     43     reads off general purpose stage directions
     44   - wellformed.py: used to sanity-check that a script file makes sense and
     45     identify possible errors
     46 
     47 - Misc files:
     48 
     49   - announce: see https://inutile.club/index.php?n=Activites.Cyrano
     50