You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Reformat README into a centered header with badges and screenshots.
Expand Key Features, How To Use, Development, Download, Roadmap and
Credits sections. Add two new screenshot assets.
<h4align="center">Transfer files to and from your Steam Deck over Wi-Fi directly from Game Mode no desktop required. Inspired by <ahref="https://github.com/mtheall/ftpd"target="_blank">ftpd</a> on PSP / PS Vita.</h4>
* 📡 **Game Mode native** — start and stop the FTP server from the Quick Access Menu
38
+
- No desktop mode, no SSH, no keyboard required.
39
+
* 🔗 **Instant connect** — your Deck's local IP and port are displayed right in the panel
40
+
* 📁 **Full read/write access** to `/`
41
+
- Games, saves, emulators, homebrew all transferable.
42
+
* 🔌 **Zero config** — anonymous login, no credentials to set up
43
+
* ⚡ **Fully offline** — no internet required on the Deck after install
44
+
* 🛡️ **Local network only** — never exposed to the public internet
45
+
46
+
## How To Use
21
47
22
48
1. Press the **`…`** button to open the Quick Access Menu
23
49
2. Open **decky-ftpd** and toggle **Enable FTP Server** ON
@@ -44,37 +70,27 @@
44
70
| iOS | FE File Explorer, Filza |
45
71
| Linux | FileZilla, Nautilus (built-in) |
46
72
47
-
---
48
-
49
-
## Notes
50
-
51
-
- The FTP server shares `/home/deck` — this includes your games, saves, emulators, and homebrew
52
-
- The server is only accessible on your **local network** — it is not exposed to the internet
53
-
- The server stops automatically when the plugin is unloaded or the Deck shuts down
54
-
- Toggle it off when not in use if you are on a shared network
55
-
56
-
---
73
+
> **Note**
74
+
> The server stops automatically when the plugin is unloaded or the Deck shuts down. Toggle it off when not in use if you're on a shared network.
57
75
58
76
## Development
59
77
60
-
### Prerequisites
78
+
To clone and run this plugin, you'll need [Git](https://git-scm.com), [pnpm](https://pnpm.io), Python 3.11+, and a Steam Deck with [Decky Loader](https://decky.xyz) installed. From your command line:
61
79
62
-
-[pnpm](https://pnpm.io)
63
-
- Python 3.11+
64
-
- A Steam Deck with [Decky Loader](https://decky.xyz) installed
65
-
66
-
> **Note:** SSH is only required if you want to deploy directly from your dev machine during development. End users installing from the Decky store don't need it.
# Set up Python venv for editor support (optional but recommended)
75
-
python3 -m venv .venv
76
-
source .venv/bin/activate # or activate.fish for fish shell
77
-
pip install pyftpdlib
91
+
$ python3 -m venv .venv
92
+
$ source .venv/bin/activate # or activate.fish for fish shell
93
+
$ pip install pyftpdlib
78
94
```
79
95
80
96
### Build & Deploy
@@ -88,15 +104,20 @@ DECK_IP=192.168.1.x
88
104
Then:
89
105
90
106
```bash
91
-
make deploy # build frontend, create zip, rsync to Deck
92
-
make zip # build + create zip only
93
-
make build # build frontend only
94
-
make clean # remove build artifacts
107
+
$ make deploy # build frontend, create zip, rsync to Deck
108
+
$ make zip # build + create zip only
109
+
$ make build # build frontend only
110
+
$ make clean # remove build artifacts
95
111
```
96
112
97
113
On the Deck, install via **Decky → Settings → Developer → Install Plugin from ZIP**.
98
114
99
-
---
115
+
> **Note**
116
+
> SSH is only required if you want to deploy directly from your dev machine during development. End users installing from the Decky store don't need it.
117
+
118
+
## Download
119
+
120
+
You can [download](https://github.com/codevski/decky-ftpd/releases) the latest release, or install directly from the Decky Plugin Store.
100
121
101
122
## Roadmap
102
123
@@ -105,8 +126,24 @@ On the Deck, install via **Decky → Settings → Developer → Install Plugin f
105
126
-[ ] MicroSD card quick-access shortcut
106
127
-[ ] Active connection count in the status line
107
128
108
-
---
129
+
## Credits
130
+
131
+
This plugin uses the following open source packages:
0 commit comments