yashk2000 / knightinthenight

This is a Halloween based Godot game 🎃. You need to help Rohan the Knight fight his way through the haunted mansion and get candy ⚔️

🕸️ 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):

• Windows 🗔
• Mac OS🍎
• Linux 🐧

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.

knightinthenight's Issues

Add an enemy to the game

An enemy should be added to the game.

• Death effect
• Enemy rebound

Basic Setup

• Add player
• Add some movement and animation to the player

Add basic contributing guidelines to the project

An open-source project should have a set of basic contribution guidelines to help new contributions get started with contributing easily.

Add a new enemy ghost as a sprite.

Since we're doing a Halloween theme, a spooky ghost will be a better enemy than a flapping bat. I'll replace the ghost with a bat in the upcoming pr.

Restart Button

Summary

Add a new restart button to the game, the existing one is buggy

Steps to reproduce

• Remove the current one
• Reconfigure the signals
• Add a new one

Expected behaviour

• Game restarts upon clicking on "Restart"

Observed behaviour

• Same as expected

Additional Information

Screenshots

Would you like to work on this issue?

• Yes
• No

Make the ground spooky and dark

Changes to be made to floor tiles

Expand world

Currently, the world (scene) is quite small and can't accomodate a lot of game objects in them. It is preferred to have a bigger world to be able to accomodate more elements (static and dynamic)

Game theme assets

Need to decide on a game theme and add those assets to the game for good Graphics

Update player sprite

The current sprite for the player should be replaced with the new chosen one.
Also add all the existing features to the new sprite by keying the suitable frames.

Add a play pause button

A play pause button should be added to the application such that a user can pause the game whenever they want.

Animations and floor setup

The animations of the player need to be set
also the floor needs to be set up

Add a Code of Conduct to the project.

A code of conduct should be added to the project as a part of OSS best practices so that contributors know how to behave while contributing to the project.

Add a copyright notice

Add a copyright notice to the project in compliance with our Apache license.

Player abilities

Give abilities to the player.

These could include :

1. Attack/defense
2. Advanced movement

Add a readme to the project

Add a readme to the project with the general information about the project and links to all the important documentation of the project.

Resolution bug and BG-music

The following bugs were found while testing the game:

• The resolution gets distorted while using the menu and persists in the game as well.
• The detection range for the enemy is also quite small.

Additional requirements:

• Preferably have a constant background music that compliments the theme

Game-over screen

The game needs a "Game Over" screen at the end of it. The screen should be separate for winning/losing of the player.

Add object which gives health

Add a flower that will give the knight a health point. 💮

Add hit effect

When the player kills the enemy, there shall be a tiny blast-like effect.

Add special effects and sound

Some extra features can be added to the game, like:

1. Special effects on player-enemy interactions
2. Sound effects