Skip to content

Latest commit

 

History

History
117 lines (67 loc) · 4.3 KB

README.md

File metadata and controls

117 lines (67 loc) · 4.3 KB
Raw

Unity Web Browser

License Build Status Docs Status

Unity Web Browser (UWB) is a Unity package that allows displaying and interacting with the web from within Unity.

This project is capable of using any desired web engine you want, however for now we only have an engine using CEF.

Features

  • Easy Installation with UPM
  • Multi-Platform Desktop Support (Windows, Linux & MacOS)
  • API to interact with the web engine
  • JS Interop
  • Extendable
  • 100% Open-Source

Getting Started

Prerequisites

Unity 2021.3.x

Install

  1. Setup VoltUPM
  2. Define the additional scopes org.nuget and com.cysharp.unitask with VoltUPM
  3. Install UnityWebBrowser packages

For a more in-depth installation guide, check out the setup article.

Documentation

For further documentation, see UWB's project site.

The project site covers information such as Engines, Platform support, advance setup, plus more.

Issues/Features Requests/Questions (Support)

With issues, please use the GitHub issue tracker.

With feature requests and questions, please use GitHub Discussions.

Before opening a new issue/discussion, make sure someone else hasn't already asked.

PLEASE DO NOT USE DISCORD FOR SUPPORT!

Contributing

We will gladly accept contributions from anyone!

Contributions don't just have to be code, contributions can be good bug reports, good questions/feature requests, or even simple updates to our docs.

But, if you do wish to contribute code wise to project, please see the dev docs for setting up the project. Pickup a feature request or bug report, do the required changes then submit a PR to the master branch for review.

Screenshots

Click to expand!

[Editor] Google

Google Screenshot

[Editor] YouTube

YouTube Screenshot

[Editor] Reddit Old

(Note: New Reddit works fine as well!)

Old Reddit Screenshot

[Player] Voltstro's Website

Voltstro

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Socials

Here are our socials, please don't use these for support!

Discord

Twitter Follow

Twitter Follow

Thanks

Thank you to many different projects and people that have made this project possible.

CEF Engine

This projects were used as inspiration/how-to for the CEF Engine.

  • CEF - Underlying web engine.
  • CefGlue - C# wrapper.
  • CefUnitySample - CEF directly in Unity. Has crashing problems tho.
  • unity_browser - (Orginally by Vitaly Chashin) CEF working in Unity using IPC, but the project is in a messy state.
  • ChromiumGtk - Linux stuff with CEF