From ace2f960bd4c37b8c2a513b6db0d3d0b235e7e0a Mon Sep 17 00:00:00 2001 From: Atul Varma Date: Sun, 29 May 2016 07:31:31 -0400 Subject: [PATCH 1/4] Add "getting started" section to README. --- README.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) diff --git a/README.md b/README.md index 8c84f3e..0982064 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,68 @@ **[Read the The Intercept script](https://github.com/inkle/the-intercept/blob/master/Assets/Ink/TheIntercept.ink)** +## Getting Started + +1. Clone the git repository. If you're unfamiliar with git, you may want to try using [GitHub Desktop][]. + +2. Open Unity and choose **Open** from the welcome dialog. + +3. Find your repository's folder in the open dialog and choose **Select Folder**. + +4. If you're presented with an **Opening Project in Non-Matching Editor Installation** dialog, no worries--just choose **Continue**: + + + +5. After some time, you should see the Unity editor window. Locate the **Project** window at its bottom-left, expand the `Assets` folder if necessary, and select the `Scenes` subfolder inside it. Then double-click on the `Demo` scene that appears in the panel to the right of it: + + + +6. Play the game in your editor by clicking the play icon at the top of your editor window (or press Ctrl+P on Windows, Cmd+P on Mac). + +7. When you're finished playing, press the play icon again to stop the game. + +Now that you've got the hang of playing the game in the editor, you might want to tinker with the story itself. + +### Tinkering With The Story + +1. In the **Project** window, select the `Ink` subfolder and click on the `TheIntercept` icon in the panel on the right. Then locate the **Inspector** window on the right side of the Unity editor and click the **Open** button: + + + + Once you click **Open**, Unity will open the story's ink script in a text editor. + +3. Around line 75 of the ink script, you'll see a section called `=== start ===`, and below it will be the game's familiar starting text: `They are keeping me waiting.`. Change this to something else, like `I am a hamburger.`. + +4. Save the file and switch back to Unity. You may briefly see a terminal window open and close itself in an instant: this is just [ink-Unity integration][]'s **Auto Compilation** functionality at work. + +5. Play the game in the editor again; the story should now open with the text "I am a hamburger." + +Hooray! Now you know how to tinker with the story, but it will quickly become annoying to have to wait through the whole introduction and play through part of the game just to interact with the part of the story you've changed. + +### Using The Ink Player + +Notice that underneath the **Open** button in the **Inspector** window is another button labeled **Play**. If you click it, the **Ink Player** window will appear: + + + +This is a really quick way to try out changes to your story without needing to re-play the actual game. + +### Skipping The Intro + +Perhaps you've tinkered with your story, but now you'd like to try it out in-game, just to make sure everything looks and feels just right. But you don't want to have to sit through the introduction every single time you do this. + +Fear not! The creators of The Intercept also had this concern, and they implemented a handy way to skip the introduction entirely. + +1. Locate the **Hierarchy** window on the left side of the Unity editor. Click the entry called `Main`. + +2. On the right side of the Unity editor, the **Inspector** window will contain information about the `Main` object. Under the `Main (Script)` entry will be a checkbox titled `Skip Intro`: + + + +Checking this and then playing the story will skip the introduction. + +## License + **The Intercept** and **ink** are released under the MIT license. Although we don't require attribution, we'd love to know if you decide to use **ink** a project! Let us know on [Twitter](http://www.twitter.com/inkleStudios) or [by email](mailto:info@inklestudios.com). [Newtonsoft's Json.NET](http://www.newtonsoft.com/json) is included, and also has the MIT License. @@ -23,3 +85,6 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of 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. + +[GitHub Desktop]: https://desktop.github.com/ +[ink-Unity integration]: https://github.com/inkle/ink-unity-integration From e301b84b947f9e57c644e685409242424c3d02e8 Mon Sep 17 00:00:00 2001 From: Atul Varma Date: Sun, 29 May 2016 08:19:14 -0400 Subject: [PATCH 2/4] Add a diff snippet to README.md --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0982064..45ad33d 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,21 @@ Now that you've got the hang of playing the game in the editor, you might want t Once you click **Open**, Unity will open the story's ink script in a text editor. -3. Around line 75 of the ink script, you'll see a section called `=== start ===`, and below it will be the game's familiar starting text: `They are keeping me waiting.`. Change this to something else, like `I am a hamburger.`. +3. Around line 75 of the ink script, you'll see the game's familiar starting text: `They are keeping me waiting`. Change this to something else, like `I am a hamburger`: + + ```diff + --- a/Assets/Ink/TheIntercept.ink + +++ b/Assets/Ink/TheIntercept.ink + @@ -74,7 +74,7 @@ VAR DEBUG = false + === start === + + // Intro + - - They are keeping me waiting. + + - I am a hamburger. + * Hut 14[]. The door was locked after I sat down. + I don't even have a pen to do any work. There's a copy of the morning's intercept in my pocket, but staring at the jumbled letters will only drive me mad. + I am not a machine, whatever they say about me. + ``` 4. Save the file and switch back to Unity. You may briefly see a terminal window open and close itself in an instant: this is just [ink-Unity integration][]'s **Auto Compilation** functionality at work. From 4d4b42dede0b2a795732707204209f854ce0d18b Mon Sep 17 00:00:00 2001 From: Atul Varma Date: Sun, 29 May 2016 08:24:50 -0400 Subject: [PATCH 3/4] Remove tech details from diff snippet The file path and hunk range information will probably just confuse non-technical readers. --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index 45ad33d..58b5da2 100644 --- a/README.md +++ b/README.md @@ -44,9 +44,6 @@ Now that you've got the hang of playing the game in the editor, you might want t 3. Around line 75 of the ink script, you'll see the game's familiar starting text: `They are keeping me waiting`. Change this to something else, like `I am a hamburger`: ```diff - --- a/Assets/Ink/TheIntercept.ink - +++ b/Assets/Ink/TheIntercept.ink - @@ -74,7 +74,7 @@ VAR DEBUG = false === start === // Intro From f0dc98a5c4e2c41a7f9458a76958b121ad609691 Mon Sep 17 00:00:00 2001 From: Atul Varma Date: Sun, 29 May 2016 09:44:07 -0400 Subject: [PATCH 4/4] mention debugging in README.md. --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 58b5da2..87dc587 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,7 @@ Notice that underneath the **Open** button in the **Inspector** window is anothe -This is a really quick way to try out changes to your story without needing to re-play the actual game. +This is a really quick way to try out changes to your story without needing to re-play the actual game. It also gives you greater visibility into the state of your story, such as the values of its [variables][], which can aid in debugging. ### Skipping The Intro @@ -99,3 +99,4 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI [GitHub Desktop]: https://desktop.github.com/ [ink-Unity integration]: https://github.com/inkle/ink-unity-integration +[variables]: https://github.com/inkle/ink/blob/master/Documentation/WritingWithInk.md#part-3-variables-and-logic