Skip to content

Ferase/SwampSwap

Repository files navigation

Swamp Swap icon

Swamp Swap

A graphical user interface that controls the command line file transfer program croc by Zack Shollz.

Swamp Swap window preview with pink theme on the send tab Swamp Swap window preview with deep adark theme on the receive tab Swamp Swap window preview with dark theme on the settings tab

Overview

This is a simple user interface that operates croc directly by constructing commands and executing them via subprocess. This project is intended to make working with croc a bit more interactive and give users that prefer GUIs a more convenient way to use the program.

This project does not use any code from croc and will not install it if you don't have it. Please visit croc's repository to see how to install it.

Running

Simply visit the Releases page and download the version for your system.

Swamp Swap currently only supports Linux and Windows, however it can likely be built for your system if your OS supports Python.

Building

Swamp Swap is built using PyInstaller, meaning you can only build for your own operating system and architecture. For example, if you build the program on Linux with an ARM processor, only other computers running Linux with an ARM processor can execute the program.

Requirements

In order to build Swamp Swap, you must have Python 3.10+.

On Windows, you need the Microsoft C++ Redistributable. On Linux, you will need to search for the C++ libraries for your distribution within your package manager.

When you build, you can use any of the four build scripts present in the root directory of the repository. Here's a breakdown of each:

  • build_onedir.spec / Build the program to a directory with a single EXE and an _internal folder containing required binaries. (This is how the releases were built)
  • build_onedir_with_terminal.spec / Build the program to a directory with a single EXE and an _internal folder containing required binaries. A terminal window will open alongside the program
  • build_onefile.spec / Build the program to a single EXE file
  • build_onefile_with_terminal.spec / Build the program to a single EXE file. A terminal window will open alongside the program

Build Process

  1. Clone the repository and enter the newly made directory in your terminal
git clone https://github.com/Ferase/SwampSwap
cd SwampSwap
  1. Create a new virtual environment, then enter it

    1. On Windows:
    python -m venv venv
    venv\scripts\activate
    
    1. On Linux:
    python -m venv venv
    source venv/bin/activate
    
  2. Ensure pip is up to date:

python -m pip install --upgrade pip
  1. Install the required packages
pip install -r requirements.txt
  1. Build the program
pyinstaller build_onedir.spec

Credits

User Interface

  • Ferase

croc

Testing

  • OctoToon

Translations

  • Ferase (English)
  • Other translations to come

Disclaimer

This project is in no way affiliated with Zack Schollz or the croc project directly. This is purely a fun project that does not aim to (nor is capable of) replace croc or its functionality. It requires you have croc installed and will not install it for you.

About

A graphical user interface for the command line file transfer program croc, built in PyQt6.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors

Languages