{"id":14978289,"url":"https://github.com/mgnfy-view/the-knights-quest","last_synced_at":"2025-07-22T10:39:21.357Z","repository":{"id":244520657,"uuid":"814982092","full_name":"mgnfy-view/the-knights-quest","owner":"mgnfy-view","description":"A bite-sized platforming game with a greedy knight","archived":false,"fork":false,"pushed_at":"2024-06-21T09:38:34.000Z","size":4350,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-09-29T01:07:51.239Z","etag":null,"topics":["aesprite","css","eslint","eslint-config","game","game-development","html","javascript","kaboom-js","kaplay","pnpm","prettier","tiled-map-editor"],"latest_commit_sha":null,"homepage":"https://mgnfy-view.itch.io/the-knights-quest","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mgnfy-view.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-14T05:28:06.000Z","updated_at":"2024-07-01T20:37:31.000Z","dependencies_parsed_at":"2024-09-24T00:02:00.243Z","dependency_job_id":"9b17c0b3-76cf-47c6-9014-4e39a55bbdd4","html_url":"https://github.com/mgnfy-view/the-knights-quest","commit_stats":{"total_commits":13,"total_committers":2,"mean_commits":6.5,"dds":0.07692307692307687,"last_synced_commit":"1fc596161197775de58df9d8daced854cdb6802f"},"previous_names":["mgnfy-view/tile-smash","mgnfy-view/the-knights-quest"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mgnfy-view%2Fthe-knights-quest","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mgnfy-view%2Fthe-knights-quest/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mgnfy-view%2Fthe-knights-quest/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mgnfy-view%2Fthe-knights-quest/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mgnfy-view","download_url":"https://codeload.github.com/mgnfy-view/the-knights-quest/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219859904,"owners_count":16556031,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aesprite","css","eslint","eslint-config","game","game-development","html","javascript","kaboom-js","kaplay","pnpm","prettier","tiled-map-editor"],"created_at":"2024-09-24T13:57:18.055Z","updated_at":"2024-10-11T17:24:06.957Z","avatar_url":"https://github.com/mgnfy-view.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- PROJECT SHIELDS --\u003e\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/mgnfy-view/the-knights-quest\"\u003e\n    \u003cimg src=\"./public/images/iconScaled.png\" alt=\"Logo\" width=\"80\" height=\"80\" /\u003e\n  \u003c/a\u003e\n\n  \u003ch3 align=\"center\"\u003eThe Knight's Quest\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    A bite-sized platforming game with a greedy knight\n    \u003cbr /\u003e\n    \u003ca href=\"https://mgnfy-view.itch.io/the-knights-quest\"\u003ePlay\u003c/a\u003e\n    -\n    \u003ca href=\"https://github.com/mgnfy-view/the-knights-quest/issues/new?labels=bug\u0026template=bug-report---.md\"\u003eReport Bug\u003c/a\u003e\n    -\n    \u003ca href=\"https://github.com/mgnfy-view/the-knights-quest/issues/new?labels=enhancement\u0026template=feature-request---.md\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#built-with\"\u003eBuilt With\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About The Project\n\n\u003cimg src=\"./public/images/screenshot.png\" width=\"540\" /\u003e\n\nThe knight's quest is a single-player, platforming game built with javascript and kaplay, a javscript based game engine. With bite-sized but well thought levels, simple controls, and a decent set of mechanics, it is a great choice for a small gaming session.\n\nIt has also been published on [itch.io](https://mgnfy-view.itch.io/the-knights-quest).\n\nMore levels will be added over time!\n\n\n### Built With\n\n- ![JavaScript][javascript-url]\n- ![Kaplay](https://img.shields.io/badge/-KAPLAY-6BC96C.svg?style=for-the-badge)\n- ![PNPM][pnpm-url]\n\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n\n### Prerequisites\n\nMake sure you have git, nodejs, and pnpm installed and configured on your system.\n\n### Installation\n\nClone the repo and cd into it\n\n```shell\ngit clone https://github.com/mgnfy-view/the-knights-quest\ncd the-knights-quest\n```\n\nInstall the project's dependencies\n\n```shell\npnpm install\n```\n\nStart the server to run the game locally\n\n```shell\npnpm run dev\n```\n\nThats' it, you should be ready to go now.\n\n\n\u003c!-- USAGE EXAMPLES --\u003e\n## Usage\n\nYou can use the arrow keys to move left and right. Press the spacebar to jump and x to shoot fire balls. Fire balls can destroy tiles (red blocks) as well as scaffolds (purple blocks). Water elevators allow you to climb greater heights. Collect all the coins to make the knight happy!\n\nHere are some in-game screenshots\n\n\u003cimg src=\"./public/images/display1.png\" width=\"540\" /\u003e\n\n\u003cimg src=\"./public/images/display2.png\" width=\"540\" /\u003e\n\n\u003cimg src=\"./public/images/display3.png\" width=\"540\" /\u003e\n\n\n\u003c!-- ROADMAP --\u003e\n## Roadmap\n\n- [x] Make a sprite sheet using Aesprite\n- [x] Design levels with the Tiled map editor\n- [x] Develop the game with javascript and kaplay\n  - [x] Add scenes\n    - [x] Add game objects\n    - [x] Register controls\n    - [x] Register events\n  - [x] Add global state\n  - [x] Add a menu and ending screen\n  - [x] Code review and cleanup\n- [x] Write a good README.md\n\nSee the [open issues](https://github.com/mgnfy-view/the-knights-quest/issues) for a full list of proposed features (and known issues).\n\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\nDon't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\nI'd love to see contributions that add more levels to game. You don't have to write a single line of code to submit levels. Use the spritesheet from `./public/spriteSheets/spriteSheet.png` and the tiled map editor to create a level. Export the map in the `.tmx` form in the `./public/tiled` folder, and create a pull request. It's that easy!\n\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the MIT License. See `LICENSE.txt` for more information.\n\n\n\u003c!-- CONTACT --\u003e\n## Contact\n\nHere's a gateway to all my socials, don't forget to hit me up!\n\n[![Linktree](https://img.shields.io/badge/linktree-1de9b6?style=for-the-badge\u0026logo=linktree\u0026logoColor=white)][linktree-url]\n\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n[contributors-shield]: https://img.shields.io/github/contributors/mgnfy-view/the-knights-quest.svg?style=for-the-badge\n[contributors-url]: https://github.com/mgnfy-view/the-knights-quest/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/mgnfy-view/the-knights-quest.svg?style=for-the-badge\n[forks-url]: https://github.com/mgnfy-view/the-knights-quest/network/members\n[stars-shield]: https://img.shields.io/github/stars/mgnfy-view/the-knights-quest.svg?style=for-the-badge\n[stars-url]: https://github.com/mgnfy-view/the-knights-quest/stargazers\n[issues-shield]: https://img.shields.io/github/issues/mgnfy-view/the-knights-quest.svg?style=for-the-badge\n[issues-url]: https://github.com/mgnfy-view/the-knights-quest/issues\n[license-shield]: https://img.shields.io/github/license/mgnfy-view/the-knights-quest.svg?style=for-the-badge\n[license-url]: https://github.com/mgnfy-view/the-knights-quest/blob/master/LICENSE.txt\n[javascript-url]: https://img.shields.io/badge/Javascript-%23323330.svg?style=for-the-badge\u0026logo=javascript\u0026logoColor=%23F7DF1E\n[pnpm-url]: https://img.shields.io/badge/pnpm-%234a4a4a.svg?style=for-the-badge\u0026logo=pnpm\u0026logoColor=f69220\n[linktree-url]: https://linktr.ee/mgnfy.view\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmgnfy-view%2Fthe-knights-quest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmgnfy-view%2Fthe-knights-quest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmgnfy-view%2Fthe-knights-quest/lists"}