diff --git a/README.md b/README.md index 7c72e00..39975eb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,62 @@ -This project is published under the Creative Commons Zero (CC0) license. +# Project Title: -You can use the code for any project you like, including commercial ones. Attributions would be appreciated but are not required. +Creating a Zelda style game in Python [with some Dark Souls elements] + +## 1. Project Description: + +A Zelda-style RPG in Python that includes a lot of elements you need for a sophisticated game like graphics and animations, fake depth; upgrade mechanics, a level map and quite a bit more. + +## 2. Languages or Frameworks Used: + +* [Python](https://www.python.org/) + +* [Pygame](https://www.pygame.org/news) + +## 3. Installing: + +i. Clone the git repo + +``` +https://github.com/clear-code-projects/Zelda.git +``` + +ii. Open project folder + +iii. Explore + +iv. Open main.py and run + +v. Play the game + +Enjoy 😎 + + +## 4. Contributing: + +Pull requests are welcome. + +For major changes, please open an issue first to discuss what you would like to change with "clear-code-projects" (Project Owner). + + +## 5. Original Creator: + +Author: clear-code-projects + +Project Name: Files for the Zelda in python tutorial + +Youtube URL: https://www.youtube.com/watch?v=QU1pPzEGrqw + +Github URL: https://github.com/clear-code-projects/Zelda + +Date: 29 January, 2022 + +## 6. Licences: + +This project is published under the Creative Commons Zero (CC0) license. + +You can use the code for any project you like, including commercial ones. Attributions would be appreciated but are not required. + +The art assets and the soundtrack have been done by Pixel-boy and AAA and can be found here: https://pixel-boy.itch.io/ninja-adventure-asset-pack. + +They are also published under a CC0 license. -The art assets and the soundtrack have been done by Pixel-boy and AAA and can be found here: https://pixel-boy.itch.io/ninja-adventure-asset-pack -They are also published under a CC0 license.