mirror of
https://github.com/wiiu-env/ftpiiu_plugin.git
synced 2024-11-16 17:59:19 +01:00
Update the README
This commit is contained in:
parent
0f61c1ecfb
commit
c7aef1ff94
17
README.md
17
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)
|
[![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.)
|
(`[ENVIRONMENT]` is a placeholder for the actual environment name.)
|
||||||
|
|
||||||
1. Copy the file `ftpiiu.wps` into `sd:/wiiu/environments/[ENVIRONMENT]/plugins`.
|
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`.
|
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
|
## Buildflags
|
||||||
|
|
||||||
### Logging
|
### Logging
|
||||||
|
Loading…
Reference in New Issue
Block a user