{"id":13678090,"url":"https://github.com/play-co/devkit","last_synced_at":"2026-01-17T06:52:40.280Z","repository":{"id":6622557,"uuid":"7866145","full_name":"play-co/devkit","owner":"play-co","description":"HTML 5 game platform for browser and mobile","archived":false,"fork":false,"pushed_at":"2019-11-02T16:00:50.000Z","size":48277,"stargazers_count":628,"open_issues_count":53,"forks_count":126,"subscribers_count":112,"default_branch":"master","last_synced_at":"2025-11-23T04:21:47.811Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://docs.gameclosure.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/play-co.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-01-28T08:47:43.000Z","updated_at":"2025-11-04T16:34:13.000Z","dependencies_parsed_at":"2022-09-16T18:11:47.686Z","dependency_job_id":null,"html_url":"https://github.com/play-co/devkit","commit_stats":null,"previous_names":["gameclosure/devkit"],"tags_count":65,"template":false,"template_full_name":null,"purl":"pkg:github/play-co/devkit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/play-co%2Fdevkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/play-co%2Fdevkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/play-co%2Fdevkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/play-co%2Fdevkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/play-co","download_url":"https://codeload.github.com/play-co/devkit/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/play-co%2Fdevkit/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28502972,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T04:31:57.058Z","status":"ssl_error","status_checked_at":"2026-01-17T04:31:45.816Z","response_time":85,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2024-08-02T13:00:50.038Z","updated_at":"2026-01-17T06:52:35.265Z","avatar_url":"https://github.com/play-co.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"The Game Closure DevKit\n=======================\n\nHTML5 JavaScript game development kit. Run in your browser; build to iOS and\nAndroid.\n\n![devkit](https://cloud.githubusercontent.com/assets/4285147/5399582/7ab4683a-8121-11e4-9f15-6f3b1194b2dc.png)\n\n## Installation\n\n### OS X\n\nDevKit requires that you install few dependencies first:\n\n * [node.js](http://nodejs.org/) v10 or higher\n * [git](http://git-scm.com/)\n\nWe recommend using [brew](http://brew.sh/) to install these if you do not have\nthem already.\n\n### Optional Dependencies\n\nBuilding games for iOS or Android requires installing the corresponding SDKs:\n\n * [Xcode](https://developer.apple.com/xcode/) - required for building games for\n   iOS\n * [Android SDK](http://developer.android.com/sdk/index.html) - required for\n   building games for Android\n * [Android NDK](https://developer.android.com/tools/sdk/ndk/index.html) -\n   required for building games for Android\n * [Ant](http://ant.apache.org/manual/install.html) - required for building\n   games for Android\n\nNOTE: please ensure the apache build tools and ant are available in your path so\nDevKit can find them when trying to build!\n\n### Getting Started\n\nNow, install devkit. You may run into some weird errors if you don't own your\nglobal `node_modules` folder.\n\n    npm install -g devkit\n\n\n### Linux\nFollow the instructions on [the project wiki](https://github.com/gameclosure/devkit/wiki/Install-Instructions---Linux)\n\n### Windows\nWindows platform is supported thanks to [WSL](https://docs.microsoft.com/en-us/windows/wsl/about). Please follow the official [WSL installation guide](https://docs.microsoft.com/en-us/windows/wsl/install-win10) if you do not have it installed yet, and then our [Linux install instructions](https://github.com/gameclosure/devkit/wiki/Install-Instructions---Linux).\n\n\n\n## Creating your first game\n\nYou need a `shortname` for your game.  The `shortname` should start with a\nletter and contain only letters and numbers.  For this example, we'll use the\n`shortname` of `mygame`.\n\n1. Run `devkit init mygame` to create the mygame folder and install the\n   dependencies.\n2. Run `devkit serve` to start the simulator\n3. Navigate to `http://localhost:9200` and select your game. Press the\n   **simulate** button on the top right. You should now see your game running in\n   the web simulator!\n4. Open `mygame/src/Application.js` and start coding!\n\n## Building on Device\nFirst, ensure you have the proper pre-requisites installed and on your path for\nthe target device. See above for more details.\n\nDevKit can create builds by specifying a build type (debug or release) and a\nbuild target (default options:\nnative-android, native-ios, browser-desktop, browser-mobile). Debug builds\ninclude all the logs, do not strictly verify everything, and allow debugging on\ndevice via the native inspector. Release builds strip logs and try to verify as\nmuch as possible.\n\nAll your builds will be available in your \u003cgame-folder\u003e/build/\u003cbuild-type\u003e\nfolder.\n\n### Android\nBuilding for native-android will create an apk directly.\n```\ndevkit debug native-android\ndevkit release native-android\n```\n\nPro-Tip: You can add the --install flag to automatically install the apk on the\nconnected device, or the --open flag to install and open it.\n\n### iOS\nBuilding for native-ios will create an xcode project and open it with xcode.\nAttach your device and click build.\n```\ndevkit debug native-ios\ndevkit release native-ios\n```\n\n\n## Debugging on Device\nAs of DevKit2, the Native Inspector is no longer packaged with DevKit itself. To\ndebug on device, you need to clone and run the\nNativeInspector(https://github.com/gameclosure/nativeinspector).\n\n```\ngit clone git@github.com:gameclosure/nativeinspector\ncd nativeinspector\nnode NativeInspector.js\n```\n\nEnsure your device is plugged in, then point your browser to localhost:9220 (or\nwhatever the NativeInspector console suggests). Now, when you run a debug build\non a connected device you will be able to use the in browser debugger just like\nwhen running the simulator.\n\n\n## Migrating a DevKit1 Game to DevKit2\n\nPlease check docs.gameclosure.com for the latest migration instructions from\nDevKit1 to DevKit2. If your existing DevKit1 game has no additional\ndependencies, you can install DevKit2 by navigating to the top of the game\ndirectory and running the following command:\n\n```\ndevkit install\n```\n\nThis will install the default dependencies and add your game to the DevKit2\nsimulator. If your app requires additional modules, please see the section about\nmigrating addons and follow the online app migration instructions.\n\n\n### Updating the DevKit\n\nDevKit consists of two parts: the command-line interface (the CLI, `devkit`) and\nthe API running in your game.\n\nTo update the API in your game, run `devkit upgrade` from inside your game's\ndirectory.\n\n### Game Modules\n\nAll dependencies (modules) for your game live in the `modules/` folder of your\ngame.  Initially, DevKit games have only one dependency, `devkit-core`.  You can\ninstall additional modules to enable functionality in your game such as\nanalytics or accelerator support.\n\nTo install a module:\n * Open a terminal and navigate to your game's directory\n * devkit install _devkit module's git repository URL_\n\nNOTE: be sure you have an updated version of your module that supports DevKit2\n(an easy check is that DevKit2 modules require a package.json file). Migrating\nDevKit1 modules to support DevKit2 is fairly simple - get the instructions\nat docs.gameclosure.com to contribute.\n\n### Inspecting your apps from the command line\n\nThe devkit command can be used to query information about your apps.  The\ncommands `apps` and `modules` describe the apps and their modules, respectively,\nthat devkit knows about on your system.  Both commands take an optional\nflag `--json` (or `-j`) for logging the result to stdout in JSON\nformat.\n\nExample commands:\n * `devkit apps`: logs a list of all registered apps and basic information about\n   each one\n * `devkit apps -s`: logs a short list of all registered apps with just their\n   titles, paths, and ids\n * `devkit apps --json`: logs a long list of apps and all details about them in\n   JSON format\n * `devkit modules`: shows the version of each module in the current app from\n   the manifest as well as the current version of the module (if it differs)\n * `devkit modules --save-current`: updates an app's dependencies in the app\n   manifest to reflect the current git version for each module on the file\n   system\n * `devkit modules devkit-core --save-current`: same as above, but only for the\n   devkit-core module\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplay-co%2Fdevkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplay-co%2Fdevkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplay-co%2Fdevkit/lists"}