├── .travis.yml
├── .luacheckrc
├── main.lua
├── erogodic.lua
├── README.md
├── demo
    └── talkies.lua
└── spec.lua


/.travis.yml:
--------------------------------------------------------------------------------
 1 | language: python
 2 | sudo: false
 3 | 
 4 | env:
 5 |   - LUA="lua=5.1"
 6 |   - LUA="luajit=2.0"
 7 |   - LUA="luajit=2.1"
 8 | 
 9 | before_install:
10 |   - pip install hererocks
11 |   - hererocks lua_install -r^ --$LUA
12 |   - export PATH=$PATH:$PWD/lua_install/bin
13 | 
14 | install:
15 |   - luarocks install busted
16 |   - luarocks install luacheck
17 |   - luarocks install luacov
18 | 
19 | script:
20 |   - busted --verbose --coverage spec.lua
21 |   - luacheck .
22 | 
23 | after_success:
24 |   - luacov
25 |   - bash <(curl -s https://codecov.io/bash)
26 | 
27 | notifications:
28 |   email:
29 |     on_success: change
30 |     on_failure: always
31 | 


--------------------------------------------------------------------------------
/.luacheckrc:
--------------------------------------------------------------------------------
 1 | max_line_length = false
 2 | allow_defined = false -- Do NOT allow implicitly defined globals.
 3 | allow_defined_top = false -- Do NOT allow implicitly defined globals.
 4 | 
 5 | globals = {
 6 |   'get',
 7 |   'menu',
 8 |   'msg',
 9 |   'name',
10 |   'option',
11 |   'selection',
12 | }
13 | 
14 | files = {
15 |   ['erogodic.lua'] = {
16 |     std = 'luajit',
17 |   },
18 |   ['main.lua'] = {
19 |     std = 'luajit+love',
20 |     globals = {
21 |       'giveItem',
22 |     },
23 |   },
24 |   ['spec.lua'] = {
25 |     std = 'luajit+busted',
26 |     globals = {
27 |       'attr',
28 |       'characterName',
29 |       'effect',
30 |       'font',
31 |       'image',
32 |       'kaban',
33 |       'myMacro',
34 |       'mySubmacro',
35 |       'serval',
36 |       'undefinedGlobal',
37 |       'wifeName',
38 |     },
39 |   },
40 | }
41 | 
42 | exclude_files = {
43 |   'lua_install/*', -- CI: hererocks
44 |   'demo/*',
45 | }


--------------------------------------------------------------------------------
/main.lua:
--------------------------------------------------------------------------------
 1 | local Ero = require 'erogodic'
 2 | local script = Ero(function()
 3 |   name "Shopkeeper"
 4 |   msg "Thank you for rescuing my beloved tomboyish daughter!"
 5 |   local baklava = option "Delicious Baklava"
 6 |   local hamster = option "Loyal Hamster"
 7 |   menu "Select your reward"
 8 |   if selection(baklava) then
 9 |     giveItem("Baklava")
10 |   elseif selection(hamster) then
11 |     giveItem("Hamster")
12 |   end
13 |   msg "Also, take this powerful weapon!"
14 |   giveItem("Slightly-Rusted Dwarfbane +3")
15 |   msg "Farewell!"
16 | end)
17 |   :defineAttributes({
18 |     'name',
19 |   })
20 |   :addMacro('giveItem', function(item)
21 |     local lastName = get('name')
22 |     name ""
23 |     msg("You got the " .. item .. "!")
24 |     name(lastName)
25 |   end)
26 | 
27 | local Talkies = require 'demo.talkies'
28 | Talkies.backgroundColor = {1, 1, 1, 0.2}
29 | Talkies.textSpeed = 'medium'
30 | Talkies.font = love.graphics.newFont(24)
31 | 
32 | local displayMessageNode
33 | 
34 | local function nextMessage()
35 |   local node = script:next()
36 |   displayMessageNode(node)
37 | end
38 | 
39 | local function selectOption(selection)
40 |   local node = script:select(selection)
41 |   displayMessageNode(node)
42 | end
43 | 
44 | displayMessageNode = function(node)
45 |   if node == nil then
46 |     return -- Erogodic script is over.
47 |   end
48 | 
49 |   local config = {}
50 |   if node.options then
51 |     config.options = {}
52 |     for i, opt in ipairs(node.options) do
53 |       local onSelect = function()
54 |         selectOption(opt)
55 |       end
56 |       config.options[i] = {opt, onSelect}
57 |     end
58 |   else
59 |     config.oncomplete = nextMessage
60 |   end
61 |   Talkies.say(node.name, node.msg, config)
62 | end
63 | 
64 | function love.load()
65 |   nextMessage()
66 | end
67 | 
68 | function love.update(dt)
69 |   Talkies.update(dt)
70 | end
71 | 
72 | function love.keypressed(key)
73 |   if key == 'space' or key == 'return' or key == 'e' or key == 'z' then
74 |     Talkies.onAction()
75 |   elseif key == 'up' or key == 'w' then
76 |     Talkies.prevOption()
77 |   elseif key == 'down' or key == 's' then
78 |     Talkies.nextOption()
79 |   elseif key == 'escape' then
80 |     love.event.push('quit')
81 |   end
82 | end
83 | 
84 | function love.draw()
85 |   Talkies.draw()
86 |   if Talkies.isOpen() == false then
87 |     love.graphics.print('<Script Over>', 20, 20)
88 |   end
89 | end
90 | 


--------------------------------------------------------------------------------
/erogodic.lua:
--------------------------------------------------------------------------------
  1 | --[[
  2 | 
  3 | erogodic v3.0.0
  4 | ===============
  5 | 
  6 | A library for scripting branching interactive narrative by shru.
  7 | 
  8 | https://github.com/oniietzschan/erogodic
  9 | 
 10 | License
 11 | -------
 12 | 
 13 | shru-chan hereby dedicates this source code and associated documentation
 14 | (the "App") to the public domain. shru makes this dedication for the
 15 | benefit of the Gamers everywhere and to the detriment of trolls and bullies.
 16 | Anyone is free to copy, modify, publish, use, sell, distribute, recite in a
 17 | spooky voice, or fax the App by any means they desire, so long as they
 18 | adhere to one condition:
 19 | 
 20 | Please consider buying shru some ice cream. Azuki preferred, but all
 21 | flavours except Licorice will be accepted.
 22 | 
 23 | In jurisdictions that do not: (a) recognize donation of works to the public
 24 | domain; nor (b) consider incitement to be a legally enforcable crime: shru
 25 | advocates immediate forceful regime-change.
 26 | 
 27 | --]]
 28 | 
 29 | local function assertType(obj, expectedType, name)
 30 |   assert(type(expectedType) == 'string' and type(name) == 'string')
 31 |   if type(obj) ~= expectedType then
 32 |     error(name .. ' must be a ' .. expectedType .. ', got: ' .. tostring(obj), 2)
 33 |   end
 34 | end
 35 | 
 36 | local PUSHED_SCRIPT = 'PUSHED_SCRIPT'
 37 | 
 38 | local Script = {}
 39 | local ScriptMetaTable = {__index = Script}
 40 | 
 41 | function Script:new(scriptFn)
 42 |   assertType(scriptFn, 'function', 'script function')
 43 |   self._attributes = {}
 44 |   self._selection = nil
 45 |   self._options = {}
 46 |   self._onMenu = false
 47 |   self._scriptStack = {}
 48 |   self._argsStack = {}
 49 |   self:_initEnvironment()
 50 |   self:_pushScript(scriptFn)
 51 |   return self
 52 | end
 53 | 
 54 | function Script:_initEnvironment()
 55 |   local env = setmetatable({}, {__index = _G})
 56 |   function env.get(attribute)
 57 |     return self._attributes[attribute]
 58 |   end
 59 |   function env.menu(text)
 60 |     self._onMenu = true
 61 |     self:_yield({
 62 |       msg = text,
 63 |       options = self._options,
 64 |     })
 65 |   end
 66 |   function env.msg(text)
 67 |     self:_yield({msg = text})
 68 |   end
 69 |   function env.option(option)
 70 |     assertType(option, 'string', 'option')
 71 |     table.insert(self._options, option)
 72 |     return option
 73 |   end
 74 |   function env.selection(option)
 75 |     return (option == nil)
 76 |       and self._selection
 77 |       or self._selection == option
 78 |   end
 79 |   self._env = env
 80 | end
 81 | 
 82 | function Script:_pushScript(scriptFn, ...)
 83 |   setfenv(scriptFn, self._env)
 84 |   local scriptCoroutine = coroutine.create(scriptFn, ...)
 85 |   self._currentScript = scriptCoroutine
 86 |   self._currentArgs = {...}
 87 |   table.insert(self._scriptStack, scriptCoroutine)
 88 |   table.insert(self._argsStack, self._currentArgs)
 89 | end
 90 | 
 91 | function Script:_popScript()
 92 |   table.remove(self._scriptStack)
 93 |   table.remove(self._currentArgs)
 94 |   local len = #self._scriptStack
 95 |   self._currentScript = (len >= 1) and self._scriptStack[len] or nil
 96 |   self._currentArgs   = (len >= 1) and self._argsStack[len]   or nil
 97 | end
 98 | 
 99 | function Script:_yield(node)
100 |   for k, v in pairs(self._attributes) do
101 |     node[k] = v
102 |   end
103 |   coroutine.yield(node)
104 | end
105 | 
106 | function Script:addMacro(name, fn)
107 |   assertType(name, 'string', 'macro name')
108 |   assertType(fn, 'function', 'macro function')
109 |   self._env[name] = function(...)
110 |     self:_pushScript(fn, ...)
111 |     coroutine.yield(PUSHED_SCRIPT)
112 |   end
113 |   return self
114 | end
115 | 
116 | function Script:defineAttributes(attributeNames)
117 |   assertType(attributeNames, 'table', 'attributeNames')
118 |   for _, attrName in ipairs(attributeNames) do
119 |     assertType(attributeNames, 'table', 'attributeNames')
120 |     self._env[attrName] = function(val)
121 |       self._attributes[attrName] = val
122 |     end
123 |   end
124 |   return self
125 | end
126 | 
127 | function Script:extendEnvironment(t)
128 |   assertType(t, 'table', 'environment table')
129 |   for k, v in pairs(t) do
130 |     self._env[k] = v
131 |   end
132 |   return self
133 | end
134 | 
135 | function Script:select(selection)
136 |   for _, option in ipairs(self._options) do
137 |     if option == selection then
138 |       self._selection = selection
139 |       self._options = {}
140 |       self._onMenu = false
141 |       return self:next()
142 |     end
143 |   end
144 |   error("Selection '" .. selection .. "' was not one of the options.")
145 | end
146 | 
147 | function Script:next()
148 |   if self:hasNext() == false then
149 |     error('Script is finished.')
150 |   end
151 |   if self._onMenu then
152 |     return self._currentNode -- Can not skip a question.
153 |   end
154 |   local isRunning, result = coroutine.resume(self._currentScript, unpack(self._currentArgs))
155 |   if result == PUSHED_SCRIPT then
156 |     return self:next()
157 |   elseif isRunning == false then
158 |     error('Error executing script: ' .. tostring(result))
159 |   end
160 | 
161 |   self._currentNode = result
162 | 
163 |   if self:hasNext() == false then
164 |     self:_popScript()
165 |     if self._currentScript ~= nil then
166 |       return self:next()
167 |     end
168 |   end
169 | 
170 |   return self._currentNode
171 | end
172 | 
173 | function Script:hasNext()
174 |   return self._currentScript ~= nil and coroutine.status(self._currentScript) == 'suspended'
175 | end
176 | 
177 | return function(...)
178 |   return setmetatable({}, ScriptMetaTable)
179 |     :new(...)
180 | end
181 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # エロｇｏｄｉｃ
  2 | 
  3 | [![Build Status](https://travis-ci.org/oniietzschan/erogodic.svg?branch=master)](https://travis-ci.org/oniietzschan/erogodic)
  4 | [![Codecov](https://codecov.io/gh/oniietzschan/erogodic/branch/master/graph/badge.svg)](https://codecov.io/gh/oniietzschan/erogodic)
  5 | ![Lua](https://img.shields.io/badge/Lua-JIT%2C%205.1-blue.svg)
  6 | ![Public Domain](https://img.shields.io/badge/license-public%20domain-blue)
  7 | [![Alex](https://img.shields.io/badge/alex-never_racist-brightgreen.svg)](http://alexjs.com/)
  8 | 
  9 | Erogodic is a library for scripting branching interactive narrative in Lua. It aims to be suitable for any sort of game which needs some amount of dialogue or narration, including games which are comprised entirely out of dialog, like visual novels.
 10 | 
 11 | ![Example GIF](https://i.imgur.com/AjDqNCO.gif)
 12 | 
 13 | Erogodic aims to provide the "back-end" of a dialog system. You will need to implement your own message boxes, portraits, user-interaction, etc. For maximum flexibility, erogodic allows you to attach any amount of arbitrary data to each "message node".
 14 | 
 15 | Erogodic's scripts are written as pure Lua coroutines; this has a couple major benefits. Firstly, it should be extremely easy to trigger any of your game's functionalities depending on which dialogue options are chosen. Secondly, your scripts themselves can be highly dynamic: messages, choices, and more can be modified in real time in accordance to the status of your game world.
 16 | 
 17 | ## Demo
 18 | 
 19 | If you're a [LÖVE](https://love2d.org/) user, then check out `main.lua`. It's a simple demonstration of how you can use Erogodic. This demo makes use of [Talkies](https://github.com/tanema/talkies) in order to provide a message box. You could use Talkies yourself, or you could write your own messsage box.
 20 | 
 21 | ## Simple Example
 22 | 
 23 | ```lua
 24 | local Ero = require 'erogodic'()
 25 | 
 26 | local script = Ero(function()
 27 |   msg "Hello minasan. Which of these frozen desserts is your favourite?"
 28 |   option "Soft Serve"
 29 |   option "Shaved Ice"
 30 |   menu "Choose one:"
 31 |   if selection "Soft Serve" then
 32 |     msg "Too cold!!"
 33 |   elseif selection "Shaved Ice" then
 34 |     msg "Just right."
 35 |   end
 36 |   msg "Thanks for stopping by!"
 37 | end)
 38 | 
 39 | script:next()
 40 | -- Returns: {msg = "Hello minasan. Which of these frozen desserts is your favourite?"}
 41 | script:next()
 42 | -- Returns: {msg = "Choose one:",
 43 | --           options = {"Soft Serve", "Shaved Ice"}}
 44 | script:select("Shaved Ice")
 45 | -- Returns: {msg = "Just right."}
 46 | script:next()
 47 | -- Returns: {msg = "Thanks for stopping by!"}
 48 | script:next()
 49 | -- Returns: nil
 50 | ```
 51 | 
 52 | ## Attributes Example
 53 | 
 54 | Attributes are arbitrary properties which will be returned alongside `msg`. They can be set to any Lua value. Attributes might be suitable for messagebox titles, character portraits, text effects, or anything else you can imagine. You just gotta keep believing and never give up on your dreams!
 55 | 
 56 | ```lua
 57 | local portraitChiito = {path = "chiito.png", width = 200, height = 400}
 58 | local portraitYuuri  = {path = "yuuri.png",  width = 195, height = 430}
 59 | local script = Ero(function()
 60 |   name "Chiito"
 61 |   portrait(portraitChiito)
 62 |   msg "What are you doing?"
 63 |   name "Yuuri"
 64 |   portrait(portraitYuuri)
 65 |   msg "I'm taking it."
 66 |   msg "This is war."
 67 | end)
 68 |   :defineAttributes({
 69 |     'name',
 70 |     'portrait',
 71 |   })
 72 | 
 73 | script:next()
 74 | -- {msg = "What are you doing?",
 75 | --  name = "Chiito",
 76 | --  portrait = {path = "chiito.png", width = 200, height = 400}}
 77 | script:next()
 78 | -- {msg = "I'm taking it.",
 79 | --  name = "Yuuri",
 80 | --  portrait = {path = "yuuri.png",  width = 195, height = 430}}
 81 | script:next()
 82 | -- {msg = "This is war.",
 83 | --  name = "Yuuri",
 84 | --  portrait = {path = "yuuri.png",  width = 195, height = 430}}
 85 | ```
 86 | 
 87 | ## Macro example
 88 | 
 89 | Macros can be used to create a reusable script template. This can really cut down on repetition and make your scripts more terse and readable.
 90 | 
 91 | ```lua
 92 | local portraitChiito = {path = "chiito.png", width = 200, height = 400}
 93 | local portraitYuuri  = {path = "yuuri.png",  width = 195, height = 430}
 94 | local script = Ero(function()
 95 |   chii "What are you doing?"
 96 |   yuu "I'm taking it."
 97 |   yuu "This is war."
 98 | end)
 99 |   :defineAttributes({
100 |     'name',
101 |     'portrait',
102 |   })
103 |   :addMacro('chii', function(text)
104 |     name "Chiito"
105 |     portrait(portraitChiito)
106 |     msg(text)
107 |   end)
108 |   :addMacro('yuu', function(text)
109 |     name "Yuuri"
110 |     portrait(portraitYuuri)
111 |     msg(text)
112 |   end)
113 | ```
114 | 
115 | ## Advanced Example
116 | 
117 | ```lua
118 | local script = Ero(function()
119 |   name "Shopkeeper"
120 |   if not game:isFlagSet('DAUGHTER_RESCUED') then -- This is an example, your code goes here.
121 |     msg "Please rescue my beloved tomboyish daughter!"
122 |     return
123 |   end
124 |   msg "Thank you for rescuing my beloved tomboyish daughter!"
125 |   option "Delicious Baklava"
126 |   option "Loyal Hamster"
127 |   menu "Select your reward"
128 |   if selection "Delicious Baklava" then
129 |     giveItem("Baklava")
130 |   elseif selection "Loyal Hamster" then
131 |     giveItem("Hamster")
132 |   end
133 |   msg "Farewell!"
134 | end)
135 |   :defineAttributes({
136 |     'name',
137 |   })
138 |   :addMacro('giveItem', function(item)
139 |     local lastName = get('name')
140 |     name ""
141 |     msg("You got the " .. item .. "!")
142 |     name(lastName)
143 |     player:giveItem(item, 1) -- This is an example, your code goes here.
144 |   end)
145 | 
146 | script:next()
147 | -- {msg = "Thank you for rescuing my beloved tomboyish daughter!",
148 | --  name = "Shopkeeper"}
149 | script:next()
150 | -- {msg = "Select your reward",
151 | --  options = {"Delicious Baklava", "Loyal Hamster"},
152 | --  name = "Shopkeeper"}
153 | script:select("Delicious Baklava")
154 | -- {msg = You got the Baklava!",
155 | --  name = ""}
156 | script:next()
157 | -- {msg = "Farewell!",
158 | --  name = "Shopkeeper"}
159 | ```
160 | 
161 | ## Tips and Tricks
162 | 
163 | To eliminate duplication in your scripts, you can take advantage of the fact that `option` returns the value that was passed into it:
164 | 
165 | ```lua
166 | local breadsticks  = option "Conjure Lesser Breadsticks"
167 | local seaCreatures = option "Converse With Sea Creatures"
168 | menu "Which powerful spell should I teach you?"
169 | if selection(breadsticks) then
170 |   msg "A fine choice."
171 | elseif selection(seaCreatures) then
172 |   msg "Interested in the dark arts, are we?"
173 | end
174 | ```
175 | 
176 | ##  ┐(￣ヘ￣;)┌
177 | 
178 | > In ergodic literature, nontrivial effort is required to allow the reader to traverse the text. If ergodic literature is to make sense as a concept, there must also be nonergodic literature, where the effort to traverse the text is trivial, with no extranoematic responsibilities placed on the reader except (for example) eye movement and the periodic or arbitrary turning of pages.
179 | 


--------------------------------------------------------------------------------
/demo/talkies.lua:
--------------------------------------------------------------------------------
  1 | --
  2 | -- Talkies
  3 | -- https://github.com/tanema/talkies
  4 | --
  5 | -- Copyright (c) 2017 twentytwoo, tanema
  6 | --
  7 | -- This library is free software; you can redistribute it and/or modify it
  8 | -- under the terms of the MIT license.
  9 | --
 10 | local utf8 = require("utf8")
 11 | 
 12 | local function playSound(sound, pitch)
 13 |   if type(sound) == "userdata" then
 14 |     sound:setPitch(pitch or 1)
 15 |     sound:play()
 16 |   end
 17 | end
 18 | 
 19 | local function parseSpeed(speed)
 20 |   if speed == "fast" then return 0.01
 21 |   elseif speed == "medium" then return 0.04
 22 |   elseif speed == "slow" then return 0.08
 23 |   else
 24 |     assert(tonumber(speed), "setSpeed() - Expected number, got " .. tostring(speed))
 25 |     return speed
 26 |   end
 27 | end
 28 | 
 29 | local Fifo = {}
 30 | function Fifo.new () return setmetatable({first=1,last=0},{__index=Fifo}) end
 31 | function Fifo:peek() return self[self.first] end
 32 | function Fifo:len() return (self.last+1)-self.first end
 33 | 
 34 | function Fifo:push(value)
 35 |   self.last = self.last + 1
 36 |   self[self.last] = value
 37 | end
 38 | 
 39 | function Fifo:pop()
 40 |   if self.first > self.last then return end
 41 |   local value = self[self.first]
 42 |   self[self.first] = nil
 43 |   self.first = self.first + 1
 44 |   return value
 45 | end
 46 | 
 47 | local Typer = {}
 48 | function Typer.new(msg, speed)
 49 |   local timeToType = parseSpeed(speed)
 50 |   return setmetatable({
 51 |     msg = msg, complete = false, paused = false,
 52 |     timer = timeToType, max = timeToType, position = 0, visible = "",
 53 |   },{__index=Typer})
 54 | end
 55 | 
 56 | function Typer:resume()
 57 |   if not self.paused then return end
 58 |   self.msg = self.msg:gsub("-+", " ", 1)
 59 |   self.paused = false
 60 | end
 61 | 
 62 | function Typer:finish()
 63 |   if self.complete then return end
 64 |   self.visible = self.msg:gsub("-+", " ")
 65 |   self.complete = true
 66 | end
 67 | 
 68 | function Typer:update(dt)
 69 |   local typed = false
 70 |   if self.complete then return typed end
 71 |   if not self.paused then
 72 |     self.timer = self.timer - dt
 73 |     if self.timer <= 0 then
 74 |       typed = string.sub(self.msg, self.position, self.position) ~= " "
 75 |       self.position = self.position + 1
 76 |       self.timer = self.max
 77 |     end
 78 |   end
 79 |   self.visible = string.sub(self.msg, 0, utf8.offset(self.msg, self.position) - 1)
 80 |   self.complete = (self.visible == self.msg)
 81 |   self.paused = string.sub(self.msg, string.len(self.visible)+1, string.len(self.visible)+2) == "--"
 82 |   return typed
 83 | end
 84 | 
 85 | local Talkies = {
 86 |   _VERSION     = '0.0.1',
 87 |   _URL         = 'https://github.com/tanema/talkies',
 88 |   _DESCRIPTION = 'A simple messagebox system for LÖVE',
 89 | 
 90 |   -- Theme
 91 |   indicatorCharacter = ">",
 92 |   optionCharacter    = "-",
 93 |   padding            = 10,
 94 |   talkSound          = nil,
 95 |   optionSwitchSound  = nil,
 96 |   titleColor         = {1, 1, 1},
 97 |   messageColor       = {1, 1, 1},
 98 |   backgroundColor    = {0, 0, 0, 0.8},
 99 |   textSpeed          = 0.01,
100 |   font               = love.graphics.newFont(),
101 | 
102 |   typedNotTalked     = true,
103 |   pitchValues        = {0.7, 0.8, 1.0, 1.2, 1.3},
104 | 
105 |   indicatorTimer     = 0,
106 |   indicatorDelay     = 3,
107 |   showIndicator      = false,
108 |   dialogs            = Fifo.new(),
109 | }
110 | 
111 | function Talkies.say(title, messages, config)
112 |   config = config or {}
113 |   if type(messages) ~= "table" then
114 |     messages = { messages }
115 |   end
116 | 
117 |   msgFifo = Fifo.new()
118 |   for i=1, #messages do
119 |     msgFifo:push(Typer.new(messages[i], config.textSpeed or Talkies.textSpeed))
120 |   end
121 | 
122 |   local font = config.font or Talkies.font
123 | 
124 |   -- Insert the Talkies.new into its own instance (table)
125 |   local newDialog = {
126 |     title         = title,
127 |     messages      = msgFifo,
128 |     image         = config.image,
129 |     options       = config.options,
130 |     onstart       = config.onstart or function(dialog) end,
131 |     onmessage     = config.onmessage or function(dialog, left) end,
132 |     oncomplete    = config.oncomplete or function(dialog) end,
133 | 
134 |     -- theme
135 |     indicatorCharacter = config.indicatorCharacter or Talkies.indicatorCharacter,
136 |     optionCharacter    = config.optionCharacter or Talkies.optionCharacter,
137 |     padding            = config.padding or Talkies.padding,
138 |     talkSound          = config.talkSound or Talkies.talkSound,
139 |     optionSwitchSound  = config.optionSwitchSound or Talkies.optionSwitchSound,
140 |     titleColor         = config.titleColor or Talkies.titleColor,
141 |     messageColor       = config.messageColor or Talkies.messageColor,
142 |     backgroundColor    = config.backgroundColor or Talkies.backgroundColor,
143 |     font               = font,
144 |     fontHeight         = font:getHeight(" "),
145 |     typedNotTalked     = config.typedNotTalked == nil and Talkies.typedNotTalked or config.typedNotTalked,
146 |     pitchValues        = config.pitchValues or Talkies.pitchValues,
147 | 
148 |     optionIndex   = 1,
149 | 
150 |     showOptions = function(dialog) return dialog.messages:len() == 1 and type(dialog.options) == "table" end,
151 |     isShown     = function(dialog) return Talkies.dialogs:peek() == dialog end
152 |   }
153 | 
154 |   Talkies.dialogs:push(newDialog)
155 |   if Talkies.dialogs:len() == 1 then
156 |     Talkies.dialogs:peek():onstart()
157 |   end
158 | 
159 |   return newDialog
160 | end
161 | 
162 | function Talkies.update(dt)
163 |   local currentDialog = Talkies.dialogs:peek()
164 |   if currentDialog == nil then return end
165 |   local currentMessage = currentDialog.messages:peek()
166 | 
167 |   if currentMessage.paused or currentMessage.complete then
168 |     Talkies.indicatorTimer = Talkies.indicatorTimer + (10 * dt)
169 |     if Talkies.indicatorTimer > Talkies.indicatorDelay then
170 |       Talkies.showIndicator = not Talkies.showIndicator
171 |       Talkies.indicatorTimer = 0
172 |     end
173 |   else
174 |     Talkies.showIndicator = false
175 |   end
176 | 
177 |   if currentMessage:update(dt) then
178 |     if currentDialog.typedNotTalked then
179 |       playSound(currentDialog.talkSound)
180 |     elseif not currentDialog.talkSound:isPlaying() then
181 |       local pitch = currentDialog.pitchValues[math.random(#currentDialog.pitchValues)]
182 |       playSound(currentDialog.talkSound, pitch)
183 |     end
184 |   end
185 | end
186 | 
187 | function Talkies.advanceMsg()
188 |   local currentDialog = Talkies.dialogs:peek()
189 |   if currentDialog == nil then return end
190 |   currentDialog:onmessage(currentDialog.messages:len() - 1)
191 |   if currentDialog.messages:len() == 1 then
192 |     Talkies.dialogs:pop()
193 |     currentDialog:oncomplete()
194 |     if Talkies.dialogs:len() == 0 then
195 |       Talkies.clearMessages()
196 |     else
197 |       Talkies.dialogs:peek():onstart()
198 |     end
199 |   end
200 |   currentDialog.messages:pop()
201 | end
202 | 
203 | function Talkies.isOpen()
204 |   return Talkies.dialogs:peek() ~= nil
205 | end
206 | 
207 | function Talkies.draw()
208 |   local currentDialog = Talkies.dialogs:peek()
209 |   if currentDialog == nil then return end
210 | 
211 |   local currentMessage = currentDialog.messages:peek()
212 | 
213 |   love.graphics.push()
214 |   love.graphics.setDefaultFilter("nearest", "nearest")
215 | 
216 |   local function getDimensions()
217 |     local canvas = love.graphics.getCanvas()
218 |     if canvas then
219 |       return canvas:getDimensions()
220 |     end
221 |     return love.graphics.getDimensions()
222 |   end
223 | 
224 |   local windowWidth, windowHeight = love.graphics.getDimensions()
225 | 
226 |   -- message box
227 |   local boxW = windowWidth-(2*currentDialog.padding)
228 |   local boxH = (windowHeight/3)-(2*currentDialog.padding)
229 |   local boxX = currentDialog.padding
230 |   local boxY = windowHeight-(boxH+currentDialog.padding)
231 | 
232 |   -- image
233 |   local imgX, imgY, imgW, imgScale = boxX+currentDialog.padding, boxY+currentDialog.padding, 0, 0
234 |   if currentDialog.image ~= nil then
235 |     imgScale = (boxH - (currentDialog.padding * 2)) / currentDialog.image:getHeight()
236 |     imgW = currentDialog.image:getWidth() * imgScale
237 |   end
238 | 
239 |   -- title box
240 |   local titleBoxW = currentDialog.font:getWidth(currentDialog.title)+(2*currentDialog.padding)
241 |   local titleBoxH = currentDialog.fontHeight+currentDialog.padding
242 |   local titleBoxY = boxY-titleBoxH-(currentDialog.padding/2)
243 |   local titleX, titleY = boxX + currentDialog.padding, titleBoxY + 2
244 |   local textX, textY = imgX + imgW + currentDialog.padding, boxY + 1
245 | 
246 |   love.graphics.setFont(currentDialog.font)
247 | 
248 |   -- Message title
249 |   love.graphics.setColor(currentDialog.backgroundColor)
250 |   love.graphics.rectangle("fill", boxX, titleBoxY, titleBoxW, titleBoxH)
251 |   love.graphics.setColor(currentDialog.titleColor)
252 |   love.graphics.print(currentDialog.title, titleX, titleY)
253 | 
254 |   -- Main message box
255 |   love.graphics.setColor(currentDialog.backgroundColor)
256 |   love.graphics.rectangle("fill", boxX, boxY, boxW, boxH)
257 | 
258 |   -- Message avatar
259 |   if currentDialog.image ~= nil then
260 |     love.graphics.push()
261 |       love.graphics.setColor(255, 255, 255)
262 |       love.graphics.draw(currentDialog.image, imgX, imgY, 0, imgScale, imgScale)
263 |     love.graphics.pop()
264 |   end
265 | 
266 |   -- Message text
267 |   love.graphics.setColor(currentDialog.messageColor)
268 |   love.graphics.printf(currentMessage.visible, textX, textY, boxW - imgW - (4 * currentDialog.padding))
269 | 
270 |   -- Message options (when shown)
271 |   if currentDialog:showOptions() and currentMessage.complete then
272 |     local optionsY = textY+currentDialog.font:getHeight(currentMessage.visible)-(currentDialog.padding/1.6)
273 |     local optionLeftPad = currentDialog.font:getWidth(currentDialog.optionCharacter.." ")
274 |     for k, option in pairs(currentDialog.options) do
275 |       love.graphics.print(option[1], optionLeftPad+textX+currentDialog.padding, optionsY+((k-1)*currentDialog.fontHeight))
276 |     end
277 |     love.graphics.print(
278 |       currentDialog.optionCharacter.." ",
279 |       textX+currentDialog.padding,
280 |       optionsY+((currentDialog.optionIndex-1)*currentDialog.fontHeight))
281 |   end
282 | 
283 |   -- Next message/continue indicator
284 |   if Talkies.showIndicator then
285 |     love.graphics.print(currentDialog.indicatorCharacter, boxX+boxW-(2.5*currentDialog.padding), boxY+boxH-currentDialog.fontHeight)
286 |   end
287 | 
288 |   love.graphics.pop()
289 | end
290 | 
291 | function Talkies.prevOption()
292 |   local currentDialog = Talkies.dialogs:peek()
293 |   if currentDialog == nil or not currentDialog:showOptions() then return end
294 |   currentDialog.optionIndex = currentDialog.optionIndex - 1
295 |   if currentDialog.optionIndex < 1 then currentDialog.optionIndex = #currentDialog.options end
296 |   playSound(currentDialog.optionSwitchSound)
297 | end
298 | 
299 | function Talkies.nextOption()
300 |   local currentDialog = Talkies.dialogs:peek()
301 |   if currentDialog == nil or not currentDialog:showOptions() then return end
302 |   currentDialog.optionIndex = currentDialog.optionIndex + 1
303 |   if currentDialog.optionIndex > #currentDialog.options then currentDialog.optionIndex = 1 end
304 |   playSound(currentDialog.optionSwitchSound)
305 | end
306 | 
307 | function Talkies.onAction()
308 |   local currentDialog = Talkies.dialogs:peek()
309 |   if currentDialog == nil then return end
310 |   local currentMessage = currentDialog.messages:peek()
311 | 
312 |   if currentMessage.paused then currentMessage:resume()
313 |   elseif not currentMessage.complete then currentMessage:finish()
314 |   else
315 |     if currentDialog:showOptions() then
316 |       currentDialog.options[currentDialog.optionIndex][2]() -- Execute the selected function
317 |       playSound(currentDialog.optionSwitchSound)
318 |     end
319 |     Talkies.advanceMsg()
320 |   end
321 | end
322 | 
323 | function Talkies.clearMessages()
324 |   Talkies.dialogs = Fifo.new()
325 | end
326 | 
327 | return Talkies


--------------------------------------------------------------------------------
/spec.lua:
--------------------------------------------------------------------------------
  1 | require 'busted'
  2 | 
  3 | local Ero = require 'erogodic'
  4 | 
  5 | describe('Terebi:', function()
  6 |   describe('When executing script', function()
  7 |     -- !! This test case is first because the expected error references the line number in this file. !!
  8 |     it('Invalid scripts should relay error message', function()
  9 |       local script = Ero(function()
 10 |         msg(undefinedGlobal.undefinedKey)
 11 |       end)
 12 |       local expectedError = "Error executing script: spec.lua:10: attempt to index global 'undefinedGlobal' (a nil value)"
 13 |       assert.has_error(function() script:next() end, expectedError)
 14 |     end)
 15 | 
 16 |     it('Should have expected output', function()
 17 |       local script = Ero(function()
 18 |         msg "Hello minasan."
 19 |         msg "Which of these frozen desserts is your favourite?"
 20 |         option "Soft Serve"
 21 |         option "Shaved Ice"
 22 |         menu "Choose one:"
 23 |         if selection "Soft Serve" then
 24 |           msg "Too cold!!"
 25 |         elseif selection "Shaved Ice" then
 26 |           msg "Just right."
 27 |         end
 28 |       end)
 29 | 
 30 |       assert.same('table', type(script))
 31 |       assert.same(true, script:hasNext())
 32 |       assert.same({
 33 |         msg = "Hello minasan.",
 34 |       }, script:next())
 35 |       assert.same({
 36 |         msg = "Which of these frozen desserts is your favourite?",
 37 |       }, script:next())
 38 |       assert.same({
 39 |         msg = "Choose one:",
 40 |         options = {
 41 |           "Soft Serve",
 42 |           "Shaved Ice",
 43 |         }
 44 |       }, script:next())
 45 |       assert.same({
 46 |         msg = "Just right.",
 47 |       }, script:select("Shaved Ice"))
 48 |       assert.same(nil, script:next())
 49 |       assert.same(false, script:hasNext())
 50 |     end)
 51 | 
 52 |     it('Looping should be possible. Also test option returning things I guess.', function()
 53 |       local script = Ero(function()
 54 |         while true do
 55 |           local wanko       = option "What does a wanko say?"
 56 |           local nyanko      = option "What does a nyanko say?"
 57 |           local alreadyKnow = option "I already know a ton about animal sounds."
 58 |           menu "Make your selection, now."
 59 |           if selection(wanko) then
 60 |             msg "Wan! Wan!"
 61 |           elseif selection(nyanko) then
 62 |             msg "Nya! Nyan!"
 63 |           elseif selection(alreadyKnow) then
 64 |             msg "Fine. Have a nice day."
 65 |             break
 66 |           end
 67 |         end
 68 |       end)
 69 | 
 70 |       local assertMenuWasDisplayed = function()
 71 |         assert.same({
 72 |           msg = "Make your selection, now.",
 73 |           options = {
 74 |             "What does a wanko say?",
 75 |             "What does a nyanko say?",
 76 |             "I already know a ton about animal sounds.",
 77 |           }
 78 |         }, script:next())
 79 |       end
 80 | 
 81 |       assertMenuWasDisplayed()
 82 |       assert.same({
 83 |         msg = "Wan! Wan!",
 84 |       }, script:select("What does a wanko say?"))
 85 |       assertMenuWasDisplayed()
 86 |       assert.same({
 87 |         msg = "Nya! Nyan!",
 88 |       }, script:select("What does a nyanko say?"))
 89 |       assertMenuWasDisplayed()
 90 |       assert.same({
 91 |         msg = "Fine. Have a nice day.",
 92 |       }, script:select("I already know a ton about animal sounds."))
 93 |       assert.same(nil, script:next())
 94 |     end)
 95 | 
 96 |     it('selection() should return last selected value when invoked with no argument', function()
 97 |       local testVariable = 'CHANGE ME'
 98 |       local script = Ero(function()
 99 |         option "Wanko"
100 |         option "Nyanko"
101 |         menu ""
102 |         testVariable = selection()
103 |       end)
104 | 
105 |       assert.same({
106 |         msg = "",
107 |         options = {"Wanko", "Nyanko"}
108 |       }, script:next())
109 |       assert.same(nil, script:select("Wanko"))
110 |       assert.same("Wanko", testVariable)
111 |     end)
112 | 
113 |     it("Arbitrary lua scripting should be possible", function()
114 |       local player = {
115 |         hatted = false,
116 |       }
117 |       local script = Ero(function()
118 |         while true do
119 |           if player.hatted == false then
120 |             option "Put on a dapper hat."
121 |           else
122 |             option "Say: \"I am the supreme gentleman.\""
123 |           end
124 |           option "Give the world it's retribution."
125 |           menu ""
126 |           if selection "Put on a dapper hat." then
127 |             player.hatted = true
128 |             msg "You put on a dapper hat. It fits perfectly and you look fucking brilliant."
129 |           elseif selection "Say: \"I am the supreme gentleman.\"" then
130 |             msg "You assert your status as a conscious agent in the universe."
131 |             break
132 |           end
133 |         end
134 |       end)
135 | 
136 |       assert.same(false, player.hatted)
137 |       assert.same({
138 |         msg = "",
139 |         options = {
140 |           "Put on a dapper hat.",
141 |           "Give the world it's retribution.",
142 |         }
143 |       }, script:next())
144 |       assert.same({
145 |         msg = "You put on a dapper hat. It fits perfectly and you look fucking brilliant.",
146 |       }, script:select("Put on a dapper hat."))
147 |       assert.same(true, player.hatted)
148 |       assert.same({
149 |         msg = "",
150 |         options = {
151 |           "Say: \"I am the supreme gentleman.\"",
152 |           "Give the world it's retribution.",
153 |         }
154 |       }, script:next())
155 |       assert.same({
156 |         msg = "You assert your status as a conscious agent in the universe.",
157 |       }, script:select("Say: \"I am the supreme gentleman.\""))
158 |       assert.same(nil, script:next())
159 |     end)
160 | 
161 |     it('Calling :next() on a finished script should give a vaguely coherent error message.', function()
162 |       local script = Ero(function()
163 |         msg "あ、そういえばアイポンってツリあるよね、ツリ～"
164 |       end)
165 |       assert.same({
166 |         msg = "あ、そういえばアイポンってツリあるよね、ツリ～",
167 |       }, script:next())
168 |       assert.same(nil, script:next())
169 |       assert.same(false, script:hasNext())
170 |       local expectedError = "Script is finished."
171 |       assert.has_error(function() script:next() end, expectedError)
172 |     end)
173 |   end)
174 | 
175 |   describe('When prompted with a choice', function()
176 |     it('Should throw error when choosing invalid option', function()
177 |       local script = Ero(function()
178 |         option "Lemon Tea"
179 |         option "Milk Tea"
180 |         menu "Which is best?"
181 |       end)
182 | 
183 |       assert.same({msg = "Which is best?", options = {"Lemon Tea", "Milk Tea"}}, script:next())
184 |       assert.has_error(function() script:select("Onion Tea") end, "Selection 'Onion Tea' was not one of the options.")
185 |     end)
186 | 
187 |     it('Should not be possible to skip it', function()
188 |       local script = Ero(function()
189 |         option "Yes"
190 |         menu "Would you like to pay your taxes?"
191 |         if selection "Yes" then
192 |           msg "What a good citizen you are!"
193 |         end
194 |       end)
195 | 
196 |       assert.same({msg = "Would you like to pay your taxes?", options = {"Yes"}}, script:next())
197 |       assert.same({msg = "Would you like to pay your taxes?", options = {"Yes"}}, script:next())
198 |       assert.same({msg = "Would you like to pay your taxes?", options = {"Yes"}}, script:next())
199 |       assert.same({msg = "Would you like to pay your taxes?", options = {"Yes"}}, script:next())
200 |       assert.same({msg = "What a good citizen you are!"}, script:select("Yes"))
201 |       assert.same(nil, script:next())
202 |     end)
203 | 
204 |     it('"msg" should not block from proceeding when options are defined', function()
205 |       local script = Ero(function()
206 |         msg "You have two options..."
207 |         option "Yahweh"
208 |         msg "Yahweh."
209 |         option "Highway"
210 |         msg "Or the highway."
211 |         menu "Yeah! This time I'm a let it all come out!"
212 |       end)
213 | 
214 |       assert.same({msg = "You have two options..."}, script:next())
215 |       assert.same({msg = "Yahweh."}, script:next())
216 |       assert.same({msg = "Or the highway."}, script:next())
217 |       assert.same({
218 |         msg = "Yeah! This time I'm a let it all come out!",
219 |         options = {"Yahweh", "Highway"}
220 |       }, script:next())
221 |       assert.same(nil, script:select("Yahweh"))
222 |     end)
223 |   end)
224 | 
225 |   describe('When setting node attributes', function()
226 |     it('Should be able to define and set arbitrary node attributes', function()
227 |       local script = Ero(function()
228 |         characterName "Steven"
229 |         msg "Get off your duff!"
230 |         effect "shake text"
231 |         msg "Check in with your body; how does it feel?"
232 |         characterName "Doug"
233 |         effect(nil)
234 |         msg "I'm a hunk, so I don't have to exercise."
235 |       end)
236 |         :defineAttributes({
237 |           'characterName',
238 |           'effect',
239 |           'unusedAttribute',
240 |         })
241 | 
242 |       assert.same({
243 |         characterName = "Steven",
244 |         msg = "Get off your duff!",
245 |       }, script:next())
246 |       assert.same({
247 |         characterName = "Steven",
248 |         effect = "shake text",
249 |         msg = "Check in with your body; how does it feel?",
250 |       }, script:next())
251 |       assert.same({
252 |         characterName = "Doug",
253 |         msg = "I'm a hunk, so I don't have to exercise.",
254 |       }, script:next())
255 |     end)
256 | 
257 |     it('Should throw error when defineAttributes() is called with invalid parameters.', function()
258 |       local script = Ero(function() end)
259 |       local expectedError = "attributeNames must be a table, got: nil"
260 |       assert.has_error(function() script:defineAttributes(nil) end, expectedError)
261 |     end)
262 | 
263 |     it('Should be able to get() node value', function()
264 |       local script = Ero(function()
265 |         name "Steve Brule"
266 |         local charaName = get('name')
267 |         msg("Hello, my name is Dr. " .. charaName .. ".")
268 |       end)
269 |         :defineAttributes({'name'})
270 | 
271 |       assert.same({
272 |         name = "Steve Brule",
273 |         msg = "Hello, my name is Dr. Steve Brule.",
274 |       }, script:next())
275 |     end)
276 | 
277 |     it('should be able to set node attributes to any Lua value', function()
278 |       local func = function() return false end
279 |       local tbl = {path = "/assets/portrait.png", width = 64, height = 128}
280 |       local script = Ero(function()
281 |         attr(true)
282 |         msg "boolean"
283 |         attr(func)
284 |         msg "function"
285 |         attr(420.666)
286 |         msg "number"
287 |         attr "Puru puru purin"
288 |         msg "string"
289 |         attr(tbl)
290 |         msg "table"
291 |       end)
292 |         :defineAttributes({
293 |           'attr',
294 |         })
295 | 
296 |       assert.same({
297 |         attr = true,
298 |         msg = "boolean",
299 |       }, script:next())
300 |       assert.same({
301 |         attr = func,
302 |         msg = "function",
303 |       }, script:next())
304 |       assert.same({
305 |         attr = 420.666,
306 |         msg = "number",
307 |       }, script:next())
308 |       assert.same({
309 |         attr = "Puru puru purin",
310 |         msg = "string",
311 |       }, script:next())
312 |       assert.same({
313 |         attr = tbl,
314 |         msg = "table",
315 |       }, script:next())
316 |     end)
317 |   end)
318 | 
319 |   describe('When using macros', function()
320 |     it('Should be able to use macros', function()
321 |       local script = Ero(function()
322 |         serval "Ohayou!"
323 |         kaban "Tabenai de kudasai!"
324 |         serval "Tabenai yo!"
325 |         font "jokerman"
326 |         kaban "Ureshii naa!"
327 |       end)
328 |         :defineAttributes({
329 |           'font',
330 |           'name',
331 |           'image',
332 |         })
333 |         :addMacro('kaban', function(text)
334 |           name 'Kaban'
335 |           image 'kaban.png'
336 |           msg(text)
337 |         end)
338 |         :addMacro('serval', function(text)
339 |           name 'Serval, The Serval'
340 |           image 'serval.png'
341 |           msg(text)
342 |         end)
343 | 
344 |       assert.same({
345 |         name = 'Serval, The Serval',
346 |         image = 'serval.png',
347 |         msg = 'Ohayou!',
348 |       }, script:next())
349 |       assert.same({
350 |         name = 'Kaban',
351 |         image = 'kaban.png',
352 |         msg = 'Tabenai de kudasai!',
353 |       }, script:next())
354 |       assert.same({
355 |         name = 'Serval, The Serval',
356 |         image = 'serval.png',
357 |         msg = 'Tabenai yo!',
358 |       }, script:next())
359 |       assert.same({
360 |         name = 'Kaban',
361 |         image = 'kaban.png',
362 |         font = 'jokerman',
363 |         msg = 'Ureshii naa!',
364 |       }, script:next())
365 |     end)
366 | 
367 |     it('Should be able to use macros inside macros', function()
368 |       local script = Ero(function()
369 |         msg "Starting Main Script"
370 |         myMacro(
371 |           "has hairy legs.",
372 |           "prefers dubs over subs."
373 |         )
374 |         msg "Ending Main Script"
375 |       end)
376 |         :addMacro('myMacro', function(...)
377 |           msg("Macro started")
378 |           for _, val in ipairs({...}) do
379 |             mySubmacro(val)
380 |           end
381 |           msg("Macro ended")
382 |         end)
383 |         :addMacro('mySubmacro', function(val)
384 |           msg("We need a Disney princess who " .. val)
385 |         end)
386 | 
387 |       assert.same({
388 |         msg = "Starting Main Script",
389 |       }, script:next())
390 |       assert.same({
391 |         msg = "Macro started",
392 |       }, script:next())
393 |       assert.same({
394 |         msg = "We need a Disney princess who has hairy legs.",
395 |       }, script:next())
396 |       assert.same({
397 |         msg = "We need a Disney princess who prefers dubs over subs.",
398 |       }, script:next())
399 |       assert.same({
400 |         msg = "Macro ended",
401 |       }, script:next())
402 |       assert.same({
403 |         msg = "Ending Main Script",
404 |       }, script:next())
405 |       assert.same(nil, script:next())
406 |       assert.same(false, script:hasNext())
407 |     end)
408 |   end)
409 | 
410 |   describe('When calling Script functions', function()
411 |     it('Calling extendEnvironment() should add additional values to environment table', function()
412 |       local script = Ero(function()
413 |         local text = "I am going to marry " .. wifeName
414 |         msg(text)
415 |       end)
416 |         :extendEnvironment({wifeName = 'Toromi'})
417 | 
418 |       assert.same({msg = "I am going to marry Toromi"}, script:next())
419 |     end)
420 |   end)
421 | end)
422 | 


--------------------------------------------------------------------------------