https://github.com/danielesteban/softxels-viewer
https://github.com/danielesteban/softxels-viewer
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/danielesteban/softxels-viewer
- Owner: danielesteban
- License: mit
- Created: 2022-06-13T02:35:56.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-07-05T07:45:04.000Z (about 4 years ago)
- Last Synced: 2025-04-02T18:54:48.111Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://softxels-viewer.gatunes.com
- Size: 3.58 MB
- Stars: 9
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
softxels-viewer
==
[](https://softxels-viewer.gatunes.com/)
### Generate worlds from pointclouds
Use [softxels-voxelizer](https://github.com/danielesteban/softxels/tree/master/voxelizer) to create a world from a PLY. Then just drag & drop the BIN over the viewer window.
```bash
npm install -g softxels-voxelizer
softxels-voxelizer -i "input.ply" -o "output.bin"
```
### Dev environment
```bash
# clone this repo
git clone https://github.com/danielesteban/softxels-viewer.git
cd softxels-viewer
# install dev dependencies
npm install
# start the dev environment:
npm start
# open http://localhost:8080/ in your browser
```
### Build with custom config
By default, it will use [config.dev.js](config.dev.js) & [config.prod.js](config.prod.js) but you can also specify your own:
```js
/* myconfig.js */
export default {
autoUpdateRenderRadius: false, // Enables loading/unloading of chunks as the camera moves.
enableDragAndDrop: false, // Enables/Disables Drag & Drop of world files.
initialWorldURL: false, // URL of a world file to be initially loaded (or false for none).
renderRadius: 10, // Radius around the camera that chunks are loaded when autoUpdateRenderRadius is enabled.
worldMenu: [ // Displays a menu to load worlds
{ name: 'Example', url: 'https://example.com/world.bin' },
],
};
```
```bash
# start a dev environment with that config
CONFIG=/path/to/myconfig.js npm run start
# or just build a production bundle with that config
CONFIG=/path/to/myconfig.js npm run build
```