Game Frame X Web View

All-in-One Solution for Indie Game Development · Empowering Indie Developers' Dreams

Documentation · Quick Start · QQ Group: 467608841 / 233840761

English | 简体中文 | 繁體中文 | 日本語 | 한국어

Project Overview

Game Frame X Web View is a Web View component for the Game Frame X game framework. It allows you to embed and display web content within Unity games.

This component wraps gree/unity-webview, providing a simpler API and easier integration.

Features

• Display web pages within Unity games
• Interact between C# and JavaScript
• Fullscreen support
• Android and iOS platform support

Quick Start

Installation

Choose one of the following methods:

1. Edit your Unity project's Packages/manifest.json and add the scopedRegistries section:

   {
     "scopedRegistries": [
       {
         "name": "GameFrameX",
         "url": "https://gameframex.upm.alianblank.uk",
         "scopes": [
           "com.gameframex"
         ]
       }
     ],
     "dependencies": {
       "com.gameframex.unity.webview": "1.0.0"
     }
   }

   scopes controls which packages are resolved through this registry. Only packages whose names start with com.gameframex will be fetched from it.

2. Add to manifest.json dependencies:

   {
      "com.gameframex.unity.webview": "https://github.com/gameframex/com.gameframex.unity.webview.git"
   }

3. Use Package Manager in Unity with Git URL: https://github.com/gameframex/com.gameframex.unity.webview.git

4. Clone the repository into your Unity project's Packages directory. It will be loaded automatically.

Installation

Edit your Unity project's Packages/manifest.json and add the scopedRegistries section:

{
  "scopedRegistries": [
    {
      "name": "GameFrameX",
      "url": "https://gameframex.upm.alianblank.uk",
      "scopes": [
        "com.gameframex"
      ]
    }
  ]
}

scopes controls which packages are resolved through this registry. Only packages whose names start with com.gameframex will be fetched from it.

Then add the package to dependencies:

{
  "dependencies": {
    "com.gameframex.unity.webview": "1.0.0"
  }
}

Usage Examples

using GameFrameX.WebView.Runtime;
using UnityEngine;

public class Example : MonoBehaviour
{
    void Start()
    {
        var webView = FindObjectOfType<WebViewComponent>();
        webView.Show("https://gameframex.doc.alianblank.com");
    }
}

API

• Show(string url) - Display a web view and load the specified URL
• Hide() - Hide the web view
• MakeFullScreen() - Set the web view to fullscreen
• ExecuteJavaScript(string javaScript) - Execute JavaScript code

Dependencies

Package	Description
com.gameframex.unity	1.0.0

Documentation & Resources

• Documentation

Community & Support

• QQ Group: 467608841 / 233840761

Changelog

See Releases for changelog.

License

This repository is licensed under the MIT License.