Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Voltstro-Studios/UnityWebBrowser

Unity Web Browser (UWB) is a Unity package that allows displaying and interacting with the web from within Unity.
https://github.com/Voltstro-Studios/UnityWebBrowser

browser cef cefglue chromium chromium-embedded-framework csharp unity unity-2021 unity-browser unity-package unity2d unity3d webbrowser

Last synced: about 2 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/Voltstro-Studios/UnityWebBrowser
Owner: Voltstro-Studios
License: mit
Created: 2021-02-15T11:28:01.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2024-10-16T12:15:03.000Z (3 months ago)
Last Synced: 2024-10-19T04:02:21.288Z (2 months ago)
Topics: browser, cef, cefglue, chromium, chromium-embedded-framework, csharp, unity, unity-2021, unity-browser, unity-package, unity2d, unity3d, webbrowser
Language: C#
Homepage: https://projects.voltstro.dev/UnityWebBrowser/latest/
Size: 22.7 MB
Stars: 327
Watchers: 13
Forks: 48
Open Issues: 3
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

README

        

# Unity Web Browser

[![License](https://img.shields.io/github/license/Voltstro-Studios/UnityWebBrowser.svg)](/LICENSE.md)

[![Build Status](https://github.com/Voltstro-Studios/UnityWebBrowser/actions/workflows/main.yml/badge.svg)](https://github.com/Voltstro-Studios/UnityWebBrowser/actions/workflows/main.yml)

[![Docs Status](https://img.shields.io/uptimerobot/status/m794227043-7e2bf837661fcd75d2af6804?label=Docs)](https://projects.voltstro.dev/UnityWebBrowser/latest/)

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](https://bitbucket.org/chromiumembedded/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](https://github.com/Voltstro/VoltstroUPM#setup)

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](https://projects.voltstro.dev/UnityWebBrowser/latest/articles/user/setup/).

## Documentation

For further documentation, see [UWB's project site](https://projects.voltstro.dev/UnityWebBrowser/latest/articles/).

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](https://github.com/Voltstro-Studios/UnityWebBrowser/issues).

With feature requests and questions, please use [GitHub Discussions](https://github.com/Voltstro-Studios/UnityWebBrowser/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](https://github.com/Voltstro-Studios/UnityWebBrowser/issues), good [questions/feature requests](https://github.com/Voltstro-Studios/UnityWebBrowser/discussions), or even simple updates to our docs.

But, if you do wish to contribute code wise to project, please see the [dev docs](https://projects.voltstro.dev/UnityWebBrowser/latest/articles/dev/dev-guide/) 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](media/Editor1.webp)

### [Editor] YouTube

![YouTube Screenshot](media/Editor2.webp)

### [Editor] Reddit Old

(Note: New Reddit works fine as well!)

![Old Reddit Screenshot](media/Editor3.webp)

### [Player] Voltstro's Website

![Voltstro](media/Player1.webp)

## Authors

* **Voltstro** - *Initial work* - [Voltstro](https://github.com/Voltstro)

## License

This project is licensed under the MIT License - see the [LICENSE.md](/LICENSE.md) file for details.

## Socials

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

[![Discord](https://img.shields.io/discord/424080906232266753)](https://discord.voltstro.dev)

[![Twitter Follow](https://img.shields.io/twitter/follow/Voltstro?style=social)](https://twitter.com/Voltstro)

[![Twitter Follow](https://img.shields.io/twitter/follow/VoltstroStudios?style=social)](https://twitter.com/VoltstroStudios)

## 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](https://bitbucket.org/chromiumembedded/cef/src/master/) - Underlying web engine.

- [CefGlue](https://gitlab.com/xiliumhq/chromiumembedded/cefglue) - C# wrapper.

- [CefUnitySample](https://github.com/aleab/cef-unity-sample) - CEF directly in Unity. Has crashing problems tho.

- [unity_browser](https://github.com/tunerok/unity_browser) - (Orginally by Vitaly Chashin) CEF working in Unity using IPC, but the project is in a messy state.

- [ChromiumGtk](https://github.com/lunixo/ChromiumGtk) - Linux stuff with CEF