Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/markwal/gpxui

A GUI wrapper around GPX and someday maybe even a setup program
https://github.com/markwal/gpxui

Last synced: 3 months ago
JSON representation

A GUI wrapper around GPX and someday maybe even a setup program

Awesome Lists containing this project

README

        

# GpxUi

GpxUi is a graphical user interface wrapped around GPX, a command line utility.

Should work on Windows (test on Windows 10), Mac (tested on El Capitan) and
Linux (tested on Kubuntu 15 and 16).

GPX is a post processing utility for converting gcode output from 3D slicing
software like Cura, KISSlicer, S3DCreator and Slic3r to x3g files for standalone
3D printing on Makerbot Cupcake, ThingOMatic, and Replicator 1/2/2x printers - with
support for both stock and SailFish firmwares.

This GpxUi includes gpx.exe for use as a plugin to slicers, but also includes a
settings editor and setup program to make it easy to get GPX set up and running
with the right settings. Also includes a machine settings editor so you can mess
with arcane stuff like how many steps per mm.

## Installing

### Windows

1. Download and run setup.exe from the [releases](https://github.com/markwal/GpxUi/releases/latest) page

### Mac

1. Download a GpxUi.dmg from the [releases](https://github.com/markwal/GpxUi/releases/latest) page
2. Open the GpxUi.dmg file and drag the GpxUi app to your Applications folder
3. Run GpxUi from the Launcher

### Linux

1. Build it from source (instructions below) and do `make install`
2. run "GpxUi"

## Running

1. Choose your printer type
2. Choose the gcode flavor of the slicer you want to use
3. Click "Save" to save those two settings into gpx.ini
4. Click the translate button, it'll ask for the name of the gcode file and the name of the output x3g file

## Notes

The setup added gpx.exe to your path, so you can easily add it as a post
processor to Slic3r:

1. Put Slic3r into expert mode via File.Preferences from the menu bar and restart Slic3r
2. Choose "Print Settings" tab, "Output options" panel
3. In "Post-processing scripts" type "gpx.exe" all by itself without quotes or parameters

### Mac Note

* Replace step 3 with: In "Post-processing scripts" type "/Application/GpxUi.app/Contents/MacOS/gpx"

### Windows Notes

It added to the end of your path, so if you have a gpx.exe somewhere else on
your machine and on your path, it won't read the settings you set in GpxUi because
the other one will win and it won't know where these settings are.

You can switch the settings around and gpx.exe will just use whatever you saved
last. Settings are also saved when you use GpxUi to translate a file.

Setup added an icon to your desktop and to your start menu. If you like a clean
desktop like me, drag the desktop one to the trash, you can still run it from
start. Seems like letting you drag it to the trash was easier than bothering
you with a question in setup.

GpxUi includes an auto-updater courtesy of Squirrel for Windows. It checks for
updates when you start it. So if you leave it running or never run it, it
doesn't update. Plus it has a limiter on it so it doesn't check every time you
boot it up, just when it has been a while. You can turn this off on the
Help.Updates... menu.

## Future features

- Have setup connect gpx.exe to the right-click on gcode files menu so you
can right-click on a gcode file and choose "Convert to x3g"
- A warning when it notices another gpx.exe earlier on the path
- Have an option to send a copy of the x3g to a flashair card
- Have setup or a configuration dialog automatically add plugins to various
slicers
- Drag and drop?

## Dependencies

- [QT 5.5](https://www.qt.io/developers)
- [Squirrel.Windows](https://github.com/Squirrel/Squirrel.Windows) (only need
this if you are going to build setup)

## Build instructions

1. Clone the repository
2. Get the submodules `git submodule update --init`
3. Install QT and make sure it and the mingw32 it includes is on your path, I
run gnu make under bash so I may have introduced a build-time dependency on
bash
4. `make` for the debug build or `make release` for the optimized build

For Windows setup.exe: `make squirrel.windows`
For Mac dmg: `make macdeployqt CODESIGNID="signature name"`

## Ubuntu build instructions

1. Clone the repository `git clone https://github.com/markwal/GpxUi`
2. Get the submodules `git submodule update --init`
3. Install qt5 tools and libraries `sudo apt-get install qttools5-dev-tools
qtbase5-dev`
4. `make` for the debug build or `make release` for the optimized build
5. `make install`