{"id":15722573,"url":"https://github.com/thinknathan/tsd-template-boom","last_synced_at":"2025-05-13T10:40:36.816Z","repository":{"id":177454199,"uuid":"658100194","full_name":"thinknathan/tsd-template-boom","owner":"thinknathan","description":"Boilerplate TypeScript template with @ts-defold and @britzl's boom for the game engine Defold.","archived":false,"fork":false,"pushed_at":"2025-04-01T22:26:34.000Z","size":504,"stargazers_count":2,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-20T23:32:34.762Z","etag":null,"topics":["boom","defold","defold-engine","defold-game-engine","gamedev","lua","template","ts-defold","ts-defold-template","tstl","typescript"],"latest_commit_sha":null,"homepage":"https://ts-defold.dev","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/thinknathan.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-06-24T19:08:26.000Z","updated_at":"2025-03-09T20:12:39.000Z","dependencies_parsed_at":"2024-03-17T18:28:04.583Z","dependency_job_id":"9157354e-87a9-4cd2-84b1-8850097a165a","html_url":"https://github.com/thinknathan/tsd-template-boom","commit_stats":{"total_commits":133,"total_committers":3,"mean_commits":"44.333333333333336","dds":0.368421052631579,"last_synced_commit":"5b3a4d010f059ddcd1f842e4644df991fd984fc5"},"previous_names":["thinknathan/tsd-template-boom"],"tags_count":7,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thinknathan%2Ftsd-template-boom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thinknathan%2Ftsd-template-boom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thinknathan%2Ftsd-template-boom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thinknathan%2Ftsd-template-boom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thinknathan","download_url":"https://codeload.github.com/thinknathan/tsd-template-boom/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253924703,"owners_count":21985160,"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":["boom","defold","defold-engine","defold-game-engine","gamedev","lua","template","ts-defold","ts-defold-template","tstl","typescript"],"created_at":"2024-10-03T22:08:27.098Z","updated_at":"2025-05-13T10:40:36.794Z","avatar_url":"https://github.com/thinknathan.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"_docs/template-boom.png\" alt=\"Template Boom\"\u003e\n\n# Defold TypeScript Boom Template\n\n[![CI](https://github.com/thinknathan/tsd-template-boom/actions/workflows/ci.yml/badge.svg)](https://github.com/thinknathan/tsd-template-boom/actions/workflows/ci.yml)\n![GitHub License](https://img.shields.io/github/license/thinknathan/tsd-template-boom) \u003ca href=\"https://discord.gg/eukcq5m\"\u003e\u003cimg alt=\"Chat with us!\" src=\"https://img.shields.io/discord/766898804896038942.svg?colorB=7581dc\u0026logo=discord\u0026logoColor=white\"\u003e\u003c/a\u003e\n\nA dev environment for [Defold](https://defold.com/) that transpiles TypeScript into lua using [TypeScriptToLua](https://github.com/TypeScriptToLua/TypeScriptToLua).\n\nIncludes britzl's [boom](https://github.com/britzl/boom/), a game framework built on top of [Defold](https://defold.com/).\n\nThis template extends [tsd-template](https://github.com/ts-defold/tsd-template). Use that one if you prefer a minimal setup.\n\n## Features\n\n- Full Lua and Defold API type definitions for TypeScript auto-complete and type checking\n- Built-in types for boom\n- Eslint config for handling the caveats of TypeScriptToLua and keeping your code correct\n  - `yarn lint` or `npm run lint` to run the linter\n  - `yarn lintfix` or `npm run lintfix` to allow the linter to auto-fix issues\n- Handles script, gui_script, and module exports using familiar ES6 export syntax\n- Full boilerplate game project ready to transpile and go\n- File watcher via `yarn dev` or `npm run dev` to transpile on save\n- Optionally run `yarn buildO1` or `npm run buildO1` to strip source maps, [unfold and propagate constants](https://github.com/thinknathan/tstl-const-propagation)\n- Access a library of types for Defold extensions by running `yarn resolve` or `npm run resolve`\n\n_You will need to have [Node.js](https://nodejs.org) installed._\n\n## Quick Start\n\n- Use `yarn dev` or `npm run dev` to start a watcher that compiles and emits lua and script when you save\n- Use `yarn build` or `npm run build` to just compile your ts, sans watcher\n\n## Installation\n\n1. Fork this template or use [degit](https://www.npmjs.com/package/degit) to download the template locally\n\n```bash\nnpx degit thinknathan/tsd-template-boom my-game\n# or\ngit clone https://github.com/thinknathan/tsd-template-boom.git my-game\n```\n\n2. Initialize\n\n```bash\ncd my-game\nnpm install\n# or yarn\n```\n\n3. Generate\n\n```bash\nnpm run build # Transpile the TypeScript files to lua\n# or yarn build\n# or\nnpm run dev # Watch for changes and regenerate files on save\n# or yarn dev\n```\n\n4. Open `app/game.project` in Defold\n\n- Start making games with TypesScript!\n\n\u003cp align=\"center\" class=\"h4\"\u003e\n  TypeScript :heart: Defold\n\u003c/p\u003e\n\n## License\n\nMIT\n\nBased on [tsd-template](https://github.com/ts-defold/tsd-template) (Copyright (c) Justin Walsh (@thejustinwalsh)).\n\nGraphics in the `assets` folder are [CC0](https://creativecommons.org/share-your-work/public-domain/cc0/) licensed, from [Kenney](https://kenney.nl/assets).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthinknathan%2Ftsd-template-boom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthinknathan%2Ftsd-template-boom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthinknathan%2Ftsd-template-boom/lists"}