{"id":14981226,"url":"https://github.com/fairygui/fairygui-threejs","last_synced_at":"2025-04-05T10:07:09.990Z","repository":{"id":40604967,"uuid":"270512799","full_name":"fairygui/FairyGUI-threejs","owner":"fairygui","description":"A GUI Editor \u0026 framework for Three.js","archived":false,"fork":false,"pushed_at":"2024-03-15T06:34:16.000Z","size":9662,"stargazers_count":262,"open_issues_count":2,"forks_count":43,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-05T10:07:04.519Z","etag":null,"topics":["fairygui","gui-editor","three-js","threejs","threejs-example"],"latest_commit_sha":null,"homepage":"https://www.fairygui.com","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/fairygui.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}},"created_at":"2020-06-08T03:21:57.000Z","updated_at":"2025-03-31T09:10:19.000Z","dependencies_parsed_at":"2024-11-16T21:39:02.702Z","dependency_job_id":null,"html_url":"https://github.com/fairygui/FairyGUI-threejs","commit_stats":{"total_commits":47,"total_committers":6,"mean_commits":7.833333333333333,"dds":0.3829787234042553,"last_synced_commit":"3ea188c1a7b49557fdf413277df3702798303d10"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairygui%2FFairyGUI-threejs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairygui%2FFairyGUI-threejs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairygui%2FFairyGUI-threejs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairygui%2FFairyGUI-threejs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fairygui","download_url":"https://codeload.github.com/fairygui/FairyGUI-threejs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247318744,"owners_count":20919484,"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":["fairygui","gui-editor","three-js","threejs","threejs-example"],"created_at":"2024-09-24T14:03:10.391Z","updated_at":"2025-04-05T10:07:09.966Z","avatar_url":"https://github.com/fairygui.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FairyGUI-three\n\n#### A GUI Editor\u0026amp;framework for Three.js ####\n\nOfficial website: [www.fairygui.com](https://www.fairygui.com)\n\n### Usage ###\n\nStep 1, we use the editor to create the UI.\n\n![](images/20200610-084916.png)\n\nStep 2, we only need a little code to display it.\n\n```javascript\nimport * as fgui from \"fairygui-three\";\n\nvar renderer;\nvar scene;\nvar view;\n\ninit();\nanimate();\n\nfunction init() {\n    //THREE initialization code here\n\n    fgui.Stage.init(renderer, { screenMode:'horizontal' });  //screenMode is optional if you dont want to rotate the screen \n    fgui.Stage.scene = scene;\n\n    fgui.UIPackage.loadPackage('path/to/UI').then(()=\u003e {\n        view = fgui.UIPackage.CreateObject('Basics', 'Main');\n        view.makeFullScreen();\n        fgui.GRoot.inst.addChild(view);\n    });\n}\n\nfunction animate() {\n\n    requestAnimationFrame( animate );\n\n    fgui.Stage.update();\n    renderer.render(scene, fgui.Stage.camera);\n}\n```\n\nYou should see [this](https://fairygui.com/threejs-demo/main/)\n\nIn the example above, an UI is created and displayed by an orthographic camera (fgui.Stage.camera) . It's easy to display UI by an specific perspective camera.\n\n```javascript\nimport * as fgui from \"fairygui-three\";\n\nvar renderer;\nvar scene;\nvar camera;\nvar view;\n\ninit();\nanimate();\n\nfunction init() {\n    //THREE initialization code here\n\n    camera = new THREE.PerspectiveCamera( 70, window.innerWidth / window.innerHeight, 0.01, 10 );\n\tcamera.position.z = 1;\n\n    fgui.Stage.init(renderer);\n    fgui.Stage.scene = scene;\n\n    fgui.UIPackage.loadPackage('path/to/UI').then(()=\u003e {\n        view = fgui.UIPackage.CreateObject('3DInventory', 'Main');\n        view.displayObject.camera = camera;\n        view.displayObject.setLayer(0);\n\n        let container = new Group();\n        container.scale.set(0.5, 0.5, 0.5);\n        container.add(view.obj3D);\n        scene.add(container);\n    });\n}\n\nfunction animate() {\n\n    requestAnimationFrame( animate );\n\n    fgui.Stage.update();\n    renderer.render(scene, camera);\n}\n```\n\nYou should see [this](https://fairygui.com/threejs-demo/3d/)\n\nIf a perspective camera is using for all UI,\n\n```javascript\n    Stage.init(renderer, { defaultLayer:0 });\n    Stage.camera = yourCamera;\n```\n\n# License\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffairygui%2Ffairygui-threejs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffairygui%2Ffairygui-threejs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffairygui%2Ffairygui-threejs/lists"}