{"id":13664724,"url":"https://github.com/OmiyaGames/omiya-games-embed-webgl-template","last_synced_at":"2025-04-26T01:33:30.002Z","repository":{"id":92285947,"uuid":"258693063","full_name":"OmiyaGames/omiya-games-embed-webgl-template","owner":"OmiyaGames","description":"A Unity WebGL template that can be imported to your own project and be used to create WebGL games that automatically resizes itself to fit within the bounds of the web portal embedding, including fullscreen resize support.","archived":false,"fork":false,"pushed_at":"2024-09-03T21:00:48.000Z","size":1185,"stargazers_count":33,"open_issues_count":3,"forks_count":5,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-25T16:46:38.159Z","etag":null,"topics":["iframe-embeds","omiya-games","openupm","templates","unity","unity2d","unity3d","webgl"],"latest_commit_sha":null,"homepage":"https://openupm.com/packages/com.omiyagames.embedwebgltemplate/","language":"HTML","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/OmiyaGames.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","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":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":"omiyagames","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-04-25T05:14:17.000Z","updated_at":"2024-12-08T13:24:52.000Z","dependencies_parsed_at":"2023-06-08T06:45:36.125Z","dependency_job_id":null,"html_url":"https://github.com/OmiyaGames/omiya-games-embed-webgl-template","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":"OmiyaGames/template-unity-package","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OmiyaGames%2Fomiya-games-embed-webgl-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OmiyaGames%2Fomiya-games-embed-webgl-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OmiyaGames%2Fomiya-games-embed-webgl-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OmiyaGames%2Fomiya-games-embed-webgl-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OmiyaGames","download_url":"https://codeload.github.com/OmiyaGames/omiya-games-embed-webgl-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250919721,"owners_count":21508000,"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":["iframe-embeds","omiya-games","openupm","templates","unity","unity2d","unity3d","webgl"],"created_at":"2024-08-02T05:03:05.724Z","updated_at":"2025-04-26T01:33:29.996Z","avatar_url":"https://github.com/OmiyaGames.png","language":"HTML","funding_links":["https://ko-fi.com/omiyagames","https://ko-fi.com/I3I51KS8F"],"categories":["HTML"],"sub_categories":[],"readme":"# [Omiya Games](https://www.omiyagames.com/) - Embed WebGL Template\n\n[![openupm](https://img.shields.io/npm/v/com.omiyagames.embedwebgltemplate?label=openupm\u0026registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.omiyagames.embedwebgltemplate/) [![Documentation](https://github.com/OmiyaGames/omiya-games-embed-webgl-template/workflows/Host%20DocFX%20Documentation/badge.svg)](https://omiyagames.github.io/omiya-games-embed-webgl-template/) [![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/I3I51KS8F)\n\n![Animated Example](https://omiyagames.github.io/omiya-games-embed-webgl-template/resources/example.gif)\n\n**Embed WebGL Template** is a WebGL template for Unity.  The purpose is to allow Unity to create WebGL builds that embeds well in popular web portals such as Itch.io, GameJolt, Newgrounds, etc.  Features this template provides include:\n\n- A loading bar with percentage point indicating a numerical value on progress being made.\n- Automatically resizes the game to the size of the frame the game is embedded in, including full-screen mode.\n    - It even resizes from embed size to full-screen for web portals like Itch.io that supports full-screen buttons.\n- A light and dark mode.\n\n#### Note:\n\n* Version 2.0.0 and above supports Unity 2020.1 and up.\n* Version 1.1.0 supports Unity 2019.4.\n\n## Installing Package\n\nThere are at least 3 ways to install this Unity package:\n\n#### Easy Method: Package Manager\n\nThe easiest way to install the package is through Unity's own Package Manager:\n\n![Add Git URL](https://omiyagames.github.io/omiya-games-embed-webgl-template/resources/packageManager1.png)\n\nSimply enter the following Github URL:\n```\nhttps://github.com/OmiyaGames/omiya-games-embed-webgl-template.git\n```\n\n![Enter Git URL](https://omiyagames.github.io/omiya-games-embed-webgl-template/resources/packageManager2.png)\n\nOnly the latest source code will be installed via this method, and will not be monitored for any upgrades.  To enable such features, consider the other options listed below:\n\n#### Best Method: OpenUPM\n\n[OpenUPM](https://openupm.com/) is a command line tool that provides package version support and dependency resolution.  If not installed already, install OpenUPM with Node.js' `npm`:\n```\nnpm install -g openupm-cli\n```\nAfter the command line tool is installed, switch to the root directory of your Unity project, and run:\n```\nopenupm add com.omiyagames.embedwebgltemplate\n```\nThis should update the Package Manager with all the available versions of this package. Of course, there's the manual method...\n\n#### Manual Method: Edit `manifest.json`\n\nIn your Unity project, open `manifest.json` in your favorite text editor under the `Packages` folder. Content should look something similar to an excerpt below:\n```\n{\n  \"dependencies\": {\n    \"com.unity.2d.pixel-perfect\": \"2.0.4\",\n    ...\n  }\n}\n```\nAdd towards the bottom of the dependencies list the line, `\"com.omiyagames.embedwebgltemplate\": \"1.0.0\"`, as well as the OpenUPM `scopedRegistries`. Basically, the same thing OpenUPM would have done for you, if you ran the command-line tool.\n```\n{\n  \"dependencies\": {\n    \"com.unity.2d.pixel-perfect\": \"2.0.4\",\n    ...,\n    \"com.omiyagames.embedwebgltemplate\": \"1.0.0\"\n  },\n   \"scopedRegistries\": [\n    {\n      \"name\": \"package.openupm.com\",\n      \"url\": \"https://package.openupm.com\",\n      \"scopes\": [\n        \"com.omiyagames.embedwebgltemplate\",\n        \"com.openupm\"\n      ]\n    }\n  ]\n}\n```\nThis should update the Package Manager with all the available versions of this package.\n\n## Configuration\n\nUtilizing the template requires importing the files, moving them to folder `Assets/WebGLTemplates`, and finally setting up the WebGL Player settings.\n\n#### Step 1: Import the Template\n\nNavigate to this package in the Package Manager, and import \"Embed WebGL Template.\"\n\n![Import from Package Manager](https://omiyagames.github.io/omiya-games-embed-webgl-template/resources/packageManager3.png)\n\nUnity should automatically create an `Embed WebGL Template` folder with the files:\n\n![Import Results](https://omiyagames.github.io/omiya-games-embed-webgl-template/resources/project1.png)\n\n#### Step 2: Create a `WebGLTemplates` folder, if you haven't already\n\nIn the Project windor, return back to the root folder, `Assets`. Verify if the folder, `WebGLTemplates`, already exists. If not, right-click in the middle of the window, and select \"Create -\u003e Folder.\"\n\n![Create Folder context menu](https://omiyagames.github.io/omiya-games-embed-webgl-template/resources/project2.png)\n\nUpon creation of a new folder, enter `WebGLTemplates`.\n\n#### Step 3: Move the imported files into the `WebGLTemplates` folder\n\nReturn back to the imported files, and drag-and-drop the folder, `Embed WebGL Template` into `WebGLTemplates`.\n\n![Drag-and-Drop Template Files](https://omiyagames.github.io/omiya-games-embed-webgl-template/resources/project3.png)\n\n#### Step 4: Update WebGL Player Settings to Use the Template\n\nUnder Unity's menu bar, select \"Edit -\u003e Project Settings...\"\n\n![Project Settings context menu](https://omiyagames.github.io/omiya-games-embed-webgl-template/resources/settings1.png)\n\n1. In the Project Settings window, click on \"Player\" on the left sidebar.\n2. Select the WebGL tab (if it's not there, you'll need to install WebGL build files on Unity Hub).\n3. Finally, under the group, \"Resolution and Presentation\", select `Embed`:\n\n![Final Player Settings Configuration](https://omiyagames.github.io/omiya-games-embed-webgl-template/resources/settings2.png)\n\n## Customizing Template\n\nFiles to consider customizing to suit your needs include:\n\n- The [logo-light.png](https://github.com/OmiyaGames/omiya-games-embed-webgl-template/tree/main/Samples%7E/Embed/logo-light.png) and [logo-dark.png](https://github.com/OmiyaGames/omiya-games-embed-webgl-template/tree/main/Samples%7E/Embed/logo-dark.png) are logos displayed during the light and dark WebGL build theme are used respectively. Feel free to replace them.\n- While embedded builds don't show this, it might be good idea to replace the [favicon.ico](https://github.com/OmiyaGames/omiya-games-embed-webgl-template/tree/main/Samples%7E/Embed/favicon.ico) as well.\n- Consider also editing the [style.css](https://github.com/OmiyaGames/omiya-games-embed-webgl-template/tree/main/Samples%7E/Embed/TemplateData/style.css) file to your liking.\n\n## Other Info\n\n- [Documentation](https://omiyagames.github.io/omiya-games-embed-webgl-template).\n- [Change log](https://omiyagames.github.io/omiya-games-embed-webgl-template/manual/changelog.html).\n\n## LICENSE\n\nOverall package is licensed under [MIT](/LICENSE.md). By necessity, this package uses third party images, which are noted in the [3rd party licenses](/THIRD%20PARTY%20NOTICES.md) file.\n\nCopyright (c) 2019-2020 Omiya Games\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOmiyaGames%2Fomiya-games-embed-webgl-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FOmiyaGames%2Fomiya-games-embed-webgl-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOmiyaGames%2Fomiya-games-embed-webgl-template/lists"}