Skip to content

Latest commit

 

History

History
 
 

skyrim_ui

README.md

Skyrim: Together UI

The UI is built using web technologies. The recommended IDE is Visual Studio Code, but you don't need one for the build process.

Building

You will need Node.js installed. The UI can be built on any operating system that supports Node.js using the same method.

Open a shell inside Code/ui and execute npm install. This will install the required packages.

Testing

  1. Use npm run serve to host the development build on the local system under port 4200.
  2. Open http://localhost:4200 in a browser (Chrome recommended as it supports scrollbar customization).

Note: The project will be automatically recompiled and the page reloaded when a source files changes.

Use within the game

  1. Execute npm run build to build the development version. Alternatively, execute npm run deploy to build the production version.
  2. Copy the entire out folder to the Data/Online/UI folder within your Skyrim installation path. We recommend creating a symbolic link to the folder during development instead of duplicating to avoid having to copy them after each build.