Skip to content

Opinionated desktop tool for packing and bundling STL files the right way

License

Notifications You must be signed in to change notification settings

irongollem/stl-pack

Repository files navigation

stl-pack

GitHub Release GitHub Issues GitHub Stars GitHub Downloads Contributions Welcome Built with Tauri

stl-pack is an opinionated desktop tool for compressing and bundling STL files "the right way". It provides an easy-to-use interface for optimizing your 3D models, ensuring they are efficiently packed and ready for use.

Features

  • Compress STL files to reduce file size without losing quality.
  • Bundle multiple STL files into a single package.
  • User-friendly interface for easy operation.
  • Supports batch processing of multiple files.
  • Cross-platform support (Windows, macOS, Linux).

Installation

To install stl-pack, download the latest release from the releases page and follow the installation instructions for your operating system.

Usage

  1. Open stl-pack.
  2. Add STL files you want to compress or bundle.
  3. Choose your desired compression settings.
  4. Click the "Compress" or "Bundle" button.
  5. Save the optimized files to your desired location.

Our Philosophy

stl-pack is an opinionated tool, and we believe in "the right way" to manage and distribute 3D printable files. This means:

  • Efficiency: Optimizing file sizes without compromising detail, making sharing and storage easier.
  • Organization: Bundling models, metadata, and previews into a clear, structured format (.3pk).
  • Reproducibility: Ensuring that users have all the information needed to understand and use the models.

(Project maintainers: Please expand this section with more specific details about the design choices and goals of stl-pack!)

Recommended IDE Setup for Development

Type Support For .vue Imports in TS

Since TypeScript cannot handle type information for .vue imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in .vue imports (for example to get props validation when using manual h(...) calls), you can enable Volar's Take Over mode by following these steps:

  1. Run Extensions: Show Built-in Extensions from VS Code's command palette, look for TypeScript and JavaScript Language Features, then right click and select Disable (Workspace). By default, Take Over mode will enable itself if the default TypeScript extension is disabled.
  2. Reload the VS Code window by running Developer: Reload Window from the command palette.

You can learn more about Take Over mode here.

Contributing

Contributions are welcome! Please read the contributing guidelines first.

Development Status & Roadmap

stl-pack is under active development! We are constantly working on new features and improvements. You can follow our progress and see planned features in our To-Do List.

License

This project is available under a custom source-available license that allows:

  • Free usage for personal, educational, and commercial purposes
  • Creating and selling content/bundles made with the software

But prohibits:

  • Selling or redistributing the software itself
  • Creating derivative works based on the software

See LICENSE.md for the complete license terms and THIRD_PARTY_NOTICES.md for information about included components.

3pk

STL-Pack generates and in the future consumes an original 3pk file which is a compressed archive containing metadata, licence data and images representing a full release or bundle in a structured format.

About

Opinionated desktop tool for packing and bundling STL files the right way

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •