> For the complete documentation index, see [llms.txt](https://docs.xibosignage.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xibosignage.com/developer/widgets/html-package.md). # HTML Package Package HTML Widgets are uploaded to Xibo’s Library and assigned to one or more Layouts/Playlists. HTML packages allow an entire HTML structure to be distributed to players, extracted and then a nominated URL opened (usually `index.html`). The major advantage of this over using a web page is that your HTML will be local to the player and available even if the Player loses network connectivity. Unlike Embedded Widgets, the Player does not inject any of its core libraries, although it will attempt to call `xiboIC` in case interactive control has been included (see Player Control). ## Referencing Resources Your entry point (`index.html`) will likely need to reference other files, be they scripts, style sheets or images. These resources must be referenced relatively, because your entire package will be inside a folder. You are guaranteed that the folder structure is only one level deep, for example `http://localhost:9696/package_1234/index.html`. ## CORS HTML packages will be opened on the Player’s embedded web server, run on port 9696 by default. This means any XHR requests you make will be cross origin. If this is not acceptable for your use case then the only option remaining is a Web Page Widget and external hosting for your content. ## Player Browser Versions Where possible Xibo player implementations choose the chromium rendering engine, but effort should be made to thoroughly test your package HTML on the player it is intended for, or to make it cross browser. ## Player Control HTML Package Widgets can also make use of the API’s available for Player Control — see here: --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.xibosignage.com/developer/widgets/html-package.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.