tutorial.md

Introduction

Welcome to Code Breakers!

You can either play alone with a bot or together with another player.
The goal of the game is to guess a code that the other player/bot has made up.
The code is 4 symbols long and you have 13 attempts to guess it.

Controls and Mechanics

Start menu

When you start the game, you are first shown the main menu, where you can customise the rules of the game.

• Move up with 'w' or 'W'
• Move down with 's' or 'S'
• Toggle the selected rule with 'Enter'

A rule is selelcted, if it is grayed out from the sides.
A rule is turned on, if it is coloured green.
A rule is turned off, if it is coloured red.

When ready, navigate to the blue start button and press 'Enter'.

Player 1's turn / Bot's turn

If you have chosen to play against another player, they must first write the code. You mustn't watch while it's the other player's turn. Be patient.

If you have chosen to play against a bot, it will automatically write the code.

Player 2's turn

After the codee has been chosen, it's your turn to guess it. Write your guess, but bewarem as you have only 13 attempts to figure out the combination. After 13 failed attempts, you lose and player 1/the bot win.

Changing the game rules

In the start menu, you can change the rules of the game.
The rules that can be changed are

• If you want to play against a bot, or against a player
• You can choose what symbols are allowed in the code. You have 4 options
  1 - Numbers from 0 to 7
  2 - All numbers
  3 - All lowercase letters
  4 - All uppercase letters
  You can mix options 2, 3 and 4 for a harder game.
• You can choose if the symbols can be repeated in the code

---

That's all!

We hope you enjoy our game.
Have fun!

⛤ GitHub Cultists ⛤