Skip to content
I Know Your Name is a text based horror game
Ruby
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Docs
src
tests
LICENSE
README.md
development-log.md
help.md
software-development-plan.md

README.md

I Know Your Name logo

I KNOW YOUR NAME

GitHub followers Twitter Follow

Source code: https://github.com/alexleybourne/I_Know_Your_Name

Files:

Description

‘I Know Your Name’ Is a text based horror game inspired by a new genre of horror has become popular with the concept of a game becoming self aware. The game has been coded with Ruby using multiple Gems, custom methods, modules and following the DRY (Don't Repeat Yourself) principle.

This Terminal game take the classic text adventure game formula and flips it on its head. With the computer becoming more and more evil as you progress. Your choices change the outcome of the game based on how you interact with the computer.

Installation Instructions

  1. Follow these instructions to download and install Ruby on your computer.
  2. Download and unzip the project files onto your computer.
  3. On the terminal command line, navigate to the src folder. Install the bundler gem (if you haven't already)
> install bundler
  1. Ask bundle to install the gems that we use for the program.
> bundle install 
  1. In the terminal command line, navigate to the src folder by inputting the command
> cd (src - where you saved the files) 
  1. Input the below command in the terminal command line.
> ruby main.rb
  1. If you get an error message try updating your gems
> gem update --system
  1. Run program using step 6 again.

Motivation

I have recently been watching many horror movies and that naturally gave me the idea that I wanted ot create a horror based text game. I wanted to also stand out and make something unique to leave a lasting impression.

I have not seen many games fill this new niche genre of horror games so adding naother to the mix will be a welcomed addition.

The target audience are gamers with some tech knowledge to be able to run the game and understand what is "Happening" to their system as they progress. They will interact with the terminal console answering the computers questions and making their way through the multiple paths until the computer has had enough and they reach the end.

I also played with other ideas in my brainstorming process:

  • Recreating Snake the classic hit arcade game. However this would be a very large project to undertake in such a short time and would lack originality.

  • A Calendar App That would allow the user to input an event, description and date. The information would be stored in a local text document. The app will check for the current date on the users machine to display the correct day and any events on that day. With a search feature that will allow the user to search a date and see if they have anything on there.

  • A ASCII Text Generator, which would take a users input as a string and then allow them to pick a text style from a set list. Then grab each letter from the users string and print the correct ASCII character in order. I felt this seemed quite boring and wouldn't have much functionality.

In the end I am happy with my choice to follow through on the text based horror. This allowed me to create multiple creative pathways, challenge myself with more functions and combine my passion for fun horror.

Features and Functionality

I Know Your Name is a single-player text game where the user either inputs or selects a pre defined input in response to the computers questions.

The game begins with the Title loading and then the computer starts asking a series of odd questions and then attempting to guess your name.

The users choices will affect the overall outcome. Each pathway is slightly different and results in one of three possible endings.

Will you escape the computers demands?

Current features:

Warning Spoilers

  • Prints text left to right in a typing format
  • Randomly generated names from a database (faker)
  • Receives user text input to decide the story pathways
  • Allows the computer to move the cursor and delete text
  • Saving user inputs for later use
  • Random generators pick questions from a string to make each user experince unique
  • Glitch text effects that flicker between words and colours
  • Animated loading bars to emulate file uploads, downloads and corruption
  • Ability to play again once the game has ended
  • ASCII art logo for start and end page
  • Fullscreen glitch animations

Possible features:

  • Logo animation when game starts
  • Sound bytes to play as th story progresses, such as glitch sounds, error sounds and even a creepy computer voice
  • The end screen displays a quote about Artificial intellegence chosen from an array
  • The computer can move the users computer mouse to mess with them
  • The computer can send notifications to the users computer

Code Structure

Gems used:

I Know Your Name makes use of numerous gems to enhance the user experience and add more features to the end product.

  • Bundler Is used to handle all Gem installations. To provide an easy setup for the user as all version and dependencies are controlled through it and saved in the gem & gem lock files.
  • Test-Unit Was used to assist in Test Driven Development.
  • IO-Console Allows the game to be started by pressing any key.
  • Faker Provides the computer with a large databse of names for its name generation.
  • Colorize Enables the use of coloured outputs in the Terminal.
  • TTY-Cursor To enable the computer to easily navigate the console and delete lines.
  • TTY-ProgressBar Which enables the ability to easily display and create progress bars. (The file transfers)

Design and Implementation

I Know Your Name was created in three days by Alex Leybourne as part of Ruby Assessment at Coder Acadmey

In the early stages of planning I brainstormed potential ideas and functionality I could incorporate within them. I then settled on the text based horror idea and began forminga basic strucutre of what to do, features, user stories etc. in My Trello Board.

I then got to work on the flowchart of the app to layout the story line and the paths the user can take. How the computer will interact with them and the way it will all work.

Flowchart of story pathways and functions:

I Know Your Name Flowchart

Project Timeline & Planning Progress

The planning process involved mainly the flowchart as shown above. It went through many itterations and changes. That mainly involved myself writing over it in red pen on the fly as I worked on the project. The initial planning and pre visualization of the program was mostly done the first day after getting the project. The project was managed through Trello and updated as I progressed. My Trello board listed all tasks that needed to be completed, features, gems, user stories, bugs etc.

A full record of the planning can be found here:

Trello Board Screenshot

Testing

This application was developed following the rules of Test Driven Development. Each function was made to pass a very specific test case and then edited / refactored to be made as small and simple as possible.

A key part to this testing was the use of the Test-Unit Gem .

Testing Screenshot

Other testing was done by myself trying out each possible function / input in numerous ways. I then got fellow students, friends and fmaily to try out my program and report back any bugs and potential upgrades / changes.

Copyright, ethical, social issues

Being a text based game. It did not raise any concerns, however the nature of the game could make some users believe their files are actually at risk. The potential need for a disclaimer was thought of. But was deemed unnecessary due to the application being labled as a game and the user can easily see after that none of their files are deleted.

Copyright issues were not a concern as the idea is completely original and does not take anything from other games.

License

Copyright (c) 2019 Alex Leybourne for Coder Academy.

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, distributeand 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.

You can’t perform that action at this time.