open-source-community / whostolemyka7k Goto Github PK

0.0 0.0 0.0 29 KB

Shell 100.00%

whostolemyka7k's Introduction

Who Stole My Ka7k?

You buy a box of ka7k on Eid night and wait patiently for morning to eat them. Unfortunately, you wake up to find them all gone.

You are on a mission to find your ka7k, while learning some handy bash commands along the way.

FAQ

How can I play?

Clone this repo.

git clone [email protected]:Open-Source-Community/WhoStoleMyKa7k.git
In a bash shell, go to the game folder.

cd WhoStoleMyKa7k

The game has not been tested in other shells, but should be playable. However, some commands may not work as expected.
Run the start script to enable cheat command.

source ./start.sh

Note: this script will not work in zsh.
Run cheat from anywhere in the game to bring up a bash command cheat-sheet.

Note: the cheat command will not work in zsh.
Go to the directory (folder) named home in the game
Explore the game folders and files with your newly equipped commands!
If you are stuck, type cheat into the terminal and hit enter (from anywhere within the game folder!).

How many rooms/areas are there for me to explore?

Currently, there are 4.

Living room
Kitchen
Bedroom
Garden

What commands will I learn?

cd
ls [-a]
mv
cp [-r]
cat
less
rm [-r]
mkdir
touch

Can I contribute?

Absolutely! Check out contribution guidelines here.

Credits

Game by: Amna Ahmed
Special thanks to: Sara Darwish and Mo'men Kadry
Made for OSC (Open Source Club) Salakhana '24

whostolemyka7k's People

Contributors

whostolemyka7k's Issues

Script to check garden task

check if there is still 5 flowers in the garden

and check if there is at least one flower in the vase

if correct, replace the vase file content with this (check raw file)

What a beautiful vase of flowers!
, .-.-,,
)`-.>'` (
/ `\ | | | | \ / /` =(\ /.= -;`.-'` )| ,
|| .-'|
,|| _,/
, || .'
||\ , ||/
,` |/| |Y,
'-.'-.||/
>.-`Y|` .-"||"-.
'----'/
|:. |
|::. |
/::::
.:::' '.
/:::
;:::' ;
|::: |
|::: |
|::: |
;::: ;
:::. /
':::.. .'
`""-----""`
[art by: joan stark]

else

display error message depending on the failing condition

Script to check final task in the game

kitchen/ pantry/.back_of_the_pantry

check if there is a box containing 1 kahk in .back_of_the_pantry where the rat is

and check if there is kahk_box in the living room containing 19 kahk

if so, print "Congratulations! Look for the ending hidden in this folder"

Else print an error message depending on the failing condition

Create "hint" command

If the user gets completely stuck, running hint should show him the complete command(s) he should run to finish the task.

For how to implement the command, we will follow the steps of the cheat command. It is an alias created by running the initializer script (source ./start.sh). hint will also be an alias that will display the hint file in the directory it was ran in.

This means that we need to create a hint file in every directory that contains a task, and show a message if the user tries to run it in a non-task directory.

Script to check task in kitchen/pantry

home/kitchen/pantry/check.sh

check if file names of expired items (cheese and chocolate) no longer exist

If they do, print "You forgot to throw [file name!]

Very close to script in bedroom closet

Game initializer script

alias cheatsheet to run less CHEAT_SHEET
should run from anywhere in the directory
this command might be helpful: git rev-parse --show-toplevel

also alias check to ./check.sh
it will automatically run the check script in whatever directory youre in