Added the README

README.md

@@ -0,0 +1,41 @@
+# A first person cybertext shooter, written in Raconteur
+
+This game code is interesting because it shows almost every Undum/Raconteur
+feature there is (except for the plain action or writer links).
+
+Here's what you can see here:
+
+* Custom SASS styling using Bootstrap v4 framework
+* Splitting your game into several CoffeeScript files
+* Easy replacer cycling
+* International support
+* HTML5 sound effects with volume control
+* Graphical effects
+* Realtime timer
+* Menu dialogue section
+
+#### International support
+Did you know Undum has built-in i18n support?
+Well, now you can see how it works in a Raconteur game.
+It has about 1500 words, so it's a good example.
+
+#### The custom styling
+The default Undum styling is old and clumsy, you're supposed to write responsive CSS yourself.
+The default Raconteur scaffold uses LESS preprocessing but doesn't help much.
+I use SASS preprocessing + Bootstrap framework.
+The UI in this particular game is stripped for simplicity but it's easy to customize.
+Just don't use the progress bars.
+Please.
+
+#### Splitting your game
+See `Gulpfile.js.`
+The trick is to concatenate your files before every build.
+
+## MIT License
+Copyright © 2015 Alexander Yakovlev, http://en.oreolek.ru
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

game/begin.coffee

@@ -1,7 +1,3 @@
-# copyright (c) Alexander Yakovlev 2015.
-# This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.
-# To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0
-
 situation = require('raconteur')
 undum = require('undum-commonjs')
 oneOf = require('raconteur/lib/oneOf.js')

game/story.coffee

@@ -91,6 +91,7 @@ situation "shoot_pacifist",
   choices: ["#shoot"],
   before: (character, system) ->
     character.sandbox.shot_pacifist = 1
+    _paq.push(['setCustomDimension', 2, character.sandbox.shot_pacifist])
   content: (character, system) ->
     link = textcycle("head".l(), "leg")
     return "shoot_pacifist".l()(link)
@@ -104,6 +105,7 @@ situation "spare_pacifist",
   tags: "pacifist",
   before: (character, system) ->
     character.sandbox.shot_pacifist = 0
+    _paq.push(['setCustomDimension', 2, character.sandbox.shot_pacifist])
   choices: ["#shoot"],
   content: (character, system) ->
     return "spare_pacifist".l()
@@ -122,9 +124,9 @@ play_step = (volume) ->
 
 situation "finale",
   before: (character, system) ->
-     _paq.push(['setCustomDimension', 1, character.sandbox.shots])
-     _paq.push(['setCustomDimension', 2, character.sandbox.shot_pacifist])
-     _paq.push(['setCustomDimension', 3, character.sandbox.reloads])
+    _paq.push(['setCustomDimension', 1, character.sandbox.shots])
+    _paq.push(['setCustomDimension', 2, character.sandbox.shot_pacifist])
+    _paq.push(['setCustomDimension', 3, character.sandbox.reloads])
   choices: ["#finale"],
   content: (character, system) ->
     if character.sandbox.shots < 36

game/translations/en.coffee

@@ -283,7 +283,7 @@ module.exports.language =
     I shoot through his shiny metal #{link}.
     Another robot comes out the portal and knock him on the floor with a leg kick.
     Then it stomps on his head.
-    The weird android is turning into a puddle but his place is already taken by other, a normal one.
+    The weird robot is turning into a puddle but his place is already taken by other, a normal one.
   """
   spare_pacifist: """
     I put down the pistol.