The-Homebrew-Cloud/ftpiiu_plugin
2
0
Fork 0
mirror of https://github.com/wiiu-env/ftpiiu_plugin.git synced 2024-11-05 04:25:09 +01:00
Code Issues Packages Projects Releases Wiki Activity
92 Commits 4 Branches 62 Tags 3 MiB
C 77.5%
C++ 17.1%
Makefile 5.2%
Dockerfile 0.2%
v0.3.1
Go to file
Maschell 6319e8b689 Bump version
2023-07-19 19:34:26 +02:00
.github/workflows Use non deprecated release action 2023-04-08 12:28:42 +02:00
src Bump version 2023-07-19 19:34:26 +02:00
.clang-format Format the code via clang-format 2022-02-04 14:36:55 +01:00
.gitignore Write the FSA fd to the global variable to be able to close it on exit 2020-10-16 19:21:26 +02:00
Dockerfile Update Dockerfile 2023-07-19 15:23:09 +02:00
LICENSE.txt Add LICENSE 2022-09-04 10:33:48 +02:00
Makefile Use C++20 2022-10-05 20:09:29 +02:00
README.md Change docker registry to ghcr.io 2023-03-16 15:37:49 +01:00

README.md

CI-Release

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.

Buildflags

Logging

Building via make only logs errors (via OSReport). To enable logging via the LoggingModule set DEBUG to 1 or VERBOSE.

make Logs errors only (via OSReport).
make DEBUG=1 Enables information and error logging via LoggingModule.
make DEBUG=VERBOSE Enables verbose information and error logging via LoggingModule.

If the LoggingModule is not present, it'll fallback to UDP (Port 4405) and CafeOS logging.

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 ./src -i