Skip to content

Commit

Permalink
chore: updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fgardt committed Feb 6, 2025
1 parent db3a12f commit de3e82c
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Factorio-Scanner

> [!NOTE]
> The current main branch contains WIP changes for porting the code to factorio 2.0.
> For the latest 1.1 compatible version see the [`factorio-1.1.109`](https://github.com/fgardt/factorio-scanner/tree/factorio-1.1.109) tag.
Collection of crates that help with deserializing and serializing Factorio blueprint strings, prototype and locale dumps and mod settings.

End goal is to build a blueprint renderer that properly supports blueprints with modded entities by first loading a prototype dump and then rendering the blueprint.
Expand All @@ -11,20 +15,21 @@ Building additional tools might also happen along the way (cli tool to edit `mod
- [`blueprint`](/blueprint/): blueprint string (de)serializing
- [`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/): prototype (de)serializing & rendering (supports entities, items, fluids and recipes)
- [`mod_util`](/mod_util/): mod settings (de)serializing (`.json` and `.dat` files), mod list (de)serializing, dependency resolver, property tree (de)serializing (binary format only)
- [`prototypes`](/prototypes/): prototype (de)serializing & rendering
- [`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
- [`scanner`](/scanner/): the actual rendering tool that connects everything

### Versions

**AT THIS POINT THERE IS NO GUARANTEE ABOUT BREAKING CHANGES.**\
**CONSIDER ALL OF THIS TO BE UNSTABLE!**
> [!WARNING]
> There are no stability guarantees as of now.
> Consider all of this to be unstable!
The prerelease part of the version number for the [`types`](/types/) and [`prototypes`](/prototypes/) crates matches their corresponding factorio version.
The prerelease part of the version number for the [`types`](/types/) and [`prototypes`](/prototypes/) crates matches the corresponding factorio version they target.

Since the other crates are either only documented on the wiki (for example [blueprint string format](https://wiki.factorio.com/Blueprint_string_format) and [mod settings](https://wiki.factorio.com/Tutorial:Mod_settings) [file format](https://wiki.factorio.com/Mod_settings_file_format)) or not explicitly documented at all there is no factorio engine version to use for these crates.
Since the other parts are either only documented on the wiki (for example [blueprint string format](https://wiki.factorio.com/Blueprint_string_format) and [mod settings](https://wiki.factorio.com/Tutorial:Mod_settings) [file format](https://wiki.factorio.com/Mod_settings_file_format)) or not explicitly documented at all there is no factorio engine version to use for these crates.

## Scanner

Expand Down
2 changes: 2 additions & 0 deletions mod_util/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
- **Mod settings** (de)serialization
- `mod-settings-dump.json` as well as `mod-settings.dat`
- **Mod list** (de)serialization
- **Accessing mod files** either as zips or folders
- **Dependency solver**
- **Property Tree** (de)serialization (binary format only)

### https://wiki.factorio.com/Tutorial:Mod_settings
Expand Down

0 comments on commit de3e82c

Please sign in to comment.