# Godot HTML5

***

### Introduction

In this getting-started guide, we will cover the basics of setting up a [Godot HTML5](https://docs.godotengine.org/en/latest/tutorials/export/exporting_for_web.html) project and publishing to VIVERSE using [the VIVERSE CLI](https://www.npmjs.com/package/@viverse/cli).

{% hint style="info" %}
For this guide, we are using the VIVERSE CLI, but it is also possible to compress and [upload your build file directly to the VIVERSE Studio](https://docs.viverse.com/publishing-with-your-viverse-account#upload).
{% endhint %}

### Project Settings for Godot

Web support for Godot currently requires the engine version to be Godot 4.1 or higher for successful exports. **Currently using Godot without C# is essential**. However, web export support for C# is expected soon from a recent [announcement](https://godotengine.org/article/live-from-godotcon-boston-web-dotnet-prototype/).

{% hint style="warning" %}
Godot 3 web exports are technically supported but not focused on future support.
{% endhint %}

<figure><img src="https://1140075852-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4pMiThqqrBzfvP8uy5am%2Fuploads%2FjLT7fIx3fIx3PFqXIbdX%2Fimage.png?alt=media&#x26;token=a43f2e49-971a-4b89-89b0-4ea2cdc7ab68" alt="" width="366"><figcaption></figcaption></figure>

### Export Setting for Godot

Select the desired platform for export. For web exporting, choose `HTML5`. Also **make sure that the export path is set to Build/index.html**. This will lower your packaged build size and rename project exported .html to index.html so VIVERSE can easily find and run the project.&#x20;

<figure><img src="https://1140075852-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4pMiThqqrBzfvP8uy5am%2Fuploads%2FbD4KJGKytPIu8WgfLQdt%2Fimage.png?alt=media&#x26;token=c862da67-1b1c-4183-b1b6-008fa0e486bd" alt="" width="375"><figcaption></figcaption></figure>

### Publish to VIVERSE

From here you can publish the project using the CLI tool just like any other platform.&#x20;

<figure><img src="https://1140075852-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4pMiThqqrBzfvP8uy5am%2Fuploads%2FHuoxIEPxitnsTzgyJ6Ro%2Fimage.png?alt=media&#x26;token=aef6a00c-a23c-4d0d-b1be-4d48cd094144" alt="" width="563"><figcaption></figcaption></figure>

{% stepper %}
{% step %}

#### Log in to VIVERSE platform

A. Open a command prompt and type: **viverse-cli auth login**, then click Enter.

B. Enter VIVERSE **email** and **password**.

C. Confirm login was successful.

<figure><img src="https://1140075852-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4pMiThqqrBzfvP8uy5am%2Fuploads%2FhTePdE5MYhBigkpgJBIQ%2Fimage.png?alt=media&#x26;token=20dcb9d9-c93a-49a4-bfe8-920a60919d67" alt="" width="375"><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Publish Content

A. To publish content to VIVERSE type the following command with the project path to the project's production build folder: **viverse-cli publish \<path>**, then click Enter.

B. Enter an **Application title** and **Application description**.

C. Confirm the content was published successfully.

<figure><img src="https://1140075852-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4pMiThqqrBzfvP8uy5am%2Fuploads%2FTiofefzoaB2QvZ3R61Mi%2Fimage.png?alt=media&#x26;token=0a487870-4654-4b8c-a98d-a23f5fb1385f" alt="" width="375"><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Re-publishing content

A. To re-publish content to VIVERSE when a project is already published, type the following command with the project path to the project's production build folder: **viverse-cli publish \<path>**, then click Enter.

B. Confirm the manifest file is updated.

C. Confirm the content was published successfully.

<figure><img src="https://1140075852-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4pMiThqqrBzfvP8uy5am%2Fuploads%2Fo8plaec8hNij7LV8rekc%2Fimage.png?alt=media&#x26;token=8dcdb677-5880-4fc3-af91-aee5dab7ba97" alt="" width="375"><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Test project

A. Confirm project was published successfully and working properly in VIVERSE by visiting the **URL** that is printed in the **Publish Details**.
{% endstep %}
{% endstepper %}

### General Limitations of Godot and Web Export

List of Godot WebGL rendering issues: <https://github.com/godotengine/godot/issues/66458>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.viverse.com/standalone-app-publishing/godot-html5-example.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.