{"id":13599489,"url":"https://github.com/gopro/forgejs","last_synced_at":"2026-01-16T19:56:58.778Z","repository":{"id":143391652,"uuid":"71270620","full_name":"gopro/forgejs","owner":"gopro","description":"ForgeJS is a javascript framework that unleashes immersive WebVR experiences.","archived":false,"fork":false,"pushed_at":"2020-04-18T01:07:50.000Z","size":8619,"stargazers_count":239,"open_issues_count":15,"forks_count":61,"subscribers_count":117,"default_branch":"master","last_synced_at":"2024-11-07T00:43:11.947Z","etag":null,"topics":["ambisonics","forgejs","gopro","hmd","immersive","javascript","storytelling","threejs","webgl","webvr"],"latest_commit_sha":null,"homepage":"https://forgejs.org/","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/gopro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md"}},"created_at":"2016-10-18T16:53:36.000Z","updated_at":"2024-10-25T20:37:12.000Z","dependencies_parsed_at":"2023-07-11T04:32:42.430Z","dependency_job_id":null,"html_url":"https://github.com/gopro/forgejs","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gopro%2Fforgejs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gopro%2Fforgejs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gopro%2Fforgejs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gopro%2Fforgejs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gopro","download_url":"https://codeload.github.com/gopro/forgejs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248217145,"owners_count":21066633,"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":["ambisonics","forgejs","gopro","hmd","immersive","javascript","storytelling","threejs","webgl","webvr"],"created_at":"2024-08-01T17:01:05.099Z","updated_at":"2026-01-16T19:56:58.773Z","avatar_url":"https://github.com/gopro.png","language":"JavaScript","readme":"\n![](https://cdn.forgejs.org/grav/images/ForgeJS-logo-650x200.png)\n\n## Overview\n\nForgeJS is a modern web-based engine built on standard technologies (HTML5, Javascript and WebGL) that runs on every modern browser to unleash immersive VR content experiences.\nIt's not only a VR engine, it's a framework for authoring VR content. You can use ForgeJS even if you do not have advanced programming skills: ForgeJS is able to read a configuration file and create the experience from it.\n\n## Resources\n\nMany documentation resources are available online:\n- [API Documentation ](https://releases.forgejs.org/latest/doc/jsdoc) describes all public methods, interfaces, properties and events.\n- [JSON reference](https://releases.forgejs.org/latest/doc/json) explains how to describe your project in the json configuration file.\n- [Samples](https://forgejs.org/samples) demonstrates how to build your experience in the config.json file.\n- [Tutorials series](https://forgejs.org/tutorials) explains how to use some of the ForgeJS features in your project.\n- [Known issues and limitations](https://forgejs.org/known-issues-and-limitations).\n- [Frequently asked questions](https://forgejs.org/faq).\n\n## Repositories\n\nLinked project repositories for the ForgeJS javascript framework.\n- [Plugins](https://github.com/gopro/forgejs-plugins)\n- [Samples](https://github.com/gopro/forgejs-samples)\n\n## Get the build\n\nThe latest build is available online on our [ForgeJS download page](https://forgejs.org/download).\n\n## Licenses\n\nForgeJS is licensed under [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0) license.\n\nForgeJS has the following dependencies:\n\n- [three.js](https://threejs.org/) r86 ([MIT license](https://github.com/mrdoob/three.js/blob/dev/LICENSE))\n- [hammer.js](http://hammerjs.github.io/) 2.0.8 ([MIT license](https://github.com/hammerjs/hammer.js/blob/master/LICENSE.md))\n- [omnitone](http://googlechrome.github.io/omnitone/#home) 1.0.1 ([Apache 2.0 license](https://github.com/GoogleChrome/omnitone/blob/master/LICENSE))\n- [dash.js](https://github.com/Dash-Industry-Forum/dash.js) 2.6.0 ([BSD license](https://github.com/Dash-Industry-Forum/dash.js/blob/development/LICENSE.md))\n\n\u003e NOTE: We made a custom build of three.js with some classes concatenated to it. These classes are included in the original three.js repository but not concatenated in the main build. We added EffectComposer, RenderPass, ClearPass, MaskPass, ShaderPass, TexturePass and CopyShader in our three.custom.min.js.\n\n## Quick Start for users\n\nThe easiest way to learn how to build a project with ForgeJS is to practice with our [tutorials](https://forgejs.org/tutorials) and get inspiration from our [samples](https://forgejs.org/samples) that are available online.\n\n## Quick Start for Developers\n\n### Setup\n\n1. Clone the project from [GitHub](https://github.com/gopro/forgejs) (`git clone https://github.com/gopro/forgejs`).\n2. Install nodejs and npm on your machine (download [here](http://nodejs.org)).\n3. Install the grunt-cli npm package (`npm install -g grunt grunt-cli` will install grunt globally on your machine).\n4. Install the node dev dependencies of the project (`cd forgejs \u0026\u0026 npm install`).\n\n### Build ForgeJS\n\nYou can now run grunt tasks from the project repo folder. Here is a short list of useful grunt tasks:\n\nBuild a non minified build of ForgeJS:\n```\ngrunt build\n```\n\nBuild a minified build of ForgeJS:\n```\ngrunt min // without logs on FORGE.DEBUG = true\ngrunt min --keep-log // with logs\ngrunt min --no-test // without tests\n```\n\nGenerate the documentation and the json reference:\n```\ngrunt doc\n```\n\nAuto watch any changes you made in sources to auto build a non minified build of ForgeJS:\n```\ngrunt watch:build\n```\n","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgopro%2Fforgejs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgopro%2Fforgejs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgopro%2Fforgejs/lists"}