Where is the HTML root the Godot webserver runs from?

[blackears]

Godot Version

4.4.1

Question

I’m trying to get a Godot app to work with a website. I’ve created a webpage that wraps the main Godot game in an <iframe> for sizing purposes, and now I’m trying to style the iframe. I don’t have a webserver set up on my local machine, so this makes testing difficult.

I can run the game for debugging purposes by using Godot’s built in web server. I was wondering where on my disk is the root for the webserver so that I can add an extra html page with my iframe setup? That way I can try to load my wrapper page and see how it in turn loads the page with the game on it.

[dragonforge-dev]

You can run your own local webserver easily with Python.

1. Create a text file called server.py
2. Paste the following code into it:

Python Script Contents

#!/usr/bin/env python3

import argparse
import contextlib
import os
import socket
import subprocess
import sys
from http.server import HTTPServer, SimpleHTTPRequestHandler
from pathlib import Path


# See cpython GH-17851 and GH-17864.
class DualStackServer(HTTPServer):
    def server_bind(self):
        # Suppress exception when protocol is IPv4.
        with contextlib.suppress(Exception):
            self.socket.setsockopt(socket.IPPROTO_IPV6, socket.IPV6_V6ONLY, 0)
        return super().server_bind()


class CORSRequestHandler(SimpleHTTPRequestHandler):
    def end_headers(self):
        self.send_header("Cross-Origin-Opener-Policy", "same-origin")
        self.send_header("Cross-Origin-Embedder-Policy", "require-corp")
        self.send_header("Access-Control-Allow-Origin", "*")
        super().end_headers()


def shell_open(url):
    if sys.platform == "win32":
        os.startfile(url)
    else:
        opener = "open" if sys.platform == "darwin" else "xdg-open"
        subprocess.call([opener, url])


def serve(root, port, run_browser):
    os.chdir(root)

    address = ("", port)
    httpd = DualStackServer(address, CORSRequestHandler)

    url = f"http://127.0.0.1:{port}"
    if run_browser:
        # Open the served page in the user's default browser.
        print(f"Opening the served URL in the default browser (use `--no-browser` or `-n` to disable this): {url}")
        shell_open(url)
    else:
        print(f"Serving at: {url}")

    try:
        httpd.serve_forever()
    except KeyboardInterrupt:
        print("\nKeyboard interrupt received, stopping server.")
    finally:
        # Clean-up server
        httpd.server_close()


if __name__ == "__main__":
    parser = argparse.ArgumentParser()
    parser.add_argument("-p", "--port", help="port to listen on", default=8060, type=int)
    parser.add_argument(
        "-r", "--root", help="path to serve as root (relative to `platform/web/`)", default="../../bin", type=Path
    )
    browser_parser = parser.add_mutually_exclusive_group(required=False)
    browser_parser.add_argument(
        "-n", "--no-browser", help="don't open default web browser automatically", dest="browser", action="store_false"
    )
    parser.set_defaults(browser=True)
    args = parser.parse_args()

    # Change to the directory where the script is located,
    # so that the script can be run from any location.
    os.chdir(Path(__file__).resolve().parent)

    serve(args.root, args.port, args.browser)

3. Open a terminal or command prompt.
4. Type the following:
   python3 server.py
5. Open your web browser.
6. Navigate to localhost:8000 in your browser.

The script comes from the Godot repo: godot/platform/web/serve.py at master · godotengine/godot · GitHub

The instructions come from this thread on StackOverflow: https://stackoverflow.com/questions/76813078/how-to-play-a-godot-4-html-project-locally