{"id":16748926,"url":"https://github.com/n1md7/three-boilerplate","last_synced_at":"2026-05-08T17:33:56.207Z","repository":{"id":165186566,"uuid":"619886352","full_name":"n1md7/three-boilerplate","owner":"n1md7","description":"ThreeJS FPS boilerplate, basic character movements, shooting animations, etc.","archived":false,"fork":false,"pushed_at":"2023-08-09T21:48:14.000Z","size":35405,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-22T16:24:23.006Z","etag":null,"topics":["3d","boilerplate","electron","first-person","first-person-shooter","fps","game","setup","template","threejs","typescript","web"],"latest_commit_sha":null,"homepage":"https://n1md7.github.io/three-boilerplate/","language":"TypeScript","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/n1md7.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-27T15:54:18.000Z","updated_at":"2024-09-15T09:31:01.000Z","dependencies_parsed_at":null,"dependency_job_id":"cf86ccdc-dfe2-4386-a421-0053ea67b40a","html_url":"https://github.com/n1md7/three-boilerplate","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/n1md7%2Fthree-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/n1md7%2Fthree-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/n1md7%2Fthree-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/n1md7%2Fthree-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/n1md7","download_url":"https://codeload.github.com/n1md7/three-boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243822304,"owners_count":20353499,"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":["3d","boilerplate","electron","first-person","first-person-shooter","fps","game","setup","template","threejs","typescript","web"],"created_at":"2024-10-13T02:23:19.615Z","updated_at":"2026-05-08T17:33:51.154Z","avatar_url":"https://github.com/n1md7.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ThreeJS FPS boilerplate\n\nTechnologies used\n\n- Vite\n- Vitest\n- Typescript\n- Electron\n\nFeatures\n\n- FPS controls (WASD)\n- Orbit controls (Mouse)\n- Object collisions\n- Shooting animations (for each weapon)\n- Player flashlight (F)\n- Multiple weapons (Pistol, Shotgun, Rifle, etc)\n- Sounds (WIP)\n- Particle effects (WIP)\n- UI (WIP)\n\n## How to run\n\n```bash\n# Browser\n$ npm run dev\n\n# Build - Transpile to JS\n$ npm run build\n\n\n# Electron\n$ npm run electron\n# or\n$ npm run start\n\n# Build binaries\n$ npm run make\n$ npm run package\n```\n\n![image](https://github.com/n1md7/three-boilerplate/assets/6734058/a37a3e73-d2be-46ea-9d7e-bf363e592b28)\n\n\n### Workflow actions\n\nOnce it is cloned make sure you enable permissions\n\n`Settings \u003e Actions \u003e General` make sure in **Workflow permissions** **Read and Write** is granted\n\n\u003cimg width=\"1312\" alt=\"image\" src=\"https://github.com/n1md7/three-boilerplate/assets/6734058/d5f4bd64-45e5-4025-a6e6-d869c801b4e4\"\u003e\n\n### Configure template source and update change\n\n```bash\n# Add remote source\ngit remote add template https://github.com/n1md7/three-boilerplate.git\n# Pull changes\ngit pull template master\n# Merge into the current branch\ngit merge template/master --allow-unrelated-histories\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fn1md7%2Fthree-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fn1md7%2Fthree-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fn1md7%2Fthree-boilerplate/lists"}