Skip to content

Latest commit

 

History

History
252 lines (192 loc) · 13.3 KB

README.md

File metadata and controls

252 lines (192 loc) · 13.3 KB

Fluffy

intro 查看中文使用说明,请点击这里!

한국어를 할 줄 알아요?

License Releases LatestVer

Features

  • Support for XorTroll/Goldleaf and Adubbz/Tinfoil
  • Support for languages: English, Chinese, Vietnamese, Spanish, French, Brazilian Portuguese, Turkish, Italian, German, and Bahasa Indonesia!
  • Cross platform: Fluffy works natively on Windows, Linux, and MacOS!
  • USB and Network: Display live transfer rate in MB/s with progress percentage.
  • USB and Network: Display current NSP being installed and numbered queue.
  • USB and Network: Batch NSP install support with individual selection.
  • USB and Network: Consecutive installs without restart.
  • USB and Network: Exception/Error handling, no restart required when an installation fails.
  • USB and Network: Ability to abort an installation in queue.
  • Tinfoil Network: Spoof file URL's to fix lengthy file name bug in Tinfoil's code.
  • Tinfoil Network: Randomized port selection.
  • Tinfoil Network: By default fall-back to Network Mode in the event USB mode can't be used(e.g. missing libraries).
  • Goldleaf: Display current file being accessed.
  • Goldleaf: Goldleaf v0.6 compatible with all of the file handling features.
  • Goldleaf: Default protections are in place to safe-guard users from a potentially compromised Goldleaf file.
    • Default: File operations such as file creation, deletion, renaming will result in a user-prompt(yes or no).
    • Default: Read-only access for all files.
    • Default: Read/write to non-NSP files are restricted.
    • All of these security restrictions are changeable in fluffy.conf.
  • Tinfoil USB: Selectable transfer rates between "Normal Mode" and "Safe Mode" for those with aging hardware(e.g. out of spec USB ports).
  • USB: Switch connected indicator.
  • User-Interface: Light Mode and Dark Mode.
  • General: Auto saves to config Switch IP Address, Light/Dark Mode Settings, and Language Selection.
  • General Support for UI scaling up to 4K resolution.
  • Tinfoil USB: Switch Firmware 5.x USB Fix (Thanks to satelliteseeker for finding this fix, choose 'Safe Mode')
  • Cute fluffy penguin.

Screenshot

[Windows] Instructions For Use (Fluffy.exe)

1/3) Install TinFoil or Goldleaf on your Switch

  • These steps apply for all custom firmware. This includes but not limited to: Kosmos, ReINX, SXOS, etc.
  • Download Recommended TinFoil
  • Copy and paste "TinFoil.nro" to a folder named "Switch"(create it if necessary) on the root of your SD card.
  • or Download Goldleaf by XorTroll.

2/3) Install and Setup Zadig Driver

  • Download Zadig: https://zadig.akeo.ie or github mirror in case the website goes down.
  • With your Switch plugged in to your PC using a USB-C cable, open TinFoil(on your Switch). This will ensure your Switch is visible.
  • Open Zadig > Options > List All Devices.
  • In the scroll box above the button "Install Driver", tap the arrow until arriving at "libusbK".
  • Click "Install Driver"
  • Done!

3/3) Run Fluffy and Install NSP(s)! (Tinfoil)

  • Connect your Switch and your PC with a USB Type-C cable.
  • Run Fluffy.exe.
  • On your Switch open Tinfoil > Title Management > USB Install NSP
  • On Fluffy click "NSP Selection" > Select your NSP(s)
  • On Fluffy's Tinfoil USB screen click "Begin Transfer".

3/3) Run Fluffy and Install NSP(s)! (Goldleaf)

  • Run Fluffy.exe.
  • On your Switch open Goldleaf > Explore Content
  • On Fluffy's Goldleaf screen click "Begin Transfer".
  • On your Switch select "PC Drive (via USB)"
  • Navigate to and install your NSP(s).

[Windows] Instructions For Use (Fluffy.pyw)

1/5) Install TinFoil or Goldleaf on your Switch

  • These steps apply for all custom firmware. This includes but not limited to: Kosmos, ReINX, SXOS, etc.
  • Download Recommended TinFoil
  • Copy and paste "TinFoil.nro" to a folder named "Switch"(create it if necessary) on the root of your SD card.
  • or Download Goldleaf by XorTroll.

2/5) Install and Setup Zadig Driver

  • Download Zadig: https://zadig.akeo.ie or github mirror in case the website goes down.
  • With your Switch plugged in to your PC using a USB-C cable, open TinFoil(on your Switch). This will ensure your Switch is visible.
  • Open Zadig > Options > List All Devices.
  • In the scroll box above the button "Install Driver", tap the arrow until arriving at "libusbK".
  • Click "Install Driver"
  • Done!

3/5) Install Python

  • Download and Install Python 3 from Python Website. Select the "PATH" option during install. Ensure no previous version of Python is installed and do not use the 64-bit version of Python 3. This may cause an error "PyUSB not found". Also be sure to include Tkinter with your installation(it should be a default option).

4/5) Install Python Dependencies

  • Open Command-line/CMD (Start, search "CMD") and run the following:
pip3 install pyusb pyqt5 libusb libusb1 qdarkstyle configparser

5/5) Run Fluffy and Install NSP(s)! (Tinfoil)

  • Connect your Switch and PC with a USB Type-C cable
  • Run Fluffy.pyw
  • On your Switch open Tinfoil > Title Management > USB Install NSP
  • On Fluffy click "NSP Selection" > Select your NSP(s)
  • On Fluffy's Tinfoil USB screen click "Begin Transfer"

