Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 3.06 KB

README.md

File metadata and controls

64 lines (45 loc) · 3.06 KB
Raw

daxfb-calculator

Calculator/Factory Planner for factory management games.

This project was initially developed as calculator/factory planner for Evospace game. Later it turned out this project is quite universal and could be used for other factory management games.

Builds for currently supported games

Common startup page for all games

https://doubleaxe.github.io/daxfb-calculator/

Direct links for specific games

Game Calculator link
Sample https://doubleaxe.github.io/daxfb-calculator/?gameId=sample
Evospace https://doubleaxe.github.io/daxfb-calculator/?gameId=evospace
Captain of Industry https://doubleaxe.github.io/daxfb-calculator/?gameId=coi

How to use

Help is available as separate page https://doubleaxe.github.io/daxfb-calculator/docs/. Help sources are located inside docs folder in this repository.

Building

  • Install node.js version 18 or later.
  • Install pnpm with npm install -g pnpm.
  • Perform pnpm install.
  • Run npm run build.

If type/validation errors arise, project can be built without type checking

  • Run npm run build-data.
  • Run npm run build-docs.
  • Run npm run build-only.

Debugging

  • Run npm run dev.

Offline usage

Released packages can be downloaded from 'release' page or self-built. Then it is possible to just open index.html included in release archive locally in browser. It is impossible now to just open file in modern browsers, "thanks" to new CORS policy for file:// protocol. Http server (or old browser) is now required to run locally, all built files can be just placed on http server directory. The only remote dependency is https://polyfill.io/ which is used to make it work inside unsupported browsers. Query string ?gameId=<game> may be added to quickly open desired game, for example daxfb-calculator/dist/index.html?gameId=evospace.

If project was built from repository, it can be run locally after building with npm run preview.

TODO list

  • Allow manual editing mode without auto-solver, check graph is balanced and show results
  • Group by custom category, group by building type for CoI
  • Multiselect / Move multi-selected factories
  • Cut / Copy / Paste individual and multi-selected factories, also global Copy / Paste for importing one into another.
  • Undo / Redo
  • Use \R\N for Windows saved files instead of \N
  • Use https://github.com/bcakmakoglu/vue-flow/ for nicer graph display? (will require almost full rewrite)
  • Use https://github.com/d0sboots/dyson-sphere-program, https://github.com/Martin-Pitt/dsp-parser/ https://github.com/xunyinzhe/dsp-calculator/tree/gh-pages/icons
  • Use https://github.com/greeny/SatisfactoryTools/blob/dev/bin/parseDocs.ts