Skip to content

How to Add a New Design to LimbForge

Jump to bottom
Kaitlyn Hova edited this page May 21, 2016 · 27 revisions

Flow

  1. Fork the repo by clicking the "Fork" button at the top right of the page and select your personal repo.

  2. Once everything is copied over, make the following changes on your fork on your local environment.

  3. Once these changes are complete, test following the instructions on the LimbForge README.

  4. If everything checks out, submit a pull request and assign to Andreas Bastian to merge your changes into the gh-pages branch of LimbForge!

Requirements for Integration into LimbForge

[coming soon]

How to get a new design set up in LimbForge:

  1. Step One: Modify "designs.json" to include an entry for the new design:
{
    "designs": [
        {
            "name": "Raptor Reloaded",
            "directory": "STLs/RR/"
        },
        {
       	 "name":  "Thumbless RR (BETA)",
       	 "directory":  "STLs/TLRR/"
        },
        {
        	"name":  "my_awesome_new_design",
        	"directory":  "STLs/my_awesome_new_design/"
        }
    ]
}
  1. Step Two: Make a directory in "STLs" for the new design This directory should include the following:
  • manifest.json -- This file what LimbForge uses to create the download package, so make sure that quantities and handedness are correct. Add and modify as many parts to the parts list as are necessary to populate the design.
   {
   "description": "Enter as many parts as you want in this list. Available substitution variables are designName (RR), size (100), and handedness (left or right). In addition, whole parts can be excluded from an assembly by specifying the handedness here. The handedness string will be searched for the hand the user has requested (left or right), and if a match is found the part will be included. So ambidextrous parts can be labeled 'left right' to be included in all hands, and 'handed' parts can include only left or right in the handedness string",
   "displayModel": "[your_awesome_left_handed_display_model_at_100_percent].stl",
   "parts": [
       {
           "qty": [qty],
           "name": "[partName]",
           "handedness": "left right",
           "file_dir_template": "[designName_partName]/",
           "file_name_template": "[designName_qty_partName_]<%= size %>_percent.stl"
       },
   }

  • display_model_100_percent.STL -- This should be an STL for the left configuration of the device and should be less than 1mb for fast loading times. You can name it whatever you would like so long as it matches "displayModel" in manifest.json.

  • docs -- should contain:

  • readme.txt -- This should contain links to printing and assembly documentation and version/change log info - license.txt -- This is the open source license for the design and is left to the designer to decide. - Directories for each part file with part sizes 100-150 at 5% increments. Make sure each file name contains the size.

  1. Step Three: Test! Following the instructions on the top level of the LimbForge repo, test locally in the browser to verify that every size populates properly

  2. Step Four: Document! Document the assembly of the device with photos and text. Check out the assembly instructions for the Raptor Reloaded for guidance.

  3. Step Five: Pull Request! If everything checks out and documentation is complete, submit a pull request for the rest of the team to review and independently test across a wider range of machines and browsers. If everything checks out, your design will be merged into the production LimbForge for everybody to use!

Clone this wiki locally