commit 24dc703040371ffcbb2a04d8b37934e5ec5fe91f
parent 42149314212f1e9735c0324779c9f2de0815040f
Author: Antoine Amarilli <a3nm@a3nm.net>
Date: Wed, 3 Aug 2016 14:47:03 +0200
README
Diffstat:
| README | | | 50 | ++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 50 insertions(+), 0 deletions(-)
diff --git a/README b/README
@@ -0,0 +1,50 @@
+This is the code used to reenact Cyrano de Bergerac on IRC, cf
+<http://inutile.club/index.php?n=Activites.Cyrano> for details.
+
+To run it, you should install irctk <https://a3nm.net/git/irctk> and compile
+writer.c with "gcc -o writer writer.c" (sorry about the warning). Then, tweak in
+run.sh the path to irctk. Run it with:
+
+ ./run.sh HOST characters script_final CHAN
+
+where HOST is the HOST and CHAN the channel of the IRC server. When prompted
+with "Waiting...", hit enter to start.
+
+The code will create many FIFOs in the folder (one per character). Note that
+copies of irctk may hang around after the end (or if interrupted), you can kill
+them with something like:
+
+ ps aux | grep -- "/path/to/irctk/irctk -i 0 -R" | grep -v grep |
+ awk '{print $2}' | xargs kill
+
+If you run into trouble, consider checking whether throttling on your IRC server
+is causing problems.
+
+Here are some explanations about the files:
+
+- Files required to reenact the performance:
+
+ - run.sh: root program
+ - writer.c: C program to write input lines on diverse FIFOs,
+ used to send each message of the script to the corresponding irctk
+ invocation.
+ - script_final: final script for Cyrano de Bergerac
+ - characters: description of the various characters
+
+- Files that were used at some point to prepare the script:
+ (sorry, I don't have the exact pipeline I used for that, but it included
+ manual intervention)
+
+ - length.pl: used so that the "..." used to split verses are neatly aligned in
+ a reasonable IRC client like irssi (taking into account nick length, etc.)
+ - mkscript.sh: probably used to add some final annotations(?)
+ - prefix.pl: probably identify what should be said as stage directions, some
+ allocated to characters, some allocated to ER (for Edmond Rostand), who
+ reads off general purpose stage directions
+ - wellformed.py: used to sanity-check that a script file makes sense and
+ identify possible errors
+
+- Misc files:
+
+ - announce: see http://inutile.club/index.php?n=Activites.Cyrano
+
