From 64f6feb4ccaa04fdf05f0a5090442f6fc3860a6c Mon Sep 17 00:00:00 2001 From: Sebastian Andersson Date: Sat, 1 Feb 2025 10:17:47 +0100 Subject: [PATCH 1/2] Fix link for REUSE badge --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 91c1009..679f529 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ SPDX-FileCopyrightText: 2024 Sebastian Andersson SPDX-License-Identifier: GPL-3.0-or-later --> -[![REUSE status](https://api.reuse.software/badge/github.com/bofh69/nfc2klipper)](https://api.reuse.software/info/github.com/bofh69/spoolman2slicer) +[![REUSE status](https://api.reuse.software/badge/github.com/bofh69/spoolman2slicer)](https://api.reuse.software/info/github.com/bofh69/spoolman2slicer) ![GitHub Workflow Status](https://github.com/bofh69/spoolman2slicer/actions/workflows/pylint.yml/badge.svg) # Spoolman to slicer config generator From 79c1b6b409d1a52d60a49fcdc1a7821b2bbcc422 Mon Sep 17 00:00:00 2001 From: Sebastian Andersson Date: Sat, 1 Feb 2025 10:17:59 +0100 Subject: [PATCH 2/2] Improve the README text --- README.md | 45 +++++++++++++++++++++++++++++++++++++++------ 1 file changed, 39 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 679f529..6aa68e5 100644 --- a/README.md +++ b/README.md @@ -8,18 +8,51 @@ SPDX-License-Identifier: GPL-3.0-or-later ![GitHub Workflow Status](https://github.com/bofh69/spoolman2slicer/actions/workflows/pylint.yml/badge.svg) # Spoolman to slicer config generator -Create slicer filament configuration files from the spools in -[Spoolman](https://github.com/Donkie/Spoolman). -My templates are included for: -* [OrcaSlicer](https://github.com/SoftFever/OrcaSlicer) -* [SuperSlicer](https://github.com/supermerill/SuperSlicer) +## Intro -They are easy to update with your settings. +A python program to create filament configurations in +[OrcaSlicer](https://github.com/SoftFever/OrcaSlicer) +and +[SuperSlicer](https://github.com/supermerill/SuperSlicer) +from the active spools in [Spoolman](https://github.com/Donkie/Spoolman)'s database.' +It could easily be extended to support more slicers. + +The filament configuration files are based on templates. My templates +are included in the repo, but you should make your own based on your +settings. See below for how to do that. + + + +## The workflow + +You add your spools' manufacturers, filaments and the spools to Spoolman. + +For each filament that has at least one active spool, spoolman2slicer creates a +filament configuration. + +The next time you start the slicer you will see the available filaments. + +My templates contain a "filament_start_gcode" command, `ASSERT_ACTIVE_FILAMENT ID={{id}}`, +which comes from +[this file](https://github.com/bofh69/nfc2klipper/blob/v0.0.4/klipper-spoolman.cfg) in +my other repo, [nfc2klipper](https://github.com/bofh69/nfc2klipper). +It will run whenever the print starts to use that filament. + +That macro checks that the `active_filament` variable is the same as the choosen filament. + +The `active_filament` variable is set by first calling `SET_ACTIVE_FILAMENT ID=` and the id. +That is called automatically by nfc2klipper. + +There is a Moonraker agent [spool2slicer](https://github.com/bofh69/spool2slicer) +that can be used to update the active_filament variable whenever the spool is changed +in moonraker (via frontends, code macros) etc. + ## Usage