{"id":26006892,"url":"https://github.com/instructa/viber3d","last_synced_at":"2025-07-11T19:37:32.638Z","repository":{"id":280147013,"uuid":"940548719","full_name":"instructa/viber3d","owner":"instructa","description":"A modern starter kit for 3D browser games powered by r3f and threejs - ","archived":false,"fork":false,"pushed_at":"2025-03-16T14:03:48.000Z","size":3001,"stargazers_count":471,"open_issues_count":1,"forks_count":45,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-23T18:53:54.225Z","etag":null,"topics":["3d-browser","3d-games","ai-builder","r3f","react-three-fiber","three","threejs","viber3d"],"latest_commit_sha":null,"homepage":"https://viber3d.instructa.ai","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/instructa.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2025-02-28T11:21:28.000Z","updated_at":"2025-06-19T05:05:12.000Z","dependencies_parsed_at":"2025-03-01T15:32:44.234Z","dependency_job_id":"59cc133e-6f2b-4e03-811a-c683f48ee8ab","html_url":"https://github.com/instructa/viber3d","commit_stats":null,"previous_names":["instructa/viber3d"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/instructa/viber3d","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instructa%2Fviber3d","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instructa%2Fviber3d/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instructa%2Fviber3d/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instructa%2Fviber3d/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/instructa","download_url":"https://codeload.github.com/instructa/viber3d/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instructa%2Fviber3d/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264888040,"owners_count":23678790,"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-browser","3d-games","ai-builder","r3f","react-three-fiber","three","threejs","viber3d"],"created_at":"2025-03-05T21:01:47.077Z","updated_at":"2025-07-11T19:37:32.626Z","avatar_url":"https://github.com/instructa.png","language":"TypeScript","readme":"# viber3d\n\n![viber3d banner](/public/images/banner.png)\n\u003cp\u003e\n  \u003cimg src=\"https://img.shields.io/badge/License-MIT-yellow?style=flat\u0026colorA=18181B\u0026colorB=28CF8D\" alt=\"License\"\u003e\n  \u003ca href=\"https://github.com/instructa/viber3d/stargazers\"\u003e\u003cimg src=\"https://img.shields.io/github/stars/instructa/viber3d.svg?style=flat\u0026colorA=18181B\u0026colorB=28CF8D\" alt=\"Stars\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n**viber3D** - a modern starter kit for 3D browser games.\n\n---\n\n## Features\n\n- 🔥 **React 19** - Latest React features including concurrent rendering\n- 🎮 **React Three Fiber** - Declarative Three.js in React\n- 🧰 **Drei** - Useful helpers for React Three Fiber\n- 🏎️ **Vite** - Lightning-fast development server and build tool\n- 🎨 **TailwindCSS** - Utility-first CSS framework\n- 📱 **Responsive Design** - Works on all devices\n- 🧠 **State Management** - Zustand for simple state management\n- 🔋 **Physics** - React Three Rapier for physics simulations\n- 📏 **TypeScript** - Type safety for your project\n- 🤖 **Cursor AI Integration** - Predefined `.cursor/rules` for enhanced AI assistance\n- 🧩 **Entity Component System** - Flexible and performant game architecture via koota library\n\n## Demo\n\nTry out Viber3D with our live demo: [viber3d-spacewars.kevinkern.dev](https://viber3d-spacewars.kevinkern.dev/)\n\n\n## Getting Started\n\n### Prerequisites\n\n- Install [Node.js](https://nodejs.org/en/download)\n- A package manager (pnpm, npm, yarn, bun)\n\n## Quick Install\n\n1. Create a new **viber3d** project:\n```bash\nnpx viber3d@latest init\n```\n\n2. Open in Cursor\n\n3. Run your project\n```bash\nnpm run dev\n# or\npnpm run dev\n```\n\n4. Open your browser and visit `http://localhost:5173` to see your app in action 🥳\n\n## Publish\n\n5. Build your project\n```\nnpm run build\n```\n\n6. Deploy on a live server! 🌎\n\n## Documentation\n\nviber3D comes with comprehensive documentation to help you get started:\n\n- **Core Concepts** - Learn about the fundamental architecture and patterns\n- **ECS Overview** - Detailed guide to the Entity Component System architecture\n- **Tutorials** - Step-by-step guides for common game development tasks\n\nVisit the [documentation site](/docs/viber3d-docs) to learn more.\n\n## AI Code Editor Integration\n\n### Cursor AI\n\nviber3d comes with predefined `.cursor/rules` to enhance your development experience when using Cursor AI:\n\n- **Code Style Rules** - Ensures AI-generated code follows project conventions\n- **Component Structure** - Guides AI to create components that match the project architecture\n- **Three.js Best Practices** - Helps AI generate optimized 3D code\n- **Documentation Standards** - Ensures consistent documentation in AI-generated code\n\nThese rules help maintain code quality and consistency when using AI assistance, making it easier to integrate AI-generated code into your project.\n\n#### Other\n\n| AI Tool           | How to Include Prompts                                                                                                                                                                                                                 |\n|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **GitHub Copilot**| Create a `.github/copilot-instructions.md` file in your repository's root directory and add natural language instructions in Markdown format. These instructions will guide Copilot's behavior across your project. More information is available in the [GitHub Copilot documentation](https://docs.github.com/copilot/customizing-copilot/adding-custom-instructions-for-github-copilot). |\n| **Windsurf**      | Add a .windsurfrules file into the project root. [Windsurf Getting Started Guide](https://docs.codeium.com/windsurf/getting-started). |\n| **Cline**         | 1. Click Cline extension settings 2. Find \"Custom Instructions\" field 3. Add your instructions  [Cline GitHub repository](https://cline.bot/faq). |\n\n## CLI Options\n\n```bash\nnpx viber3d@latest [project-name] [options]\n\nOptions:\n  --cwd, -c             The working directory. Defaults to the current directory\n  --name                Project name\n  --force, -f           Override existing directory\n  --install             Skip installing dependencies (default: true)\n  --gitInit             Initialize git repository\n  --packageManager      Package manager choice (npm, pnpm, yarn)\n  --yes, -y             Skip confirmation prompt (default: false)\n  --defaults, -d        Use default configuration (default: false)\n  --silent, -s          Mute output (default: false)\n  --help, -h            Display help for command\n```\n\n## Resources\n\n- [React Three Fiber Documentation](https://docs.pmnd.rs/react-three-fiber)\n- [Drei Documentation](https://github.com/pmndrs/drei)\n- [Three.js Documentation](https://threejs.org/docs/)\n- [React Documentation](https://react.dev/)\n- [Vite Documentation](https://vitejs.dev/guide/)\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\nFor detailed contribution guidelines, development workflow, and coding standards, please see our [CONTRIBUTE.md](CONTRIBUTE.md) document.\n\n\n#### Recommended VS Code Extensions\n\nWe recommend installing the following VS Code extensions for the best development experience:\n\n- **Activitus Bar**: Provides a convenient way to start/stop the development server directly from the VS Code activity bar\n- **ESLint**: For code linting\n- **Prettier**: For code formatting\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n---\n\n## Links\n\n- X/Twitter: [@kregenrek](https://x.com/kregenrek)\n- Bluesky: [@kevinkern.dev](https://bsky.app/profile/kevinkern.dev)\n\n## Courses\n- Learn Cursor AI: [Ultimate Cursor Course](https://www.instructa.ai/en/cursor-ai)\n- Learn to build software with AI: [instructa.ai](https://www.instructa.ai)\n\n## See my other projects:\n\n* [AI Prompts](https://github.com/instructa/ai-prompts/blob/main/README.md) - Curated AI Prompts for Cursor AI, Cline, Windsurf and Github Copilot\n* [codefetch](https://github.com/regenrek/codefetch) - Turn code into Markdown for LLMs with one simple terminal command\n* [aidex](https://github.com/regenrek/aidex) A CLI tool that provides detailed information about AI language models, helping developers choose the right model for their needs.\n* [codetie](https://github.com/codetie-ai/codetie) - XCode CLI\n\n## Credits\n\nViber3D stands on the shoulders of giants:\n\n- **[Koota](https://github.com/krispya/koota)** - The ECS library that powers our game architecture\n- **[React Three Fiber](https://github.com/pmndrs/react-three-fiber)** - React renderer for Three.js\n- **[Three.js](https://threejs.org/)** - The core 3D library\n- **[Nuxt](https://nuxt.com/)** \u0026 **[UnJS](https://unjs.io/)** - Powering our docs + build system\n\nSee our [full credits page](/docs/viber3d-docs/content/7.credits) for more details.\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finstructa%2Fviber3d","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finstructa%2Fviber3d","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finstructa%2Fviber3d/lists"}