WPrint 3D is a FDM printer web-based remote control software compatible with most common standard serial/TTY over USB printers.

• Any dual-core CPU running at, at least, 1 GHz
• 1 GB of memory running at any speed *
• 2 GB of storage space
• A wired network card running at, at least, 10/100 Mbps mode or a wireless network card connected to a device that can provide a 54 Mbps mode (or better) for a stable live webcam feed
• Optionally, a USB camera or a real hardwired sensor, such as a Raspberry Pi camera.

• If you're running Windows, go to the "Preparing your Windows host" section first.

• Install docker as explained in the linked guide.

• Give yourself permission to run Docker commands by following the guide linked here, this is extremely important because we'll need to set up a few privileged containers.

• Clone this repository wherever you want, just make sure you'd have write permission with the user you're currently logged in.

  git clone -b alpha https://github.com/wprint3d/wprint3d

• Change to the created directory by running cd wprint3d.

• Now, using your favorite text editor, create a new file called .env and copy the contents of .env.example into it. If you're planning on running WPrint 3D on a Raspberry Pi, consider copying .env.rpi instead as it's been specifically optimized to run faster on its hardware.

• That's it! Plug your printer in any USB port you like and turn it on! Now, run bash run.sh to get going. The first run might take a few minutes, so you'll probably want to find something else to do in the meantime.

• If you're running Windows, go to the "Next steps on your Windows host" section.

• Once it's done, type ifconfig and copy the IP address of your machine. Type that IP address into the address bar of your browser, i.e.: https://192.168.0.2

• Follow the on-screen instructions.

• Install WSL2 and a GNU/Linux distribution of your choice as explained in the linked article. I highly suggest going with Ubuntu as it requires way less manual work in order to get started. This guide has been tested while using said distribution.
• Open a new Terminal and get into your GNU/Linux distribution. If your distribution is named "Ubuntu-24.04", type wsl -d Ubuntu-22.04. If you're unsure, get a list of installed distributions by running wsl --list.
• Go back to the "Getting started" section and follow the remaining steps to install Docker and setup your system.

• From a new Terminal window or tab, install usbipd-win by running winget install usbipd. This is required to share USB devices between Windows and the virtual machine.

  Do not enter your GNU/Linux distribution yet, this step MUST be done from the host!

• Type usbipd --list to get a list of connected devices. Take note of the VID:PID field related to your printer. Mine looks like this:

    > usbipd list
    Connected:
    BUSID  VID:PID    DEVICE                                                        STATE
    ...
    1-11   2341:0042  USB Serial Device (COM4)                                      Not shared
  

• Enable binding by running usbipd bind -i 2341:0042.

• Attach the printer to WSL2 by running usbipd attach --wsl 2341:0042.

• Now, get back into your GNU/Linux distribution. If your distribution is named "Ubuntu-24.04", type wsl -d Ubuntu-22.04. If you're unsure, get a list of installed distributions by running wsl --list.

• Run hostname -I, if more than one IP address is returned, copy the first IP address from the list. Then, paste it into a new browser tab.

• That's about it!

• SD printing may disrupt the negotiated serial connection. The connection should come back about a minute after finishing the print job. This bug will be worked on in the near future.

Classmap-level documentation can be automatically generated by running the application in developer mode. To do so, run bash run.sh -e dev, this will activate the documentation-generator service and the documentation will be written to docs/public.

In order to view the generated web UI visit the following URL: https://<your-LAN-ip-address>:30000

WPrint 3D is open-sourced software licensed under the MIT license.