/fbpviewer

Factorio Blueprint Viewer

Primary LanguageJavaScript

Factorio Blueprint Viewer (fbpviewer)

A TypeScript version of the original fbpviewer from https://github.com/trakos/fbpviewer, created by @trakos. All credits to him for doing all the hard groundwork. Unfortunately he didn't like TS and so I'm continuing my TS conversion. I plan to eventually extend it with new features once there is a solid foundation.

Contributions welcome! Take a look and see if there is something interesting to do for you...

Live version of the original version available here: http://fbpviewer.trakos.pl/

Live version of this fork: Coming soon...

Development

You need to have node.js installed, then it's as simple as:

npm install
npm run dev

You only need to execute npm install once initially and after package updates (defined as dependencies in package.json). Then open a browser and visit http://localhost:8080/web (browser will automatically refresh on file change)

I suggest VS Code for the best TypeScript development experience.

You also have to have spritesheet generated. The best way is to simply download it from http://fbpviewer.trakos.pl/ (both spritesheet.json and spritesheet.png) and put it in /web/images.

You could also use the script at bin/dev_atlasgen.sh to generate it yourself, but it requires you to copy most of the factorio images to web/images/factorio first.

License

Everything that is not directly related to Factorio is MIT-licensed, as in 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:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

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.