Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/drake-rochelle/open-storefront/llms.txt

Use this file to discover all available pages before exploring further.

Open Storefront requires nothing beyond a standard Python 3 installation. In less than a minute you can clone the repository, launch the client, and be browsing 3DS content from your terminal. This guide walks you through every step and shows you exactly what to expect on screen.

​
Prerequisites

  • Python 3.x — any recent Python 3 release works. Download it from python.org if you do not already have it.
  • Internet access — the client fetches storefront.json live from Google Drive each time you open or navigate to a storefront.
  • No pip packages — every module Open Storefront uses ships with Python itself.

​
Steps

1

Clone the repository

Clone the Open Storefront repository from GitHub to a directory of your choice.
git clone https://github.com/drake-rochelle/open-storefront.git
cd open-storefront
Alternatively you can download a ZIP archive from the same URL and extract it manually.
2

Run the client

Launch the script with your system Python 3 interpreter.
python main.py
The program immediately prints your resolved download path (your home directory by default), then fetches the home storefront from Google Drive:
/home/yourname
Loading...
Once the manifest has downloaded, the screen clears and the main menu appears.
3

Navigate the storefront

The menu lists everything in the current storefront. Each line starts with a number you can type to select that item.
Home Storefront:

0: Games
1: Utilities
2: Themes
3: My Favourite App.cia
  • Type a number and press Enter to open a sub-storefront or download a file.
  • Type x and press Enter to return to the Home Storefront from any sub-storefront.
When you select a downloadable file the screen shows Downloading..., then confirms success:
Download successfull.
Enter any symbol to return to storefront...
Press any key to go back to the current menu.

​
Example Terminal Session

Below is a representative session showing menu navigation, entering a sub-storefront, and downloading a file. 
/home/yourname
Loading...
(screen clears) 
Home Storefront:

0: Games
1: Utilities
2: Themes
User types 0 → enters the Games sub-storefront: 
Games:

x: <home>
0: Action
1: RPG
2: Some Homebrew Game.cia
User types 2 → downloads the file: 
Downloading...
(screen clears) 
Download successfull.
Enter any symbol to return to storefront...
User presses Enter → returns to the Games menu.
On first run, if no home.3sf file is present next to main.py, Open Storefront automatically connects to the default home storefront identified by Google Drive file ID 1m99FhKG-zpNd7VoAOjFV11dyJsDbnUv9. To use a different storefront as your home, create a home.3sf file in the same directory as main.py and paste your preferred Google Drive file ID as its only content.

Build docs developers (and LLMs) love

Get started for freeTalk to us