Go to file
Maschell cfd9c6c801 Improve performance when reading directories 2024-03-24 11:07:30 +01:00
.github/workflows Remove debug log build check 2024-03-08 19:25:28 +01:00
include Remove platform specific code for other platform than wii u, remove third party dependencies 2024-03-08 17:52:47 +01:00
source Improve performance when reading directories 2024-03-24 11:07:30 +01:00
.clang-format Add github actions and update Dockerfile 2024-03-08 19:09:13 +01:00
.gitignore wiiu: working as a plugin 2024-03-08 17:34:11 +01:00
Dockerfile Add github actions and update Dockerfile 2024-03-08 19:09:13 +01:00
LICENSE v3.0.0-rc1 2020-04-28 10:25:54 -05:00
Makefile Update target .wps filename 2024-03-08 19:16:06 +01:00
README.md Remove debug log build check 2024-03-08 19:25:28 +01:00

README.md

CI-Release

ftpiiu - A ftp server plugin for the Wii U based on ftpd

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 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.

See the ftpd repository for a list of all supported commands.

Logging

Logs will only appear in the system log (OSReport).

Building using the Dockerfile

It's possible to use a docker image for building. This way you don't need anything installed on your host system.

# Build docker image (only needed once)
docker build . -t ftpiiuplugin-builder

# make 
docker run -it --rm -v ${PWD}:/project ftpiiuplugin-builder make

# make clean
docker run -it --rm -v ${PWD}:/project ftpiiuplugin-builder make clean

Format the code via docker

docker run --rm -v ${PWD}:/src ghcr.io/wiiu-env/clang-format:13.0.0-2 -r ./source ./include -i

Credits

This plugin is based on ftpd by mtheall