Skip to content

jgphilpott/polymorph

Repository files navigation

Intro

Polymorph is a JavaScript based 3D modeling software that uses three.js and csg.js in the background. It can export STL and OBJ files to be used for 3D printing. The project also works in combination with a personal Things repository that can be used to store your own models and designs without polluting the software.

Setup

  1. Clone this repository to you local device with the command git clone https://github.com/jgphilpott/polymorph.git.

  2. Optionally create or clone a Things repository in the same location with the command mkdir things or git clone https://github.com/<USERNAME>/things.git. You can also do this step later but you will need to rebuild your docker container.

  3. Assuming you have docker compose installed, navigate into the Polymorph repository and run docker-compose up --build. The build will take some time but once it’s done you can view the application by visiting localhost:4000 in a web browser. In future deployments you can simply use the command docker-compose up.

Usage

To create/view a 3D model you will need to add a polygen function to one of the root files in the scripts directory. You can either create a new function from scratch or copy and paste from one of the Things.

Once you see the desired model in the view you can use Ctrl + Enter to download it as an STL file or Shift + Enter to download it as an OBJ file. You can use any software you like to slice the STL/OBJ files but Cura is recommended.

If you have any problems with the software or an idea for a new feature please open an issue, thanks!

Connect & Share

I'd love to see all the things you create with Polymorph so please connect and share! I have used this software for all of my personal 3D models, you can view and download my creations on several different websites listed here: