From c7aef1ff94c498f3ebadc5b9ba23baca12ba233e Mon Sep 17 00:00:00 2001 From: Maschell Date: Mon, 19 Sep 2022 14:18:13 +0200 Subject: [PATCH] Update the README --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a9c5157..ae95388 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,26 @@ [![CI-Release](https://github.com/wiiu-env/ftpiiu_plugin/actions/workflows/ci.yml/badge.svg)](https://github.com/wiiu-env/ftpiiu_plugin/actions/workflows/ci.yml) -## Usage +## Installation (`[ENVIRONMENT]` is a placeholder for the actual environment name.) 1. Copy the file `ftpiiu.wps` into `sd:/wiiu/environments/[ENVIRONMENT]/plugins`. 2. Requires the [WiiUPluginLoaderBackend](https://github.com/wiiu-env/WiiUPluginLoaderBackend) in `sd:/wiiu/environments/[ENVIRONMENT]/modules`. +## Usage information and settings + +- By default, the FTPiiU server is running as long the plugin loaded (file is in the plugin directory of your environment). +- Access to the system files is **disabled by default**, you can enable it in the config menu. +- To connect to the server you can use empty credentials +- The SD card can be accessed via `/fs/vol/external01/` + +Via the plugin config menu (press L, DPAD Down and Minus on the gamepad) you can configure the plugin. The available options are the following: +- **Settings**: + - Enable FTPiiU: + - Starts/Stops the ftp server which is running in the background. Changes take effect when so close the config menu. (Default is true). + - Allow access to system files: + - Allows you to access all system files. If this option is disabled, you can only access `/fs/vol/content`, `/fs/vol/save` and `/fs/vol/external01` (SD card). Changes take effect when so close the config menu, but the server may restart. (Default is false). +- Additionally, the config menu will display the IP of your console and the port the server is running at. + ## Buildflags ### Logging