### **WHY IT EXISTS:** ___ This app provides a fun alternative to reading a traditional fictional story. If the user is bored with the standard format of a novel, this app allows them to directly interact with the story and choose their own ending. ### **HOW TO RUN:** ___ Run app using Ruby in your terminal ```bash $ ruby main.rb ``` ### **HOW IT WORKS:** ___ This app is a first-person, 'choose your own adventure' narrative. 1. The app depicts a series of detailed scenarios. 2. Each secnario prompts you to choose an option from a list of actions. 3. Your choice dictates how your character proceeds through the story. ### **FUNCTIONALITY:** ___ ``` ruby require 'colorized_string' #prividing access colorize gem require 'asciiart' # providing access to ASCII art gem require_relative 'page3' #providing access other story page files require_relative 'page4' require_relative 'page5' require_relative 'page6' module Page2 #creating first story page file def self.text #defining a method which provides access to the file's text a = AsciiArt.new("img/death.png") #calling the ascii gem, linking an image to be converted and assigning it to a variable 'a' puts a.to_ascii_art(width: 50) #putting the variable containing the ascii art to the screen and setting a width of 50 pixels puts """ You sit in the darkness waiting. Surely someone must know about this train wreck and will be coming to the rescue any minute. \n The minutes pass…\n The hour passes…\n And then hours pass…\n You have been sitting in the darkness for a long time and are starting to feel weak and dizzy in addition to being in pain. Maybe you should have tried to find help for yourself, rather than sit here, probably bleeding out this whole time. On a side note, whoever is there in the train wreckage still seems to be alive – moaning incoherently from time to time. " puts ColorizedString["What would you like to do now? "].colorize(:red) #implementing the colorize gem puts """ 1. Bind your head with cloth from your shirt 2. Call out to whoever is there 3. Try to sneak toward the person in the wreckage 4. Ignore the person in the wreckage and climb through the mess to the front of the train " print "enter choice now: " choice = gets.chomp.to_i #prompting the user to input an option if choice == 1 puts Page3.text #linking each option to the corresponding story page file, which then displays the text and continues the story elsif choice == 2 puts Page4.text elsif choice == 3 puts Page5.text elsif choice == 4 puts Page6.text else end end end ``` ### **GEMS:** ___ • **ASCII ART**
This gem converts an image into ASCII and displays it at the command line.  • **COLORIZE**
This gem adds methods to set text color, background color and text effects.  ### **PROJECT PLANNING:** ___ https://trello.com/b/Nkb1d830 ### **PROBLEMS WE ENCOUNTERED:** ___ * Missed some 'require relative' declarations * Incorrect syntax - naming errors for files and methods * Missing 'end' statements in methods * Broke strings by accidentally adding/removing quotation marks  ### **ADDITIONAL FUNCTIONALITY ADDED:** ___ #### Invalid Option In the case of the user entering a number which is not an option we added the following code: ```ruby option = nil until (option == 0 || option == 1 || option == 2 || option == 3 || option == 4 || option == 5 || option == 6) # until loop will print the gets command until the user inputs a relevant option. print ColorizedString["Please enter your choice: "].colorize(:red) option = gets.chomp.to_i end ``` #### Save and Exit To allow the user to exit the app and add a bookmark, we added the following code: ```ruby puts ColorizedString["What would you like to do now? "].colorize(:red) # adding an option to save and exit puts """ 0. Save and exit game 1. Bind your head with cloth from your shirt 2. Call out to whoever is there 3. Try to sneak toward the person in the wreckage 4. Ignore the person in the wreckage and climb through the mess to the front of the train " option = nil until (option == 0 || option == 1 || option == 2 || option == 3 || option == 4) print ColorizedString["Please enter your choice: "].colorize(:red) option = gets.chomp.to_i end
if option == 0 # if the user selects the option to 'save and exit game' they are given their current page number
puts "your current page number is 2"
# the app then terminates because option 0 has no further link
elsif option == 1
puts Page3.text
elsif option == 2
puts Page4.text
elsif option == 3
puts Page5.text
elsif option == 4
puts Page6.text
else
end
end end
```ruby
require_relative 'pages/list' # providing the path for the 'list' file because it is located in a different folder to the current file 'load'
module Load
def self.text
print ColorizedString["Please input your page number: "].colorize(:red)
number = gets.chomp.to_i # prompting the user to input the page number
if number == 1
puts Page1.text
elsif number == 2 # using an if statement to link the user back to the page where they left off
puts Page2.text
elsif number == 3
puts Page3.text
elsif number == 4
puts Page4.text
# and so on...
else puts ColorizedString["THAT'S NOT A VALID CHOICE" ].colorize(:red)
end
end
end