{"id":16253668,"url":"https://github.com/develephant/corona-html5-builder","last_synced_at":"2025-03-19T20:32:03.218Z","repository":{"id":57107851,"uuid":"127596224","full_name":"develephant/corona-html5-builder","owner":"develephant","description":"A CLI tool to easily build, watch, and debug your Corona HTML5 projects.","archived":false,"fork":false,"pushed_at":"2018-04-04T20:55:10.000Z","size":205,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-11T00:33:54.939Z","etag":null,"topics":["applications","build","cli","corona","corona-sdk","coronasdk","games","html5","nodejs","watcher"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/develephant.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-04-01T04:16:01.000Z","updated_at":"2020-04-27T21:59:37.000Z","dependencies_parsed_at":"2022-08-20T17:11:10.586Z","dependency_job_id":null,"html_url":"https://github.com/develephant/corona-html5-builder","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/develephant%2Fcorona-html5-builder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/develephant%2Fcorona-html5-builder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/develephant%2Fcorona-html5-builder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/develephant%2Fcorona-html5-builder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/develephant","download_url":"https://codeload.github.com/develephant/corona-html5-builder/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244501581,"owners_count":20462877,"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":["applications","build","cli","corona","corona-sdk","coronasdk","games","html5","nodejs","watcher"],"created_at":"2024-10-10T15:18:10.184Z","updated_at":"2025-03-19T20:32:02.232Z","avatar_url":"https://github.com/develephant.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Corona HTML5 Builder\n\n___A CLI tool to easily build, watch, and debug your Corona HTML5 projects.___\n\n## Requirements\n\nYou will need __[NodeJS](https://nodejs.org/en/download/)__ installed for _macOS_ or _Windows_.\n\n## Installation\n\n```\nnpm install -g @develephant/corona-html5-builder\n```\n\nThe CLI will available globally via command line as `coronahtml5`.\n\n### Screencast\n\n[Click here to watch a screencast overview.](https://www.youtube.com/watch?v=pcc0OQC2FG0)\n\n## Usage\n\n### Setup\n\n - Create a new base directory for your Corona project and HTML5 output.\n - Using Corona, create a new project and select the base directory as the destination.\n - Create a directory called __html5_output__ (or whatever) in the base directory as well.\n\nThe directory tree should end up looking something like:\n\n```\n\u003cbase_directory\u003e/\n  \u003ccorona_project\u003e/\n    main.lua\n    ...\n  html5_output/\n```\n\n_Do not create the __html5_output__ directory in the \u003ccorona_project\u003e directory._\n\n### Initialize\n\nUsing a command line tool, navigate to the __\u003cbase_directory\u003e/\u003ccorona_project\u003e__ directory and run:\n\n```\ncoronahtml5 init --app \u003ccorona_app_name\u003e --html full/path/to/\u003cbase_directory\u003e/html5_output\n```\n\nThis will create a _package.lua_ file in your __\u003ccorona_project\u003e__ directory. ___Do not edit this file.___\n\nIt's a good idea to add this file to the __excludeFiles__ section, under the `all` key in your _build.settings_ file:\n\n```\n...\nexcludeFiles =\n{\n  -- Exclude unnecessary files for each platform\n  all = { \"Icon.png\", \"Icon-*dpi.png\", \"Images.xcassets\", \"package.lua\" },\n  ...\n},\n```\n\n### Development\n\nSee the command line options below to start working with your project.\n\n## CLI\n\nAll commands need to be run using a command line tool pointed at the __\u003cbase_directory\u003e/\u003ccorona_project\u003e__ directory.\n\n## Commands\n\nTo get more details on each commands arguments, run `coronahtml5 \u003ccommand\u003e -h`.\n\n### init\n\nInitialize the `package.lua` configuration file. See __[Initialize](#initialize)__ above.\n\n```\ncoronahtml5 init --app \u003ccorona_app_name\u003e --html \u003c/dest/to/html5/output_dir\u003e\n```\n\nNote: _All arguments are required._\n\n### build\n\nGenerate an HTML5 build of your project. The HTML5 files will be output to the __html5_output__ directory. See __[Setup](#setup)__ above.\n\n```\ncoronahtml5 build [--clean]\n```\n\n__Note for macOS users__: To use the `build` command you must run the \"Setup Corona Native.app\" found in the `/Applications/Corona-\u003cbuild\u003e/Native/` directory. You will need to do this for each new Corona build you install (if using dailies).\n\n### watch\n\nStart a live browser session of your HTML5 build. Add the `-d` flag to open a debug session.\n\n```\ncoronahtml5 watch [-d] [--proxy \u003cproxy-address\u003e]\n```\n\nNote: _The watch process runs in its own shell session._\n\n___\n\n\u0026copy;2018 C. Byerley ([develephant](https://develephant.com))","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevelephant%2Fcorona-html5-builder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevelephant%2Fcorona-html5-builder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevelephant%2Fcorona-html5-builder/lists"}