diff --git a/README.md b/README.md index 444aced..55b94f8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,66 @@ -# proxmox-install-steam-lxc +# Steam LXC Installation Script -Steam in an unprivileged LXC container with GPU passthrough \ No newline at end of file +This script automates the installation of Steam within an unprivileged LXC container in Proxmox with GPU passthrough. It sets up a complete environment including a MATE desktop environment and KasmVNC for remote access. + +## Prerequisites + +- Proxmox 7.4 or later +- Unprivileged LXC container with Debian 12 +- GPU passthrough already configured in your LXC container +- Working internet connection +- Root access to the LXC container + +## GPU Passthrough Setup + +Before running this script, ensure you have properly configured GPU passthrough for your LXC container. This involves: + +1. Getting the GID of the 'render' group in your container +2. Modifying the LXC configuration on the Proxmox host +3. Verifying the GPU is properly passed through + +For detailed GPU passthrough setup instructions, refer to the original guide. + +## Installation + +1. Download the installation script: +```bash +wget https://git.hhf.technology/hhf/proxmox-install-steam-lxc/raw/branch/main/install-steam-lxc.sh +``` + +2. Make the script executable: +```bash +chmod +x install-steam-lxc.sh +``` + +3. Run the script as root: +```bash +sudo ./install-steam-lxc.sh +``` + +4. Follow the prompts to create a new user account. + +## Post-Installation + +After the installation completes: + +1. Switch to the new user account created during installation +2. Start KasmVNC with GPU passthrough: +```bash +vncserver -hw3d -drinode /dev/dri/renderD128 +``` +3. Access your desktop through the KasmVNC web interface +4. Launch Steam from the desktop menu or by running the `steam` command + +## Notes + +- Always use the specified vncserver command with `-hw3d` and `-drinode` flags to ensure GPU passthrough is enabled +- It's recommended to disable desktop compositing for better performance +- If the KasmVNC website doesn't load correctly at first, try refreshing a few times + +## Support + +For issues and questions, please open an issue on the forums or refer to the original documentation on the forum. + +## License + +Apache 2.0 License \ No newline at end of file