SGS/README.md

Switch Games Server

Switch Games Server is a lightweight Laravel-based application that exposes your Nintendo Switch game files over the network, making them accessible to homebrew applications like Tinfoil and DBI.

With SGS, you can install games wirelessly without connecting your Switch to a computer. Once set up, all Nintendo Switch devices on your network can access and install games directly from the server.

Features

• 🎮 Network File Sharing - Share your Switch game files (.nsz, .nsp, .xci, .xcz) over the network
• 📱 Tinfoil Support - JSON-based file index for Tinfoil app
• 🗂️ DBI Support - Apache-style directory listing for DBI app
• 🐳 Docker Ready - Fully containerized with Docker Compose
• ⚡ Auto Setup - Automatic dependency installation on first run

Quick Start

Prerequisites

• Docker
• Docker Compose
• Git

Installation

1. Clone the repository

   git clone https://github.com/notf0und/SGS
   cd SGS
   

2. Start the application

   docker-compose up -d
   

   That's it! The application will automatically:

   • Install Composer dependencies
   • Install and build npm assets
   • Create storage symlinks
   • Start the web server

3. Access the application

   Open your browser and navigate to:

   http://localhost:8030
   

   Or replace localhost with your server's IP address.

Adding Games

Place your Nintendo Switch game files in the games/ directory. Supported formats:

• .nsz - Compressed NSP
• .nsp - Nintendo Submission Package
• .xci - NX Card Image
• .xcz - Compressed XCI

Client Setup

Tinfoil Setup

See www/docs/TINFOIL.md for detailed instructions or visit http://YOUR_SERVER_IP:8030/docs/TINFOIL in your browser.

DBI Setup

See www/docs/DBI.md for detailed instructions or visit http://YOUR_SERVER_IP:8030/docs/DBI in your browser.

API Endpoints

• Tinfoil Index: http://YOUR_SERVER_IP:8030/api/tinfoil
• DBI Browser: http://YOUR_SERVER_IP:8030/api/dbi
• Generic (work for Tinfoil and DBI): http://YOUR_SERVER_IP:8030

Legal Disclaimer

⚠️ Important: This software is intended for personal use only. It is designed to help you manage and access your legally owned game backups over your local network.

• Only use this software with games you legally own
• Piracy is illegal and violates copyright laws
• This software is provided for educational and backup purposes only
• The developer do not condone or support piracy in any form
• Users are solely responsible for ensuring their use complies with local laws

By using this software, you agree to use it in accordance with all applicable laws and regulations.

License

This work is licensed under CC BY-NC-SA 4.0