Skip to content

Latest commit

 

History

History
85 lines (57 loc) · 3.33 KB

README.md

File metadata and controls

85 lines (57 loc) · 3.33 KB


Paperarium Designer
Paperarium Designer

An open source, cross-platform desktop app for unfolding 3D models into papercrafts.

Key Features • How To Develop • Download • Credits • Related • License

Note This is a work in progress. Below is a screenshot of the latest state of development.

Screenshot 2022-12-14 at 5 41 18 AM

Key Features

  • Open source and free to use
  • Cross platform
    • Windows, macOS and Linux ready.
  • Vulkan-backed rendering engine

How To Develop

To be able to build this application from source, you'll need Git, Qt, Qt Creator, and the Vulkan SDK. Also make sure you have pkg-config for VCPKG, installable from Homebrew. Then, from your command line:

# Clone this repository and the VCPKG submodule
$ git clone --recurse-submodules https://github.com/paperarium/paperarium-designer

# Go into the repository
$ cd paperarium-designer

# Set up VCPKG and install the ASSIMP, GLM, OpenMP, and Vulkan dependencies
$ ./lib/vcpkg/bootstrap-vcpkg.sh
$ ./lib/vcpkg/vcpkg install assimp glm openmp vulkan

Note I develop on MacOS 10.15, so YMMV on other platforms. Please contribute!

Now start QT Creator and open up the project by going to File > Open File or Project and selecting the CMakeLists.txt file. You'll need to make the VCPKG toolchain available to your CMake to be able to automatically link ASSIMP.

This can be done by changing your Kit configuration in Qt Creator to add the -DCMAKE_TOOLCHAIN_FILE cmake flag. Go to Projects and add the following key-value pair to your kit's Initial Configuration:

# Key, Value
CMAKE_TOOLCHAIN_FILE, <path-to-your-clone>/lib/vcpkg/scripts/buildsystems/vcpkg.cmake

This should enable you to now build and run Paperarium Designer from with Qt Creator. I often do code work in VSCode as well, which necessitates installing the Qt Tools VSCode extension. Happy developing!

Download

Paperarium does not yet have a release package, or even a beta version. Hopefully I will be able to put something out soon.

Credits

The early code for this software would not have been possible without the fantastic work of Sascha Willems and engineer1109 in setting up their own basic cross-platform Vulkan applications. Other packages / frameworks used:

Related

Paperarium Place - An online compendium for papercrafts

License

LGPL

evankirkiles.com  ·  GitHub @evankirkiles