Skip to content

Commit

Permalink
chore: bump version & update readme (#57)
Browse files Browse the repository at this point in the history
  • Loading branch information
fgardt authored Jan 18, 2024
1 parent 093f2e6 commit 8779e6b
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Building additional tools might also happen along the way (cli tool to edit `mod
- [`factorio_api`](/factorio_api/): internal factorio mod portal api
- [`locale`](/locale/): locale dump (de)serializing
- [`mod_util`](/mod_util/): mod settings (de)serializing (`.json` and `.dat` files), mod list (de)serializing, property tree (de)serializing (binary format only)
- [`prototypes`](/prototypes/): entity prototype (de)serializing & rendering
- [`prototypes`](/prototypes/): prototype (de)serializing & rendering (supports entities, items, fluids and recipes)
- [`types`](/types/): generic type (de)serializing, sprite loading, layering, merging, ...
- [`serde_helper`](/serde_helper/): util functions for deserialized defaults & serialization skip conditions
- [`scanner`](/scanner/): the actual render tool that connects everything
Expand Down
2 changes: 1 addition & 1 deletion scanner/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "scanner"
version = "0.2.0"
version = "0.3.0"
authors.workspace = true
edition.workspace = true

Expand Down
14 changes: 11 additions & 3 deletions scanner/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Commandline tool to render factorio blueprints with mod support.
## Current limitations

- wires are not rendered
- no alt-mode (so no recipes, inserter arrows, ...)
- very limited "alt-mode" (recipes are supported (without a black background tho), anything else is still missing)
- only blueprints will be rendered (or only the selected blueprint from a book), no upgrade/deconstructon planners

## Setup
Expand Down Expand Up @@ -36,9 +36,13 @@ Options:
--prototype-dump <PROTOTYPE_DUMP>
Path to the data dump json file. If not set, the data will be dumped automatically
--preset <PRESET>
Preset to use [possible values: K2, SE, K2SE]
Preset to use [possible values: K2, SE, K2SE, SeaBlock]
-o, --out <OUT>
Path to the output file
--res <TARGET_RES>
Target resolution (1 side of a square) in pixels [default: 2048]
--min-scale <MIN_SCALE>
Minimum scale to use (below 0.5 makes not much sense, vanilla HR mode is 0.5) [default: 0.5]
-h, --help
Print help
-V, --version
Expand All @@ -55,5 +59,9 @@ Alternatively you can install my [blueprint meta info mod](https://mods.factorio
## TODO

- draw "alt-mode"
- needs recipe / item parsing, loading and rendering
- [x] draw recipes
- [ ] draw inserter arrows
- [ ] draw fluid box arrows
- [ ] draw modules
- [ ] draw filters (splitters, inserters)
- draw wires (copper & circuits)

0 comments on commit 8779e6b

Please sign in to comment.