UNIX MANSION

A bashing good educational adventure

Unix mansion is an directory based adventure "game" where you progress by learning and performing various tasks and answering questions about the Unix ecosystem.

How to play?

NOTE: You will learn more and more as you progress. Don't stress if everything isn't clear when you start. There will be questions. Be sure to read tips from below.

0. Download i.e. "clone" the repository to your computer somewhere under your home directory.
   git clone [email protected]:DigitKoodit/unix-mansion-adventure.git

NOTE: if cloning doesn't work you might need to configure secure shell connection (SSH) to Github: How to configure SSH

1. Hero's oldest and trusted friend cat will help along the adventure. Running cat <filename> will output the content of the file.
2. Each directory will contain little information about the current location and task at hand in a file room.txt.
3. The file task.txt contains a question or a task to which you need to answer or perform before proceeding to the next level.
4. Enter your answer as a parameter with double quotes to a unlock.sh script on command line: ./unlock.sh "my answer".
5. Find next room with a task file.

Mansion (project) structure

Each directory withing the Mansion has the similar structure:

• room.txt
• task.txt
• unlock.sh
• directories (directions) up, left, right
• various directories and files

room.txt

Description of the room.

task.txt

Objectives, instructions, hints and tips what is the answers to get to the next room

unlock.sh

Checks the answer and possibly opens the next room. Useful only if villain mode is activated

dir(ections)

Possible rooms where to enter after correct answer.

Various dirs/files

Room might contain sub directories and files.

Hints and tips

Use cd <directory> command to enter new directory e.g. cd mansion

Tabulator "tab"-key lists available files and directories slightly depending on a command being excecuted. When combined with cd terminal will propose all directories where you can enter.

Run scripts on a command line by adding a dot and dash ./ in front of the .sh file. See the first step.

Find instructions for any unix command by adding man in front of the command e.g. man cd

About the project

Custom helper bash scripts were used to construct the mansion. Scripts from ./utils folder were added temporarily to the PATH env variable in order to use scripts where ever within the project:
PATH="$PATH:$PWD/utils

The project is tested with Ubuntu 18. If you encounter any errors or have improvement ideas please leave a comment for example via Github's issue panel or make a pull request :)