Skip to content

yashk2000/KnightInTheNight

Repository files navigation

KnightInTheNight

๐Ÿ•ธ๏ธ Knight In the Night

It's Halloween ๐ŸŽƒ! Rohan dressed as knight was on his way to Trick and Treat ๐ŸŒ†, when he knocked outside the door of a mansion ๐Ÿฐ. The door seemingly on it's own, opened up revealing a spooky interior of the mansion. Giving no thought to this since it is Halloween, Rohan entered the house to get some candies. But little did he know that this particular mansion was haunted ๐Ÿ‘ป! Now you need to help Rohan make his way through the mansion, fighting his way past foes โš”๏ธ. If he makes it past all the enemies, not only he does he get a large bag of candy ๐Ÿฌ, but since it is a magical night, he shall also get the superpowers of a Knight โœจ!

๐Ÿ‘จโ€๐Ÿญ Who are we?

This project was built by Preet Shah, Shambhavi Aggarwal, Rohan Rout and Yash Khare.

๐Ÿ’ป What did we use?

This game has been developed using the Godot Game Engine ๐Ÿค–.

Disclaimerโ—

Install at your own risk โš ๏ธ

Everyone involved with the developmnent of the game is working with Godot, or for that matter any game development technology, for the first time. If you play the game and find any issues, the project creators are in no way responsible for whatever happens to you or your system ๐Ÿ’ฅ.

๐Ÿ‘จโ€๐Ÿ’ป For contributors

  • Before contributing do go through the Code of Conduct and the Contributor Guidelines. ๐Ÿ”ง
  • If you find any bugs in the application, or a feature you think would be nice to have, please open an issue. ๐Ÿž
  • Continue reading the rest of the README to get the build instructions. โ›๏ธ
  • For detailed information and screenshots of the project, please head over to the project wiki. ๐Ÿ“š

๐Ÿ”จ Installation

๐ŸŽฎ Playing the game

  • Moving up: ๐Ÿ‡ผ or โฌ†๏ธ
  • Moving left: ๐Ÿ‡ฆ or โฌ…๏ธ
  • Moving down: ๐Ÿ‡ธ or โฌ‡๏ธ
  • Moving right: ๐Ÿ‡ฉ or โžก๏ธ
  • Hitting with the sword: ๐Ÿ‡ฏ or ๐Ÿ‡ฝ

You can download the game from our GitHub Actions artifacts. Head over to the GitHub Actions tab, click on the latest build and download the file for the OS you want.

Quick links(these links might be behind the latest build. For the latest build please follow the instructions mentioned above):

You can try out the game directly from the browser all well over here: https://yashk2000.github.io/KnightInTheNight/

For best results, launch the URL on Google Chrome, and ensure you have webGL enabled ๐Ÿค–. Browser based KnightInTheDark is just in it's alpha phase. The game works completely, but desktop functionalities such as quit do not ๐Ÿฅถ. These only work on the desktop based Godot app ๐Ÿ–ฅ๏ธ.

๐Ÿ› ๏ธ Setting up the Project

To setup the project, download Godot Engine. Once it's downloaded and installed, select import project. Navigate to the folder where you cloned the repository. Enter the Games folder, and clicking project.godot to open the project in the Godot Editor.

๐Ÿ“œ License

This project is released under a free and open-source software license, Apache License 2.0 or later (LICENSE or https://www.apache.org/licenses/LICENSE-2.0). The documentation is also released under a free documentation license, namely the GFDL v1.3 license or later.

๐Ÿ–Š๏ธ Contributions

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions.