{"id":14111298,"url":"https://github.com/FullScreenShenanigans/FullScreenPokemon","last_synced_at":"2025-08-01T12:32:32.425Z","repository":{"id":23932076,"uuid":"27313221","full_name":"FullScreenShenanigans/FullScreenPokemon","owner":"FullScreenShenanigans","description":"A free HTML5 remake of the original Pokemon, expanded for modern browsing.","archived":false,"fork":false,"pushed_at":"2023-03-05T05:31:13.000Z","size":283540,"stargazers_count":216,"open_issues_count":133,"forks_count":90,"subscribers_count":22,"default_branch":"main","last_synced_at":"2024-10-30T22:44:08.503Z","etag":null,"topics":["fullscreenmario","game","gamestartr","html5-remake","javascript","pokemon","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/FullScreenShenanigans.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":"2014-11-29T19:51:14.000Z","updated_at":"2024-10-27T19:26:27.000Z","dependencies_parsed_at":"2024-08-14T10:14:00.677Z","dependency_job_id":"4bbb801d-b1d1-4c44-ad7e-d035e21034b9","html_url":"https://github.com/FullScreenShenanigans/FullScreenPokemon","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FullScreenShenanigans%2FFullScreenPokemon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FullScreenShenanigans%2FFullScreenPokemon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FullScreenShenanigans%2FFullScreenPokemon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FullScreenShenanigans%2FFullScreenPokemon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FullScreenShenanigans","download_url":"https://codeload.github.com/FullScreenShenanigans/FullScreenPokemon/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228375867,"owners_count":17910304,"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":["fullscreenmario","game","gamestartr","html5-remake","javascript","pokemon","typescript"],"created_at":"2024-08-14T10:03:14.357Z","updated_at":"2024-12-05T21:31:05.854Z","avatar_url":"https://github.com/FullScreenShenanigans.png","language":"TypeScript","readme":"\u003c!-- Top --\u003e\n\n# FullScreenPokemon\n\n[![Code Style: Prettier](https://img.shields.io/badge/code_style-prettier-brightgreen.svg)](https://prettier.io)\n![TypeScript: Strict](https://img.shields.io/badge/typescript-strict-brightgreen.svg)\n[![NPM version](https://badge.fury.io/js/fullscreenpokemon.svg)](http://badge.fury.io/js/fullscreenpokemon)\n\nHTML5 remake of the original Pokemon, expanded for modern browsers.\n\n\u003c!-- /Top --\u003e\n\n## Usage\n\nThe built `lib/index.html` uses [UserWrappr](https://github.com/FullScreenShenanigans/UserWrappr) to fill the available window size with a game screen, option menus, and piped input events.\nIt stores its generated instance as `window.FSP`.\n\nTo do this in your own page, use the exported `createFspInterface` function.\n\n```javascript\nimport { createFspInterface } from \"fullscreenpokemon\";\n\ncreateFspInterface(document.getElementById(\"game\")).then(() =\u003e {\n    console.log(\"Ready to play! ✨\");\n    console.log(FSP);\n});\n```\n\nYou can also directly create a new `FullScreenPokemon` instance with a manual size.\n\n```javascript\nimport { FullScreenPokemon } from \"fullscreenpokemon\";\n\n// Creates a new game with a 320x480 screen size\nconst fsp = new FullScreenPokemon({\n    height: 320,\n    width: 480,\n});\n\n// Games contain a .canvas member for the screen\ndocument.body.appendChild(fsp.canvas);\n\n// Shows the initial in-game menu with start and load options\nfsp.gameplay.gameStart();\n```\n\n\u003e By default, the game doesn't set up input events.\n\u003e You'll need to set up your own event registrations manually.\n\n### Documentation\n\nFSP is built on top of [EightBittr](https://github.com/FullScreenShenanigans/EightBittr), a modular TypeScript game engine split across separate projects available on npm and hosted on GitHub in the [FullScreenShenanigans](https://github.com/FullScreenShenanigans) organization.\nIt consists of a couple dozen core modules under this organization.\n\nSee [./src/docs](https://github.com/FullScreenShenanigans/FullScreenPokemon/tree/main/docs) for documentation specific to FullScreenPokemon.\n\n\u003c!-- Development --\u003e\n\n## Development\n\nAfter [forking the repo from GitHub](https://help.github.com/articles/fork-a-repo):\n\n```\ngit clone https://github.com/\u003cyour-name-here\u003e/FullScreenPokemon\ncd FullScreenPokemon\nyarn\nyarn run hydrate\nyarn run compile\n```\n\n-   `yarn run hydrate` creates a few auto-generated setup files locally.\n-   `yarn run compile` builds source code with TypeScript\n\n### Running Tests\n\n```shell\nyarn run test\n```\n\nTests are written in [Mocha](https://github.com/mochajs/mocha) and [Chai](https://github.com/chaijs/chai).\nTheir files are written using alongside source files under `src/` and named `*.test.ts?`.\nWhenever you add, remove, or rename a `*.test.t*` file under `src/`, `watch` will re-run `yarn run test:setup` to regenerate the list of static test files in `test/index.html`.\nYou can open that file in a browser to debug through the tests, or run `yarn test:run` to run them in headless Chrome.\n\n\u003c!-- Maps --\u003e\n\u003c!-- /Maps --\u003e\n\n\u003c!-- /Development --\u003e\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFullScreenShenanigans%2FFullScreenPokemon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FFullScreenShenanigans%2FFullScreenPokemon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFullScreenShenanigans%2FFullScreenPokemon/lists"}