{"id":29,"date":"2022-02-04T16:18:22","date_gmt":"2022-02-04T16:18:22","guid":{"rendered":"https:\/\/homer.open-lab.com\/site\/?page_id=29"},"modified":"2024-10-29T09:30:51","modified_gmt":"2024-10-29T09:30:51","slug":"faq","status":"publish","type":"page","link":"https:\/\/homer.open-lab.com\/site\/documentation\/faq\/","title":{"rendered":"FAQ"},"content":{"rendered":"\n
\n
Go to the full Homer documentation<\/a><\/div>\n<\/div>\n\n\n\n

<\/p>\n\n\n\n

Using the editor<\/strong><\/h3>\n\n\n\n

How to create links between nodes?<\/h4>
\n

All links are created by simply keeping CTRL<\/strong> pressed (\u2325 <\/strong>on a Mac) when clicking on the node where the link starts and then dragging the line drawn onto the node where the link should lead to. This is for \u201cpositive\u201d links; links for when the condition fails are created by also pressing SHIFT<\/strong> together with CTRL<\/strong> \/ \u2325<\/strong>.<\/p>\n<\/div><\/div>\n\n\n\n

Where is the start of my flow? I lost it, I have just an empty screen!<\/h4>
\n

Use CTRL J<\/strong> or \u2318J<\/strong>, or open the map and click on the start node.<\/p>\n\n\n\n

\"\"<\/figure>\n<\/div><\/div>\n\n\n\n

What are projects, flows, dialogues in Homer?<\/h4>
\n

Each user can work on a set of projects<\/strong>, either created by themselves or ones on which they have been invited. After logging in to Homer, you always get the list of the projects you can work on. A project is composed of several flows<\/strong>: a flow is a set of connected nodes, and these nodes can represent a logical flow, a dialogue flow, a narrator sequence of descriptions, or a mix of all those things.<\/p>\n<\/div><\/div>\n\n\n\n

What are the operations supported on variables?<\/h4>
\n

All operations are supported but not in the form of an assignment operator. So if you want to add 3 to a variable, be it global or local you have to write:<\/p>\n\n\n\n

%MY_GLOBAL_VAR = %MY_GLOBAL_VAR +3<\/pre>\n\n\n\n
Notice that the web-based editor will actually work also with +=, ++ but<\/strong> this will break the clients.<\/p>\n\n\n\n
\"\"<\/figure>\n<\/div><\/div>\n\n\n\n
How do global and local variables work?<\/h4>
\n
Global variables start with \u201c$\u201d and are kept in a list shared across your project. They are available for the game to fill them and read them typically outside the narrative engine. Local variables start with \u201c%\u201d and are created \u201con the fly\u201d while the flow is running, and are not available outside the scope of a running flow. They are very useful in order not to fill up your globals with stuff that makes sense only in context.<\/p>\n\n\n\n
\"\"<\/figure>\n<\/div><\/div>\n\n\n\n
What are \u201cfixed\u201d\u201d variables?<\/h4>
\n
These are variables that have a finite, definite set of possible values. This makes is almost impossible to configure values in the game\u2019s content that are not defined when the content is used by the client. When used by the game client, they are available as a fixed enumeration.<\/p>\n\n\n\n
\"\"<\/figure>\n<\/div><\/div>\n\n\n\n
How do I write variations inside text?<\/h4>
\n
Variations in text have this format:<\/p>\n\n\n\n
[[LIST a|b|c]]<\/pre>\n\n\n\n
This means that the first time the node is presented, \u201ca\u201d is shown, then \u201cb\u201d then \u201cc\u201d from the third case onwards. Looping options are LOOP<\/strong>, LIST<\/strong> and SRND<\/strong> (smart random that exclude used options).<\/p>\n\n\n\n
Example:<\/strong><\/p>\n\n\n\n
ZAPPPPP!!! You've been [[LOOP zapped|destroyed|disintegrated]]!!!<\/pre>\n\n\n\n
\"\"<\/figure>\n<\/div><\/div>\n\n\n\n
How do I write conditionals inside text?<\/h4>
\n
The format for in-text conditionals is this:<\/p>\n\n\n\n
[IF BOOLRESULT ? \"First output\" : \"Second output\"]<\/pre>\n\n\n\n
And this is an example of usage:<\/p>\n\n\n\n
[IF $PLAYER_SIDE==\"GREEKS\" ? \"Greek\" : \"Trojan\"]<\/pre>\n\n\n\n
Notice that you can also use global and local variables as results of the \u201cIF\u201d.<\/p>\n\n\n\n
\"\"<\/figure>\n<\/div><\/div>\n\n\n\n
How do I create new nodes in the page view?<\/h4>
\n
The page (or \u201cflat\u201d) view (that you access also using CTRL b or \u2318 b) enables only certain operations focusing on what is practical in keyboard-based usage: <\/p>\n\n\n\n
ENTER<\/strong> while editing a node text: just creates a new line in your current node text content.<\/p>\n\n\n\n
SHFT ENTER<\/strong> \/ \u21e7 ENTER <\/strong> while editing a node text: creates a new line (alternative content) of the same node.<\/p>\n\n\n\n
CTRL ENTER<\/strong> \/ \u2303 ENTER<\/strong> while editing a node text: creates a new text node linked to the one you are focusing on.<\/p>\n\n\n\n
This should let you write on the page maintaining your flow.<\/p>\n<\/div><\/div>\n\n\n\n
Where is a list of all shortcuts?<\/h4>
\n
Here Homer Keyboard Shorcuts<\/a>.<\/p>\n\n\n\n
A new feature: if when dragging from a node you also press ALT (CTRL ALT  drag on a PC, \u2325 \u2318 drag on Mac, from node to board) if you drop the connection on an empty space, a new node will be automatically created.<\/p>\n<\/div><\/div>\n\n\n\n
How do “in” and “out” links work?<\/h4>
\n
IN: All nodes can get any number of links “into” them.<\/p>\n\n\n\n
OUT: Nodes that have a logic can have more then one node “out” of them.<\/p>\n\n\n\n
So, text nodes can have only one link out.<\/p>\n\n\n\n
Choice nodes should have one out link for every choice, and if they are “consuming” choices, one more for failure.<\/p>\n\n\n\n
Conditional nodes have two “out” links: one for when the condition is true (usual CTRL or \u2325 and drag) and one for false (CTRL or \u2325 and SHIFT and drag).<\/p>\n\n\n\n
Similarly for other types.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
<\/p>\n<\/div><\/div>\n\n\n\n
How can I create “nodes from nodes” without losing focus?<\/h4>
\n
You can create connected text nodes from a node via keyboard with CTRL + ENTER – also in the page view editor. 
<\/p>\n\n\n\n
\"\"<\/figure>\n<\/div><\/div>\n\n\n\n
Can I use Homer on Firefox or Safari? And on mobile?<\/h4>
\n
The only browser currently 100% supported is Chrome. We are The only browser currently 100% supported is Chrome for desktop. We are working on getting to 100% Firefox support. Mobile is not supported for the moment as the editing operations used in Homer are meant for the desktop version.<\/p>\n<\/div><\/div>\n\n\n\n
<\/div>\n\n\n\n
Sharing<\/strong><\/h3>\n\n\n\n
Why is the project locked when I am the only one working on it?<\/h4>
\n
This can happen if you or any of the people managing the project have Homer open in the browser. Try closing all<\/strong> instances of Chrome (not just the tabs where you have Homer open), then reopen the browser, log in Homer and eventually get the project control.<\/p>\n<\/div><\/div>\n\n\n\n
Why is the flow in read-only mode when I am the only one working on it?<\/h4>
\n
This can happen if you or any of the people managing the project have Homer open in the browser. Try closing all<\/strong> instances of Chrome (not just the tabs where you have Homer open), then reopen the browser, log in Homer and eventually get the project control.<\/p>\n<\/div><\/div>\n\n\n\n
Why is the public version of my game not updated?<\/h4>
\n
When you change something in your flow, each time you are ready to share it in the public version of your flow (assuming you have enabled that) you have to issue an \u201cupdate public preview\u201d from the editor to get the public version up to date.<\/p>\n\n\n\n
\"\"<\/figure>\n<\/div><\/div>\n\n\n\n
Can I customise the look of the web-based game?<\/h4>
\n
The downloaded wb version of the project is a standard web\/JS page and hence can be completely customized. Once you did that, you should only update the JSON file from the editor (eventually also the variables file).<\/p>\n<\/div><\/div>\n\n\n\n
<\/div>\n\n\n\n
Maintenance & Support<\/strong><\/h3>\n\n\n\n
How to ensure I have updated Homer in the browser?<\/h4>
\n
A trick: open the debug console (press F12), and then right-click on the reload button will reveal a little menu, pick the last choice.<\/p>\n\n\n\n
\"\"<\/figure>\n<\/div><\/div>\n\n\n\n
Where are backups?<\/h4>
\n
When inside your project, go to Maintenance\/Backups.<\/p>\n\n\n\n
\"\"<\/figure>\n<\/div><\/div>\n\n\n\n
How do I restore just a single flow from a backup?<\/h4>
\n
    \n
  1. Download the backup as JSON file.\u00a0<\/li>\n\n\n\n
  2. Create a new empty project, say call it TMP.<\/li>\n\n\n\n
  3. Import the downloaded JSON file in this TMP project.<\/li>\n\n\n\n
  4. Go to your flow, and select all nodes (CTRL A<\/strong> or \u2318A<\/strong>) and copy them (CTRL C<\/strong> or \u2318C<\/strong>).<\/li>\n\n\n\n
  5. Now move back to your current project, go tho the flow you want to restore (or create a new empty one) and paste (CTRL V<\/strong> or \u2318V<\/strong>).<\/li>\n<\/ol>\n<\/div><\/div>\n\n\n\n
    Where can I ask a question?<\/h4>
    \n
    Check out the Discord channel<\/a>.<\/p>\n<\/div><\/div>\n\n\n\n
    <\/div>\n\n\n\n
    Developers<\/strong><\/h3>\n\n\n\n
    How do I integrate Homer with Unreal (or any other engine)?<\/h4>
    \n
    From the source code of the Unity (C#) and web (JS) clients it should not be too hard to build a client for any other game engine, e.g. Unreal; in case you decide to do so, just write us for any problem you may have. The exported JSON should be quite readable.<\/p>\n<\/div><\/div>\n\n\n\n
    Are Homer and Outspoken data interchangeable?<\/h4>
    \n
    No. The two data models are different, and actually, Outspoken’s parser is more powerful and extensive with respect to Homer’s.<\/p>\n<\/div><\/div>\n\n\n\n
    Can I get game dev support from you?<\/h4>
    \n
    Yes indeed: see the help us<\/a> page.<\/p>\n<\/div><\/div>\n\n\n\n
    <\/div>\n\n\n\n
    \n
    Go to the full Homer documentation<\/a><\/div>\n<\/div>\n\n\n\n
    <\/p>\n","protected":false},"excerpt":{"rendered":"
    Using the editor Sharing Maintenance & Support Developers<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":72,"menu_order":2,"comment_status":"closed","ping_status":"open","template":"","meta":{"footnotes":""},"class_list":["post-29","page","type-page","status-publish","hentry","entry"],"yoast_head":"\nHomer FAQ<\/title>\n<meta name=\"description\" content=\"How does Homer works? read the FAQ to get more on Homer.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/homer.open-lab.com\/site\/documentation\/faq\/\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"8 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/homer.open-lab.com\/site\/documentation\/faq\/\",\"url\":\"https:\/\/homer.open-lab.com\/site\/documentation\/faq\/\",\"name\":\"Homer FAQ\",\"isPartOf\":{\"@id\":\"https:\/\/homer.open-lab.com\/site\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/homer.open-lab.com\/site\/documentation\/faq\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/homer.open-lab.com\/site\/documentation\/faq\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/homer.open-lab.com\/site\/wp-content\/uploads\/2022\/02\/Homer_map.jpg\",\"datePublished\":\"2022-02-04T16:18:22+00:00\",\"dateModified\":\"2024-10-29T09:30:51+00:00\",\"description\":\"How does Homer works? read the FAQ to get more on Homer.\",\"breadcrumb\":{\"@id\":\"https:\/\/homer.open-lab.com\/site\/documentation\/faq\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/homer.open-lab.com\/site\/documentation\/faq\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/homer.open-lab.com\/site\/documentation\/faq\/#primaryimage\",\"url\":\"https:\/\/homer.open-lab.com\/site\/wp-content\/uploads\/2022\/02\/Homer_map.jpg\",\"contentUrl\":\"https:\/\/homer.open-lab.com\/site\/wp-content\/uploads\/2022\/02\/Homer_map.jpg\",\"width\":477,\"height\":231},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/homer.open-lab.com\/site\/documentation\/faq\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/homer.open-lab.com\/site\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documentation\",\"item\":\"https:\/\/homer.open-lab.com\/site\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"FAQ\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/homer.open-lab.com\/site\/#website\",\"url\":\"https:\/\/homer.open-lab.com\/site\/\",\"name\":\"Homer\",\"description\":\"designing and writing interactive narrative content\",\"publisher\":{\"@id\":\"https:\/\/homer.open-lab.com\/site\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/homer.open-lab.com\/site\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/homer.open-lab.com\/site\/#organization\",\"name\":\"Homer\",\"url\":\"https:\/\/homer.open-lab.com\/site\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/homer.open-lab.com\/site\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/homer.open-lab.com\/site\/wp-content\/uploads\/2022\/02\/cropped-logo-1.png\",\"contentUrl\":\"https:\/\/homer.open-lab.com\/site\/wp-content\/uploads\/2022\/02\/cropped-logo-1.png\",\"width\":1200,\"height\":400,\"caption\":\"Homer\"},\"image\":{\"@id\":\"https:\/\/homer.open-lab.com\/site\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Homer FAQ","description":"How does Homer works? read the FAQ to get more on Homer.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/homer.open-lab.com\/site\/documentation\/faq\/","twitter_misc":{"Est. reading time":"8 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/homer.open-lab.com\/site\/documentation\/faq\/","url":"https:\/\/homer.open-lab.com\/site\/documentation\/faq\/","name":"Homer FAQ","isPartOf":{"@id":"https:\/\/homer.open-lab.com\/site\/#website"},"primaryImageOfPage":{"@id":"https:\/\/homer.open-lab.com\/site\/documentation\/faq\/#primaryimage"},"image":{"@id":"https:\/\/homer.open-lab.com\/site\/documentation\/faq\/#primaryimage"},"thumbnailUrl":"https:\/\/homer.open-lab.com\/site\/wp-content\/uploads\/2022\/02\/Homer_map.jpg","datePublished":"2022-02-04T16:18:22+00:00","dateModified":"2024-10-29T09:30:51+00:00","description":"How does Homer works? read the FAQ to get more on Homer.","breadcrumb":{"@id":"https:\/\/homer.open-lab.com\/site\/documentation\/faq\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/homer.open-lab.com\/site\/documentation\/faq\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/homer.open-lab.com\/site\/documentation\/faq\/#primaryimage","url":"https:\/\/homer.open-lab.com\/site\/wp-content\/uploads\/2022\/02\/Homer_map.jpg","contentUrl":"https:\/\/homer.open-lab.com\/site\/wp-content\/uploads\/2022\/02\/Homer_map.jpg","width":477,"height":231},{"@type":"BreadcrumbList","@id":"https:\/\/homer.open-lab.com\/site\/documentation\/faq\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/homer.open-lab.com\/site\/"},{"@type":"ListItem","position":2,"name":"Documentation","item":"https:\/\/homer.open-lab.com\/site\/documentation\/"},{"@type":"ListItem","position":3,"name":"FAQ"}]},{"@type":"WebSite","@id":"https:\/\/homer.open-lab.com\/site\/#website","url":"https:\/\/homer.open-lab.com\/site\/","name":"Homer","description":"designing and writing interactive narrative content","publisher":{"@id":"https:\/\/homer.open-lab.com\/site\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/homer.open-lab.com\/site\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/homer.open-lab.com\/site\/#organization","name":"Homer","url":"https:\/\/homer.open-lab.com\/site\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/homer.open-lab.com\/site\/#\/schema\/logo\/image\/","url":"https:\/\/homer.open-lab.com\/site\/wp-content\/uploads\/2022\/02\/cropped-logo-1.png","contentUrl":"https:\/\/homer.open-lab.com\/site\/wp-content\/uploads\/2022\/02\/cropped-logo-1.png","width":1200,"height":400,"caption":"Homer"},"image":{"@id":"https:\/\/homer.open-lab.com\/site\/#\/schema\/logo\/image\/"}}]}},"_links":{"self":[{"href":"https:\/\/homer.open-lab.com\/site\/wp-json\/wp\/v2\/pages\/29","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/homer.open-lab.com\/site\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/homer.open-lab.com\/site\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/homer.open-lab.com\/site\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/homer.open-lab.com\/site\/wp-json\/wp\/v2\/comments?post=29"}],"version-history":[{"count":69,"href":"https:\/\/homer.open-lab.com\/site\/wp-json\/wp\/v2\/pages\/29\/revisions"}],"predecessor-version":[{"id":481,"href":"https:\/\/homer.open-lab.com\/site\/wp-json\/wp\/v2\/pages\/29\/revisions\/481"}],"up":[{"embeddable":true,"href":"https:\/\/homer.open-lab.com\/site\/wp-json\/wp\/v2\/pages\/72"}],"wp:attachment":[{"href":"https:\/\/homer.open-lab.com\/site\/wp-json\/wp\/v2\/media?parent=29"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}