Add README file and update license

Author: LorenzCK

CODE_OF_CONDUCT.md

@@ -0,0 +1,77 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
+

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 CodeMOOC
+Copyright (c) 2021–2022 CodeMOOC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -0,0 +1,73 @@
+# CodyMaze bot
+
+A Telegram bot that challenges you in an “Hour of Code”-style game, with coding-based challenges that must be solved by physically moving on a full-scale chessboard.
+
+![CodyMaze cover](/docs/codymaze-cover.jpg?raw=true)
+
+This version of the CodyMaze bot is a porting to C#/.NET of the [original bot](https://github.com/CodeMOOC/CodyMazeBot), re-architected to work within a Docker container.
+
+## Introduction
+
+In the context of the recent push for modern educational tools for teachers, which aim at bringing so-called “computational thinking” to the classroom and thus encourage young children to acquire basic logical and coding skills, several different programming-based games have been developed and proposed (for instance, the web-based [Hour of Code challenge](https://hourofcode.com) on Code.org).
+
+The University of Urbino has developed several tools based on messaging bots, to deliver portable, affordable, and easy to use games to teach coding in larger classrooms.
+The first of these initiatives is “[Code Hunting Games](http://codehunting.games)”, that allows users to create coding-based treasure hunts.
+
+## The game
+
+CodyMaze is a simple and portable “public square” game: it can be easily reproduced (using 9 sheets of paper and/or other objects) and installed in any larger open space, including classrooms or playgrounds.
+The players are guided through a dynamically generated maze: the bot will send out instructions (in the form of code snippets) that the players must follow in order to reach their destination (thus executing the code).
+If players successfully reach their destination and complete the maze, they will receive a completion certificate.
+
+### The chessboard
+
+The CodyMaze chessboard is a 5×5 grid, rows are numbered from 1 to 5, columns from A to D.
+The chessboard is oriented, so that players can identify 4 cardinal directions as shown in the following figure.
+
+![CodyMaze chessboard](/docs/figure-chessboard.jpg?raw=true)
+
+Each chessboard square is identified with a special QR Code, which allows the Telegram bot to determine in which square the player is currently located.
+[QR Codes must be downloaded and printed](http://codemooc.org/wp-content/uploads/2017/09/CodyMaze-QRCodes.zip) on paper sheets.
+The codes must be arranged as shown in the figure above.
+To ensure that QR Codes do not move, they can be attached to carboard boxes, tin cans, or other objects.
+The chessboard can optionally be drawn in chalk or using tape.
+
+Some of the squares are marked by a “star icon”. ⭐
+Instructions of the CodyMaze bot, in the later part of the game, will include conditional operators that depend on whether a “star” is on the square currently occupied by the player or not.
+
+### Player requirements
+
+Each player will have to satisfy the following requirements in order to play:
+
+* A smartphone with a camera and a Telegram client (registration to the messenger service is free),
+* Mobile data connection or Wi-Fi,
+* A QR Code scanner app (built in the native camera application on many popular mobile operating systems).
+
+### How to play?
+
+In order to start the game, you must move to one of the chessboard’s outer squares (that is, any square on the first or last row, or on the first or last column).
+Scan in the QR Code you find there and follow the instructions provided by the bot.
+
+At each step, the bot will **ask for your orientation** (in terms of the cardinal directions as indicated in the figure above) and will then provide you with an **instruction** to follow.
+The command is composed of basic instructions such as `f` for “move one step forward”, `l` for “turn left”, and `r` for “turn right”.
+Other, more complex, instructions such as `while`, `if`, and `else` will be used as the game progresses.
+Instructions blocks (indicated by braces `{}`) can be repeated: for instance, `2{fr}` is equivalent to `frfr` and means that you will have to move forward and turn right twice.
+
+After executing the instructions given by the bot and arriving on a new square (which in some cases can be the same square from which you started), you must **scan the square’s QR Code**.
+The bot will confirm that you have reached the correct destination.
+If—at any point—you fail to correctly follow the instructions, the bot will tell you so and will let you move back to a previous position.
+
+The game is over after **13** correctly executed instructions.
+
+## Source code and contributions
+
+The Telegram bot is implemented in C# and makes use of a Cloud Firestore database.
+The source is available under the *MIT license*. Pull requests welcome! 🙏
+
+### Thanks and acknowledgments
+
+* Alessandro Bogliolo
+* Brendan Paolini
+* Lorenz Cuno Klopfenstein
+* Saverio Delpriori
+* Caba Veres