git.sur5r.net Git - fstl/blob - README.md

   1 # fstl
   2
   3 `fstl` is a very fast [.stl file](http://en.wikipedia.org/wiki/STL_\(file_format\)) viewer.
   4
   5 It was originally written by [Matt Keeter](https://mattkeeter.com),
   6 and is now primarily maintained by [@DeveloperPaul123](https://github.com/DeveloperPaul123).
   7
   8 It is designed to quickly load and render very high-polygon models;
   9 showing 2 million triangles at 60+ FPS on a mid-range laptop.
  10
  11 For more details, see the [project page](http://mattkeeter.com/projects/fstl).
  12
  13 Issues and minor pull requests are welcome;
  14 the project is under 1K lines of code and should be fairly approachable.
  15
  16 ## Screenshot
  17
  18 ![Eiffel tower](http://mattkeeter.com/projects/fstl/eiffel.png)
  19 (credit to [Pranav Panchal](https://grabcad.com/pranav.panchal))
  20
  21 ## Setting `fstl` as the Default STL Viewer
  22
  23 ### Windows
  24
  25 1. Right-click an STL file
  26 2. Select `Open With` >>> `Choose another app`
  27 3. Select `More Apps` and `Look for another app on this PC`
  28 4. Enter the path to the `fstl` EXE file
  29
  30 ### MacOS
  31
  32 1. Ctrl+click an STL file
  33 2. Select `Get Info`
  34 3. Navigate to the `Open with` section
  35 4. Select `fstl` in the dropdown
  36 5. Click `Change All`
  37
  38 ### Linux
  39
  40 If `mimeopen` is available on your system, it can be used to set `fstl` as the default viewer for STL files.
  41 Run the following in your terminal:
  42
  43 ```bash
  44 # replace example.stl with an actual file
  45 mimeopen -d example.stl
  46 ```
  47
  48 The following output will result:
  49
  50 ```
  51 Please choose a default application for files of type model/stl
  52
  53         1) Other...
  54
  55 use application #
  56 ```
  57
  58 Select the `Other` option and type `fstl` as the desired command to open STL files.
  59 This will now become the system default, even when opening files from the file manager.
  60
  61 ## Building
  62
  63 The only dependency for `fstl` is [Qt 5](https://www.qt.io),
  64 plus [`cmake`](https://cmake.org/) for building.
  65
  66 ### macOS
  67
  68 Install Qt from their website or [Homebrew](brew.sh).
  69
  70 Install `cmake` through Homebrew or equivalent.
  71
  72 Then, run through the following set of commands in a shell:
  73
  74 ```
  75 git clone https://github.com/fstl-app/fstl
  76 cd fstl
  77 mkdir build
  78 cd build
  79 cmake -DCMAKE_PREFIX_PATH=/usr/local/Cellar/qt/5.15.0/ ..
  80 make -j8
  81 ./fstl.app/Contents/MacOS/fstl
  82 ```
  83
  84 You may need to edit the Qt path depending on your installation.
  85
  86 To package a standalone app, go to the app directory and run `package.sh`
  87
  88 ```
  89 cd ../app
  90 ./package.sh
  91 ```
  92
  93 This should produce two new files in the root directory:
  94 - `fstl.app` is a standalone application that can be copied to `/Applications`
  95 - `fstl.dmg` is a disk image that can be given to a friend
  96
  97 ### Linux
  98
  99 Install Qt with your distro's package manager (required libraries are Core, Gui,
 100 Widgets and OpenGL, e.g. `qt5-default` and `libqt5opengl5-dev` on Debian).
 101
 102 You can build fstl with CMake:
 103 ```
 104 git clone https://github.com/fstl-app/fstl
 105 cd fstl
 106 mkdir build
 107 cd build
 108 cmake ..
 109 make -j8
 110 ./fstl
 111 ```
 112
 113 --------------------------------------------------------------------------------
 114
 115 # License
 116
 117 Copyright (c) 2014-2017 Matthew Keeter
 118
 119 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 120
 121 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 122
 123 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.