Snapmaker-luban NPM

Snapmaker Luban

Snapmaker Luban is an easy-to-use 3-in-1 software tailor-made for Snapmaker machines. You can customize the printer settings and control the machine using the command panel in Luban anytime with ease. The software also provides G-code generation support for 3D models, laser engraving / cutting, and CNC milling.

Our goal is to provide a multi-functional 3D software, while making it as accessible and customizable as possible for new users / beginners.

The software is inspired by cncjs by cheton, we also use CuraEngine for 3D slicing.

Features

Desktop applications for macOS, Linux and Windows
Supported controller: Marlin or Marlin-based controllers
3D printing G-code generator
- Multiple models
- Manipulate model (Position / Rotate / Duplicate / Lay Flat)
- Model export and G-code export
- Built-in and custom configurations for slicing
Laser G-code generator
- Multiple models
- Manipulate model (Position / Rotate / Duplicate)
- Model export and G-code export
- Featured modes: B&W, Greyscale, Vector, Text
CNC G-code generator
- Multiple models
- Manipulate model (Position / Rotate / Duplicate)
- Model export and G-code export
- Featured modes: Relief, Vector, Text
- Support Tabs
Snapmaker 2.0 only features
- Wi-Fi controls and file transfer
- Camera Aid Background
Case Library
Multi-Language Support
Keyboard shortcut
Custom Widgets

How to install and run

Use released applications

You can download latest releases of software under the "Releases" section. It's recommended to use a stable release version unless you want to do some modifications on the source code.

Or you can clone this repository, then follow the instructions in "Development" section below.

Development

Setup development environment

Install Node.js 10 (or higher). You can use NVM (Node Version Manager) to install and manage multiple Node.js versions:

> brew install nvm
> nvm install 10
> nvm use 10

Upgrade npm to the latest version:

> npm install npm@latest -g

Install dependencies and start dev server

Use npm to install package dependencies:

> npm install

Start dev server locally:

> npm run dev

Feedback & Contribution

To submit a bug or feature request, file an issue in github issues.
To contribute some code, make sure you have read and followed our guidelines for contributing.