{"id":16294735,"url":"https://github.com/thealphadollar/brkout","last_synced_at":"2025-09-08T07:32:29.451Z","repository":{"id":57416402,"uuid":"114479027","full_name":"thealphadollar/brkout","owner":"thealphadollar","description":"A game made using PyGame under CodeClub as a learning project.","archived":false,"fork":false,"pushed_at":"2019-05-05T10:14:29.000Z","size":143807,"stargazers_count":8,"open_issues_count":11,"forks_count":19,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-08-31T15:46:30.197Z","etag":null,"topics":["artwork","design","game-development","physics-2d","pip","prison-break","pygame","python-packaging"],"latest_commit_sha":null,"homepage":null,"language":"Python","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/thealphadollar.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-12-16T17:40:24.000Z","updated_at":"2024-04-25T17:48:33.000Z","dependencies_parsed_at":"2022-09-26T16:31:21.961Z","dependency_job_id":null,"html_url":"https://github.com/thealphadollar/brkout","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/thealphadollar/brkout","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thealphadollar%2Fbrkout","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thealphadollar%2Fbrkout/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thealphadollar%2Fbrkout/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thealphadollar%2Fbrkout/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thealphadollar","download_url":"https://codeload.github.com/thealphadollar/brkout/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thealphadollar%2Fbrkout/sbom","scorecard":{"id":877760,"data":{"date":"2025-08-11","repo":{"name":"github.com/thealphadollar/brkout","commit":"9dc7bc5421ea5f554462aee9f363b22a61567613"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.4,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":5,"reason":"Found 15/30 approved changesets -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":8,"reason":"binaries present in source code","details":["Warn: binary detected: game/__init__.pyc:1","Warn: binary detected: game/main.pyc:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 15 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}}]},"last_synced_at":"2025-08-24T06:43:23.260Z","repository_id":57416402,"created_at":"2025-08-24T06:43:23.260Z","updated_at":"2025-08-24T06:43:23.260Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274152220,"owners_count":25231288,"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","status":"online","status_checked_at":"2025-09-08T02:00:09.813Z","response_time":121,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["artwork","design","game-development","physics-2d","pip","prison-break","pygame","python-packaging"],"created_at":"2024-10-10T20:16:18.992Z","updated_at":"2025-09-08T07:32:29.431Z","avatar_url":"https://github.com/thealphadollar.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BrkOut\n\n[![forthebadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/)\u003cbr\u003e\n[![Gitter](https://img.shields.io/gitter/room/:user/:repo.svg)](https://gitter.im/brkout_/Lobby)\u003cbr\u003e\n\nA prison escape game with a blend of brick breaking gameplay and innovative implementation of the same to get the look of an escape.\n\n## Screenshots and Gameplay\n\nWhen you decide to escape\n![alt text](/game/assets/HomeScreen.png)\n\nAs you fight your way through the unbreakable wall\n![alt text](/game/assets/MainGame.png)\n\nYou realise that escape might not be as easy as you thought\n![alt text](/game/assets/LosingScreen.png)\n\nAnd when you finally taste the free air after numerous attempts\n![alt text](/game/assets/WinningScreen.png)\n\n## Prerequisite\n\nPython2 or Python 3 are the default languages needed for playing this game [on Linux], to check which version of Python you have, type the following in terminal:\n```\npython --version\n```\n## Downloading Brkout and Playing\n\nYou can use the below commands.\n\n```\nsudo apt-get install python-pip\npip install --upgrade pip\n```\n```\npip install brkout\n```\nIf this does not work, then\n```\nsudo -H pip install brkout\n```\nFor more info, visit [Pygame download page](http://www.pygame.org/download.shtml)\n\n## Developing on the Game\n\n### On Linux\n\n1. Clone the branch on your local machine:\n```\ngit clone https://github.com/thealphadollar/brkout.git\n```\n2. Install pipenv (`pip3 install pipenv`) and then install all dependencies (`pipenv install --dev`).\n3. Make the required changes\n4. Test the game by running `python3 -m game` from the repository's directory.\n5. Send a Pull Request\n\n### On Windows\n\n1. Clone the repository by the method appropriate for the Git interface you are using.\n2. Install Python 3.x\n3. Install the future library\n```\npip install future\n```\n4. Start the game using\n```\npython -m game\n```\n5. pip install any missing libraries\n6. Always pull changes from the main repo before adding your changes\n```\ngit pull upstream master\n```\n7. Create a new branch to work on feature\n```\ngit branch \u003cfeature_branch\u003e\n```\n8. Make it the working branch\n```\ngit checkout \u003cfeature_branch\u003e\n```\n9. Commit your changes\n10. Merge your feature branch to the master branch when all the changes are done\n```\ngit checkout master\ngit merge \u003cfeature_branch\u003e\n```\n11. Push your changes to your fork by\n```\ngit push origin master\n```\n12. Create a new Pull Request on the main repo\n13. Make any required changes\n14. When the PR is merged, repeat #6 - #14\n\n## Gameplay Help\n\n1. The game can be controlled using arrows keys or the 'w', 'a', 's' and 'd' keys.\n2. Spacebar and enter key both act as the selection key.\n3. Spacebar or escape key can be used to pause the game.\n4. Choose the required difficulty level by clicking on it.\n5. Reset the highscore, if needed, by clicking on the 'reset' icon.\n6. The game can also be played with a Joystick, which has to be plugged in before you \n   launch the game.It works well with AMKETTE game pad but any standard game pad would also work.\n\n### Powerups\n\nCurrently 5 types of powerups are in the game. Go over a powerup to pick it up. Currently active powerups are shown in top left of the screen.\n\n- Double Damage: Doubles the damge caused to bricks  \n\n![double_damage](https://user-images.githubusercontent.com/6888341/50610393-d2a1ad00-0ef8-11e9-87a1-3d9ad419bc1a.png)\n\n- Double Power: Sriker's power is doubled  \n\n![double_power](https://user-images.githubusercontent.com/6888341/50610396-d7666100-0ef8-11e9-9fe9-e2f85d5839e3.png)\n\n- Double Score: Score is doubled  \n\n![double_score](https://user-images.githubusercontent.com/6888341/50610400-da615180-0ef8-11e9-8b89-8388dc475af5.png)\n\n- Double Speed: Ball's maximum speed is doubled  \n\n![double_speed](https://user-images.githubusercontent.com/6888341/50610404-ddf4d880-0ef8-11e9-9384-e570aebafc4e.png)\n\n- No Friction: Friction is removed temporarily  \n\n![no_friction](https://user-images.githubusercontent.com/6888341/50610407-e0573280-0ef8-11e9-9c33-27492e236c54.png)\n\n\n# Enjoy The Game\n\n# Contribute\n\nPlease read CONTRIBUTING.md guide to know more.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthealphadollar%2Fbrkout","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthealphadollar%2Fbrkout","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthealphadollar%2Fbrkout/lists"}