Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emanuelescarabattoli/xstl
Xstl, a free and open-source STL viewer
https://github.com/emanuelescarabattoli/xstl
3d 3dprinting file-viewer stl stl-files stl-viewer stl-visualiser
Last synced: 10 days ago
JSON representation
Xstl, a free and open-source STL viewer
- Host: GitHub
- URL: https://github.com/emanuelescarabattoli/xstl
- Owner: emanuelescarabattoli
- License: mit
- Created: 2023-04-20T17:20:15.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-10-04T20:04:02.000Z (about 1 year ago)
- Last Synced: 2024-04-20T14:43:32.247Z (7 months ago)
- Topics: 3d, 3dprinting, file-viewer, stl, stl-files, stl-viewer, stl-visualiser
- Language: JavaScript
- Homepage: https://emanuelescarabattoli.github.io/xstl/index.html
- Size: 1.44 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Xstl, a free and open-source STL viewer
Xstl is a free and open-source STL viewer for Linux and Windows, build with modern tools, Electron and React. With Xstl you can open an STL file and navigate trough a directory to see all the STL files on it, buy using buttons or with a shortcut (`alt+z` and `alt+x`). The default view is isometric, so you can see all the details of your model.
## Settings and customization
By changing the default settings you can visualized your model in different colors. The bed is configurable/switchable too.
## Install
To install Xstl, check the releases page https://github.com/emanuelescarabattoli/xstl/releases
## Set as default program
To set Xstl as default STL files viewer on Windows:
- Double-click on a `.stl` file
- Select "Open with another program"
- Navigate to `C:\Users\\AppData\Local\Programs\Xstl` folder
- Select `Xstl.exe`
To set Xstl as default STL files viewer on Linux:
- Double-click on a `.stl` file
- In the window that will open, search for "Xstl" and select it
## Build instructions
Here the instructions to build the project:
- Change the version in `./xstl/wrapper/package.json`, if you want to perform a release
- Navigate to xtl code folder, wrapper sub-directory
```
cd ./xstl/wrapper
```
- Install packages using yarn
```
yarn install
```
- To build deb package
```
yarn build-deb
```
- To build AppImage package
```
yarn build-app-image
```
- To build Windows setup package
```
yarn build-win
```
## Local setup
To run the project locally, after cloning it, do the following
- Open a terminal, navigate to the frontend directory and install dependencies using yarn
```
cd frontned
yarn install
```
- Run the React project
```
yarn start
```
- You can close the browser tab that will open up
- In another terminal, navigate to the electron application directory and install dependencies using yarn
```
cd wrapper
yarn install
```
- Run the project
```
yarn start
```
- Now the application is running locally
## Contribute
Feel free yo contribute to this project here https://github.com/emanuelescarabattoli/xstl/pulls or open an issue here https://github.com/emanuelescarabattoli/xstl/issues
## License
Licensed under the MIT license.