5/5) Run Fluffy and Install NSP(s)! (Goldleaf)

  • Connect your Switch and PC with a USB Type-C cable
  • Run Fluffy.pyw
  • On your Switch open Goldleaf > Explore Content
  • On Fluffy's Goldleaf screen click "Begin Transfer"
  • On your Switch select "PC Drive (via USB)"
  • Navigate to and install your NSP(s)

Linux instructions

Ubuntu/Debian based distributions

1/3) Install Python and Dependencies

  • Required: python3 python3-pyusb python3-pyqt5 python3-tk python3.6-tk libusb libusb1 qdarkstyle.
  • Install Python3:
  • sudo apt install python3 python3-pip python3-tk.
  • Then open Terminal and run this command:
  • pip3 install pyusb pyqt5 libusb libusb1 qdarkstyle configparser.
  • If that doesn't work try
  • pip install pyusb pyqt5 libusb libusb1 qdarkstyle configparser.

2/3) Download Fluffy and Switch Rule

Download the latest Fluffy.pyw and 80-fluffy-switch.rules.

Open Terminal and change into the directory where these files are located using the cd command:

cd /path/to/fluffy/

Copy the file 80-fluffy-switch.rules to /etc/udev/rules.d/ using this command:

sudo cp 80-fluffy-switch.rules /etc/udev/rules.d/

Then give both the proper permissions:

sudo chmod 644 /etc/udev/rules.d/80-fluffy-switch.rules
sudo chmod 755 fluffy.pyw

3/3) Starting Fluffy

To start Fluffy.pyw you should be able to double-click to open. But if that doesn't work, you may need to run Fluffy.pyw using Terminal.

Open Terminal and Enter:

python3 /path/to/fluffy.pyw

Alternatively, you can install IDLE(A Python interface).

sudo apt-get install idle3

Open IDLE > Open Fluffy.pyw then select Run > Run Module.

Arch/Manjaro/Antergos

Install the AUR package fluffy-switch maintained by YoyPa.

Installation and Application Launcher (Optional)

You may wish to Install Fluffy. Download the latest Fluffy.pyw and 'icon.ico' and 'install.sh' from here. Extract and move each file into a single folder.

Installation is then as simple as:

cd /path/to/files/
sudo ./install.sh

MacOS instructions

brew install tcl-tk
brew reinstall python3
pip3 install pyusb pyqt5 libusb libusb1 qdarkstyle configparser
python3 ./fluffy.pyw

Special thanks to GuillaumeJulien for these instructions.

For more info on brew, head to https://brew.sh/

Troubleshooting Tips

(Linux)Fluffy.pyw still shows up as an unknown file?

Answer: Run it using Terminal

python3 fluffy.pyw

Why do I keep getting the error: "USBCore No Backend Available"?

Answer: This can be caused by 1-2 things.

  1. Download libusb-1.0.dll and place it in the same folder as Fluffy. If that doesn't work, install LibUSB using Zadig or libusb-win32-devel-filter Installer.

  2. Not all USB Type-C cables will work with the Switch. If your Switch connects then frequently disconnects, then reconnects again, etc. Or if you receive this error, it's highly likely you will need a newer USB Type-C cable. Yes, there are differences despite being visually similar.

Why do I keep getting the error: "No module named 'PyQt5'"?

Ensure "PATH" is selected when installing Python. If that still doesn't solve it, try running Fluffy using IDLE(32-bit mode).

Why does network install hang/freeze?

Answer: This is normal. Network install can sometimes hang and take a long time to work depending on your nework, how many devices are using your WiFi, your WiFi speed, etc. Give it some time and it will initiate the transfer. It may take several minutes. Fluffy may seem frozen, but in most instances a little patience is advisable.

What kind of cable does the Switch use?

Answer: USB Type-C cable. Though, not all USB Type-C cables are the same. Some will not be compatible with the Switch.

Does Fluffy work on MacOS and Linux?

Answer: Absolutely! Python is cross-platform and so Fluffy should work on both operating systems.

Which Custom Firmware works best with Fluffy and TinFoil?

Answer: All of them will work the same. That is up to you.

Why does my install keep hanging and/or crashing?

Answer: Switch Transfer Mode to "Safe Mode". If you're installing via Tinfoil Network, it is normal for the install to sometimes hang.

Why do I have unsufficient permission error (usb)(linux)? (credit: YoyPa)

Answer: You need to make a udev rule to modify the switch usb device permission in /etc/udev/rules.d/

Still having problems? Consider making a bug report on this GitHub page to request assistance.

Credits

Fluffy was developed from the ground-up by Fourminute, including almost all of the features and bug fixes throughout. But there have been several people that have devoted their time and effort into improving Fluffy.

I would like to extend my thanks to the people below for helping make Fluffy what it is today.

  • wendyliga for their Bahasa Indonesia translation.
  • TheLastZombie for their German translation.
  • YoyPa for their many and various code contributions, creating and maintaining the fluffy-switch AUR package, as well as their Spanish and French translations.
  • LoOkYe for testing and debugging Fluffy in its various stages of development on MacOS.
  • friedkeenan for their tremendous help on Goldleaf v0.6 compatibility.
  • TorpedoXL for their Turkish translation.
  • DavidOliM for their Brazilian Portuguese translation.
  • danypava for their Italian translation.
  • Sev73n for their Chinese(Mandarin) translation as well as translating the entire README.

To anyone else that I missed, thank you.

"Cute Penguin" was designed by fourminute. The font used in the "Fluffy" logo is 100% royalty free.

Fluffy(this program) and the "Cute Penguin" design is Copyright (c) 2019 fourminute (https://github.com/fourminute)