Quality Glassware

A set of flask graphics assets for mods to use in Factorio.

.gitignore

@@ -0,0 +1 @@
+bin

LICENSE.txt

@@ -0,0 +1,428 @@
+Attribution-ShareAlike 4.0 International
+
+=======================================================================
+
+Creative Commons Corporation ("Creative Commons") is not a law firm and
+does not provide legal services or legal advice. Distribution of
+Creative Commons public licenses does not create a lawyer-client or
+other relationship. Creative Commons makes its licenses and related
+information available on an "as-is" basis. Creative Commons gives no
+warranties regarding its licenses, any material licensed under their
+terms and conditions, or any related information. Creative Commons
+disclaims all liability for damages resulting from their use to the
+fullest extent possible.
+
+Using Creative Commons Public Licenses
+
+Creative Commons public licenses provide a standard set of terms and
+conditions that creators and other rights holders may use to share
+original works of authorship and other material subject to copyright
+and certain other rights specified in the public license below. The
+following considerations are for informational purposes only, are not
+exhaustive, and do not form part of our licenses.
+
+     Considerations for licensors: Our public licenses are
+     intended for use by those authorized to give the public
+     permission to use material in ways otherwise restricted by
+     copyright and certain other rights. Our licenses are
+     irrevocable. Licensors should read and understand the terms
+     and conditions of the license they choose before applying it.
+     Licensors should also secure all rights necessary before
+     applying our licenses so that the public can reuse the
+     material as expected. Licensors should clearly mark any
+     material not subject to the license. This includes other CC-
+     licensed material, or material used under an exception or
+     limitation to copyright. More considerations for licensors:
+    wiki.creativecommons.org/Considerations_for_licensors
+
+     Considerations for the public: By using one of our public
+     licenses, a licensor grants the public permission to use the
+     licensed material under specified terms and conditions. If
+     the licensor's permission is not necessary for any reason--for
+     example, because of any applicable exception or limitation to
+     copyright--then that use is not regulated by the license. Our
+     licenses grant only permissions under copyright and certain
+     other rights that a licensor has authority to grant. Use of
+     the licensed material may still be restricted for other
+     reasons, including because others have copyright or other
+     rights in the material. A licensor may make special requests,
+     such as asking that all changes be marked or described.
+     Although not required by our licenses, you are encouraged to
+     respect those requests where reasonable. More considerations
+     for the public:
+    wiki.creativecommons.org/Considerations_for_licensees
+
+=======================================================================
+
+Creative Commons Attribution-ShareAlike 4.0 International Public
+License
+
+By exercising the Licensed Rights (defined below), You accept and agree
+to be bound by the terms and conditions of this Creative Commons
+Attribution-ShareAlike 4.0 International Public License ("Public
+License"). To the extent this Public License may be interpreted as a
+contract, You are granted the Licensed Rights in consideration of Your
+acceptance of these terms and conditions, and the Licensor grants You
+such rights in consideration of benefits the Licensor receives from
+making the Licensed Material available under these terms and
+conditions.
+
+
+Section 1 -- Definitions.
+
+  a. Adapted Material means material subject to Copyright and Similar
+     Rights that is derived from or based upon the Licensed Material
+     and in which the Licensed Material is translated, altered,
+     arranged, transformed, or otherwise modified in a manner requiring
+     permission under the Copyright and Similar Rights held by the
+     Licensor. For purposes of this Public License, where the Licensed
+     Material is a musical work, performance, or sound recording,
+     Adapted Material is always produced where the Licensed Material is
+     synched in timed relation with a moving image.
+
+  b. Adapter's License means the license You apply to Your Copyright
+     and Similar Rights in Your contributions to Adapted Material in
+     accordance with the terms and conditions of this Public License.
+
+  c. BY-SA Compatible License means a license listed at
+     creativecommons.org/compatiblelicenses, approved by Creative
+     Commons as essentially the equivalent of this Public License.
+
+  d. Copyright and Similar Rights means copyright and/or similar rights
+     closely related to copyright including, without limitation,
+     performance, broadcast, sound recording, and Sui Generis Database
+     Rights, without regard to how the rights are labeled or
+     categorized. For purposes of this Public License, the rights
+     specified in Section 2(b)(1)-(2) are not Copyright and Similar
+     Rights.
+
+  e. Effective Technological Measures means those measures that, in the
+     absence of proper authority, may not be circumvented under laws
+     fulfilling obligations under Article 11 of the WIPO Copyright
+     Treaty adopted on December 20, 1996, and/or similar international
+     agreements.
+
+  f. Exceptions and Limitations means fair use, fair dealing, and/or
+     any other exception or limitation to Copyright and Similar Rights
+     that applies to Your use of the Licensed Material.
+
+  g. License Elements means the license attributes listed in the name
+     of a Creative Commons Public License. The License Elements of this
+     Public License are Attribution and ShareAlike.
+
+  h. Licensed Material means the artistic or literary work, database,
+     or other material to which the Licensor applied this Public
+     License.
+
+  i. Licensed Rights means the rights granted to You subject to the
+     terms and conditions of this Public License, which are limited to
+     all Copyright and Similar Rights that apply to Your use of the
+     Licensed Material and that the Licensor has authority to license.
+
+  j. Licensor means the individual(s) or entity(ies) granting rights
+     under this Public License.
+
+  k. Share means to provide material to the public by any means or
+     process that requires permission under the Licensed Rights, such
+     as reproduction, public display, public performance, distribution,
+     dissemination, communication, or importation, and to make material
+     available to the public including in ways that members of the
+     public may access the material from a place and at a time
+     individually chosen by them.
+
+  l. Sui Generis Database Rights means rights other than copyright
+     resulting from Directive 96/9/EC of the European Parliament and of
+     the Council of 11 March 1996 on the legal protection of databases,
+     as amended and/or succeeded, as well as other essentially
+     equivalent rights anywhere in the world.
+
+  m. You means the individual or entity exercising the Licensed Rights
+     under this Public License. Your has a corresponding meaning.
+
+
+Section 2 -- Scope.
+
+  a. License grant.
+
+       1. Subject to the terms and conditions of this Public License,
+          the Licensor hereby grants You a worldwide, royalty-free,
+          non-sublicensable, non-exclusive, irrevocable license to
+          exercise the Licensed Rights in the Licensed Material to:
+
+            a. reproduce and Share the Licensed Material, in whole or
+               in part; and
+
+            b. produce, reproduce, and Share Adapted Material.
+
+       2. Exceptions and Limitations. For the avoidance of doubt, where
+          Exceptions and Limitations apply to Your use, this Public
+          License does not apply, and You do not need to comply with
+          its terms and conditions.
+
+       3. Term. The term of this Public License is specified in Section
+          6(a).
+
+       4. Media and formats; technical modifications allowed. The
+          Licensor authorizes You to exercise the Licensed Rights in
+          all media and formats whether now known or hereafter created,
+          and to make technical modifications necessary to do so. The
+          Licensor waives and/or agrees not to assert any right or
+          authority to forbid You from making technical modifications
+          necessary to exercise the Licensed Rights, including
+          technical modifications necessary to circumvent Effective
+          Technological Measures. For purposes of this Public License,
+          simply making modifications authorized by this Section 2(a)
+          (4) never produces Adapted Material.
+
+       5. Downstream recipients.
+
+            a. Offer from the Licensor -- Licensed Material. Every
+               recipient of the Licensed Material automatically
+               receives an offer from the Licensor to exercise the
+               Licensed Rights under the terms and conditions of this
+               Public License.
+
+            b. Additional offer from the Licensor -- Adapted Material.
+               Every recipient of Adapted Material from You
+               automatically receives an offer from the Licensor to
+               exercise the Licensed Rights in the Adapted Material
+               under the conditions of the Adapter's License You apply.
+
+            c. No downstream restrictions. You may not offer or impose
+               any additional or different terms or conditions on, or
+               apply any Effective Technological Measures to, the
+               Licensed Material if doing so restricts exercise of the
+               Licensed Rights by any recipient of the Licensed
+               Material.
+
+       6. No endorsement. Nothing in this Public License constitutes or
+          may be construed as permission to assert or imply that You
+          are, or that Your use of the Licensed Material is, connected
+          with, or sponsored, endorsed, or granted official status by,
+          the Licensor or others designated to receive attribution as
+          provided in Section 3(a)(1)(A)(i).
+
+  b. Other rights.
+
+       1. Moral rights, such as the right of integrity, are not
+          licensed under this Public License, nor are publicity,
+          privacy, and/or other similar personality rights; however, to
+          the extent possible, the Licensor waives and/or agrees not to
+          assert any such rights held by the Licensor to the limited
+          extent necessary to allow You to exercise the Licensed
+          Rights, but not otherwise.
+
+       2. Patent and trademark rights are not licensed under this
+          Public License.
+
+       3. To the extent possible, the Licensor waives any right to
+          collect royalties from You for the exercise of the Licensed
+          Rights, whether directly or through a collecting society
+          under any voluntary or waivable statutory or compulsory
+          licensing scheme. In all other cases the Licensor expressly
+          reserves any right to collect such royalties.
+
+
+Section 3 -- License Conditions.
+
+Your exercise of the Licensed Rights is expressly made subject to the
+following conditions.
+
+  a. Attribution.
+
+       1. If You Share the Licensed Material (including in modified
+          form), You must:
+
+            a. retain the following if it is supplied by the Licensor
+               with the Licensed Material:
+
+                 i. identification of the creator(s) of the Licensed
+                    Material and any others designated to receive
+                    attribution, in any reasonable manner requested by
+                    the Licensor (including by pseudonym if
+                    designated);
+
+                ii. a copyright notice;
+
+               iii. a notice that refers to this Public License;
+
+                iv. a notice that refers to the disclaimer of
+                    warranties;
+
+                 v. a URI or hyperlink to the Licensed Material to the
+                    extent reasonably practicable;
+
+            b. indicate if You modified the Licensed Material and
+               retain an indication of any previous modifications; and
+
+            c. indicate the Licensed Material is licensed under this
+               Public License, and include the text of, or the URI or
+               hyperlink to, this Public License.
+
+       2. You may satisfy the conditions in Section 3(a)(1) in any
+          reasonable manner based on the medium, means, and context in
+          which You Share the Licensed Material. For example, it may be
+          reasonable to satisfy the conditions by providing a URI or
+          hyperlink to a resource that includes the required
+          information.
+
+       3. If requested by the Licensor, You must remove any of the
+          information required by Section 3(a)(1)(A) to the extent
+          reasonably practicable.
+
+  b. ShareAlike.
+
+     In addition to the conditions in Section 3(a), if You Share
+     Adapted Material You produce, the following conditions also apply.
+
+       1. The Adapter's License You apply must be a Creative Commons
+          license with the same License Elements, this version or
+          later, or a BY-SA Compatible License.
+
+       2. You must include the text of, or the URI or hyperlink to, the
+          Adapter's License You apply. You may satisfy this condition
+          in any reasonable manner based on the medium, means, and
+          context in which You Share Adapted Material.
+
+       3. You may not offer or impose any additional or different terms
+          or conditions on, or apply any Effective Technological
+          Measures to, Adapted Material that restrict exercise of the
+          rights granted under the Adapter's License You apply.
+
+
+Section 4 -- Sui Generis Database Rights.
+
+Where the Licensed Rights include Sui Generis Database Rights that
+apply to Your use of the Licensed Material:
+
+  a. for the avoidance of doubt, Section 2(a)(1) grants You the right
+     to extract, reuse, reproduce, and Share all or a substantial
+     portion of the contents of the database;
+
+  b. if You include all or a substantial portion of the database
+     contents in a database in which You have Sui Generis Database
+     Rights, then the database in which You have Sui Generis Database
+     Rights (but not its individual contents) is Adapted Material,
+     including for purposes of Section 3(b); and
+
+  c. You must comply with the conditions in Section 3(a) if You Share
+     all or a substantial portion of the contents of the database.
+
+For the avoidance of doubt, this Section 4 supplements and does not
+replace Your obligations under this Public License where the Licensed
+Rights include other Copyright and Similar Rights.
+
+
+Section 5 -- Disclaimer of Warranties and Limitation of Liability.
+
+  a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
+     EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
+     AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
+     ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
+     IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
+     WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
+     PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
+     ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
+     KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
+     ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
+
+  b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
+     TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
+     NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
+     INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
+     COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
+     USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
+     ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
+     DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
+     IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
+
+  c. The disclaimer of warranties and limitation of liability provided
+     above shall be interpreted in a manner that, to the extent
+     possible, most closely approximates an absolute disclaimer and
+     waiver of all liability.
+
+
+Section 6 -- Term and Termination.
+
+  a. This Public License applies for the term of the Copyright and
+     Similar Rights licensed here. However, if You fail to comply with
+     this Public License, then Your rights under this Public License
+     terminate automatically.
+
+  b. Where Your right to use the Licensed Material has terminated under
+     Section 6(a), it reinstates:
+
+       1. automatically as of the date the violation is cured, provided
+          it is cured within 30 days of Your discovery of the
+          violation; or
+
+       2. upon express reinstatement by the Licensor.
+
+     For the avoidance of doubt, this Section 6(b) does not affect any
+     right the Licensor may have to seek remedies for Your violations
+     of this Public License.
+
+  c. For the avoidance of doubt, the Licensor may also offer the
+     Licensed Material under separate terms or conditions or stop
+     distributing the Licensed Material at any time; however, doing so
+     will not terminate this Public License.
+
+  d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
+     License.
+
+
+Section 7 -- Other Terms and Conditions.
+
+  a. The Licensor shall not be bound by any additional or different
+     terms or conditions communicated by You unless expressly agreed.
+
+  b. Any arrangements, understandings, or agreements regarding the
+     Licensed Material not stated herein are separate from and
+     independent of the terms and conditions of this Public License.
+
+
+Section 8 -- Interpretation.
+
+  a. For the avoidance of doubt, this Public License does not, and
+     shall not be interpreted to, reduce, limit, restrict, or impose
+     conditions on any use of the Licensed Material that could lawfully
+     be made without permission under this Public License.
+
+  b. To the extent possible, if any provision of this Public License is
+     deemed unenforceable, it shall be automatically reformed to the
+     minimum extent necessary to make it enforceable. If the provision
+     cannot be reformed, it shall be severed from this Public License
+     without affecting the enforceability of the remaining terms and
+     conditions.
+
+  c. No term or condition of this Public License will be waived and no
+     failure to comply consented to unless expressly agreed to by the
+     Licensor.
+
+  d. Nothing in this Public License constitutes or may be interpreted
+     as a limitation upon, or waiver of, any privileges and immunities
+     that apply to the Licensor or You, including from the legal
+     processes of any jurisdiction or authority.
+
+
+=======================================================================
+
+Creative Commons is not a party to its public
+licenses. Notwithstanding, Creative Commons may elect to apply one of
+its public licenses to material it publishes and in those instances
+will be considered the “Licensor.” The text of the Creative Commons
+public licenses is dedicated to the public domain under the CC0 Public
+Domain Dedication. Except for the limited purpose of indicating that
+material is shared under a Creative Commons public license or as
+otherwise permitted by the Creative Commons policies published at
+creativecommons.org/policies, Creative Commons does not authorize the
+use of the trademark "Creative Commons" or any other trademark or logo
+of Creative Commons without its prior written consent including,
+without limitation, in connection with any unauthorized modifications
+to any of its public licenses or any other arrangements,
+understandings, or agreements concerning use of licensed material. For
+the avoidance of doubt, this paragraph does not form part of the
+public licenses.
+
+Creative Commons may be contacted at creativecommons.org.
+

oxipng.cmd

@@ -0,0 +1,2 @@
+bin\oxipng -o 4 --strip safe --alpha src\graphics\technology\*.png
+bin\oxipng -o 4 --strip safe --alpha src\graphics\icons\*.png

render.cmd

@@ -0,0 +1,2 @@
+REM Pass the path to blender as the first argument
+%1 --background --python-exit-code 1 model.blend --python render.py

render.py

@@ -0,0 +1,119 @@
+import bpy
+import os
+
+base_path = "src/graphics/technology"
+
+base_collection = bpy.data.scenes["Scene"].view_layers["Base"].layer_collection
+shadows_collection = bpy.data.scenes["Scene"].view_layers["Shadows"].layer_collection
+
+def set_exclude(model, value):
+	base_collection.children[model].exclude = value
+	shadows_collection.children[model].exclude = value
+
+def set_color(model, variant, values):
+	for obj in base_collection.children[model].collection.all_objects.values():
+		if obj.data.name == "Floor":
+			obj.hide_render = False
+		if "liquid_color" not in obj:
+			continue
+		obj["liquid_color"][0] = values[0]
+		obj["liquid_color"][1] = values[1]
+		obj["liquid_color"][2] = values[2]
+		obj.update_tag()
+		glass = "glass_frozen" if variant == "frozen" else "glass_no_back_grime"
+		obj.material_slots[0].material = bpy.data.materials[glass]
+		obj.material_slots[1].material = bpy.data.materials[f"liquid_clear_surface"]
+		obj.material_slots[2].material = bpy.data.materials[f"liquid_clear_glass"]
+
+def set_empty(model, variant):
+	for obj in base_collection.children[model].collection.all_objects.values():
+		if obj.data.name == "Floor":
+			obj.hide_render = True
+		if "liquid_color" not in obj:
+			continue
+		glass = "glass_frozen" if variant == "frozen" else "glass_no_back_grime"
+		obj.material_slots[0].material = bpy.data.materials[glass]
+		obj.material_slots[1].material = bpy.data.materials[f"transparent"]
+		obj.material_slots[2].material = bpy.data.materials[f"glass_inside"]
+			
+
+def render_bottle(color, variant, model, output):
+	set_exclude(model, False)
+	if color != "empty":
+		set_color(model, variant, colors[color])
+	else:
+		set_empty(model, variant)
+	bpy.data.scenes["Scene"].render.filepath = output
+	bpy.ops.render.render(write_still=True)
+	set_exclude(model, True)
+
+models = [
+	"cone_normal",
+	"cone_slim",
+	"cone_inverted",
+	"cylinder",
+	"tube_one",
+	"tube_two",
+	"tube_three",
+	"sphere_normal",
+	"sphere_tiny",
+	"sphere_double",
+	"sphere_tubed",
+	"sphere_hemi",
+	"sphere_spiked",
+	"hourglass",
+	"torus",
+	"klein",
+	"pyramid",
+	"cube",
+	"triangle",
+	"triangle_alt",
+	"pentagon",
+	"hexagon",
+]
+
+colors = {
+	"red": [0.554, 0.044, 0.046],
+	"green": [0.075, 0.573, 0.075],
+	"black": [0.050, 0.050, 0.050], 
+	"cyan": [0.066, 0.430, 0.592],
+	"purple": [0.233, 0.039, 0.372],
+	"yellow": [0.536, 0.402, 0.000],
+	"white": [0.515, 0.534, 0.555],
+	"orange": [0.644, 0.277, 0.012],
+	"pink": [0.557, 0.043, 0.433],
+	"blue": [0.038, 0.050, 0.606],
+	"lime": [0.523, 0.570, 0.000],
+	"empty": None,
+}
+
+
+# Code to render all types
+bottles = []
+for model in models:
+	bottles.append(["empty", "clear", model, f"//{base_path}/{model}_empty.png"])
+	variants = ["clear"]
+	if model == "cone_normal":
+		variants.append("frozen")
+	for variant in variants:
+		for color in colors:
+			if color == "empty":
+				continue
+			bottles.append([color, variant, model, f"//{base_path}/{model}_{variant}_{color}.png"])
+
+# Code for prototyping speedup
+#bpy.data.scenes["Scene"].cycles.samples = 1024
+
+# Reset visibility of all bottles
+for model in models:
+	set_exclude(model, True)
+
+# Render the bottles
+for color, variant, model, output in bottles:
+	# Code to only render files that don't exist
+	#if os.path.exists(bpy.path.abspath(output)): continue
+
+	print("Rendering", output)
+	render_bottle(color, variant, model, output)
+
+print("Done!")

resize.cmd

@@ -0,0 +1,5 @@
+@ECHO off
+FOR /R src\graphics\technology %%F IN (*) DO (
+    ECHO graphics\technology\%%~nF%%~xF
+    magick "src\graphics\technology\%%~nF%%~xF" -unsharp 5x1+4 -resize "25%%" "src\graphics\icons\%%~nF%%~xF"
+)

src/data.lua

@@ -0,0 +1,256 @@
+local meld = require("meld")
+local designs = require("designs")
+
+quality_glassware = quality_glassware or {}
+
+---Get properties suitable for putting into an item prototype to display a given flask variant.
+---
+---**Example**
+---```lua
+---meld(
+---    data.raw["tool"]["automation-science-pack"],
+---    quality_glassware.item_graphics_for(variant, meld),
+--- )
+----- get icon layer for composing
+---local layer = quality_glassware.item_graphics_for(variant)
+---```
+---@param variant Variant The variant of flask to provide the graphics for.
+---@param meld any? The meld library obtain from `require("meld")`, if passed the output contains a meld directives to remove the icons property.
+---@return table
+function quality_glassware.item_graphics_for(variant, meld)
+	local graphics = {
+		icon_size = 64,
+		icon = "__quality_glassware__/graphics/icons/" .. variant.model .. "_" .. variant.name:gsub("liquid", "clear") .. ".png",
+	}
+	if meld then
+		graphics.icons = meld.delete()
+	end
+	return graphics
+end
+
+---Get properties suitable for putting into an technology prototype to display a given flask variant.
+---
+---**Example**
+---```lua
+----- update a prototype
+---meld(
+---    data.raw["technology"]["automation-science-pack"],
+---    quality_glassware.technology_graphics_for(variant, meld),
+--- )
+----- get icon layer for composing
+---local layer = quality_glassware.technology_graphics_for(variant)
+---```
+---@param variant Variant The variant of flask to provide the graphics for.
+---@param meld any? The meld library obtain from `require("meld")`, if passed the output contains a meld directives to remove the icons property.
+---@return { icon_size: number, icon: string, icons: any? }
+function quality_glassware.technology_graphics_for(variant, meld)
+	local graphics = {
+		icon_size = 256,
+		icon = "__quality_glassware__/graphics/technology/" .. variant.model .. "_" .. variant.name:gsub("liquid", "clear") .. ".png",
+	}
+	if meld then
+		graphics.icons = meld.delete()
+	end
+	return graphics
+end
+
+---@alias Request { model: ModelId?, variant: VariantName?, contents: QGContents? } A request for a given glassware.
+
+---(Advanced usage) Try a request to see what variant it results in
+---
+---Allows you to check what a request would result in before passing it to
+---[request_flask](lua://quality_glassware.request_flask).
+---
+---Note that this does not account for id already being assigned or overriden, to check that
+---see [get_flask](lua://quality_glassware.get_flask). If the return value is nil it means the next
+---request in the chain would get checked.
+---
+---@param request Request the request to try.
+---@return Variant? variant the resolved variant, or nil if the request could not be satisfied.
+function quality_glassware.try_request(request)
+	if request.model and request.variant then
+		local variant =
+			designs.models[request.model]
+			and designs.models[request.model].variants[request.variant]
+		if not variant or variant.assigned_to then
+			return nil
+		end
+		return variant
+	end
+
+	if request.model then
+		local model = designs.models[request.model]
+		if not model then
+			return nil
+		end
+		for _, variant in pairs(model.variants) do
+			if variant.contents == (request.contents or "liquid") and not variant.assigned_to then
+				return variant
+			end
+		end
+		return nil
+	end
+
+	if request.variant then
+		for _, model in pairs(designs.models) do
+			local variant = model.variants[request.variant]
+			if variant and not variant.assigned_to then
+				return variant
+			end
+		end
+		return nil
+	end
+
+	for _, model in pairs(designs.models) do
+		for _, variant in pairs(model.variants) do
+			if variant.contents == (request.contents or "liquid") and not variant.assigned_to then
+				return variant
+			end
+		end
+	end
+	return nil
+end
+
+local assigned_variants = {}
+---Get design associated with a given id
+---@param id string String previously passed to [request_flask](lua://quality_glassware.request_flask)
+---@return Variant? variant The design associated with the given id, if any.
+function quality_glassware.get_flask(id)
+	return assigned_variants[id]
+end
+
+local overrides = settings.startup.quality_glassware_overrides.value
+if overrides ~= "" then
+	for override in overrides:gmatch("[^,]+") do
+		id, model, variant = override:match("^ *([^=/ ,]+)=([^/ ,]+)/([^ ,]+) *$")
+		if not id or not model or not variant then
+			log(string.format("Failed to parse override '%s', expected format is id=model/variant", override))
+		elseif not designs.models[model] then
+			log(string.format("Failed apply override %s: Model '%s' does not exist", override, model))
+		elseif not designs.models[model].variants[variant] then
+			log(string.format("Failed apply override %s: Model '%s' does not have variant '%s'", override, model, variant))
+		else
+			log(string.format("Quality Glassware overriding %s=%s/%s", id, model, variant))
+			assigned_variants[id] = designs.models[model].variants[variant]
+			assigned_variants[id].assigned_to = id
+		end
+	end
+end
+
+---Request a unique flask design for use in a mod
+---
+---Interface to reserve a unique flask design for a mod to use based on an array of requests that specificy what kind of design is acceptable.
+---Each request is table that can contain the following three properties all of which are optional
+---- model [ModelId](lua://ModelId): kind of flask to get.
+---- variant [VariantName](lua://VariantName): variant to get. For example clear red liquid is "liquid_red", an empty flask is "empty".
+---- contents [QGContents](lua://QGContents): Contents the bottle should have. Defaults to "liquid" and is ignored if variant is present.
+---
+---The requests are tried in order until one of them finds design that haven't already been taken.
+---If no requests succeed a design is picked at random as a fallback so that the game will still load.
+---The design picked is then associated with the id passed so subsequent calls to request_flask with the same id will always give the same result.
+---Note that if the flask design have been overridden by the quality_glassware_overrides startup config then that design will be returned instead.
+---
+---**Example**
+---```lua
+---local variant = quality_glassware.request_flask(
+---    "my-science-pack",
+---    {
+---        { model = "cone_normal", variant = "liquid_red" }, -- Try a conical red flask
+---        { model = "sphere_normal", variant = "liquid_red" }, -- If that's taken try a sphereical red flask.
+---        { variant = "liquid_red" }, -- If that's also taken, try any red flask.
+---    }
+---)
+----- Pass variant to icon_graphics_for or technology_graphics_for to get icon paths that can be rendered.
+---```
+---
+---@param id string The prototype id to request a flask for. This is used for overrides and avoiding duplicates.
+---@param requests table<number, Request> Array of requests to evaluate. First request to succeed is returned.
+---@return Variant variant The flask variant the request resulted in.
+---
+function quality_glassware.request_flask(id, requests)
+	if assigned_variants[id] then
+		return assigned_variants[id]
+	end
+
+	local variant
+	if requests then
+		for _, request in pairs(requests) do
+			variant = quality_glassware.try_request(request)
+			if variant then
+				break
+			end
+		end
+	end
+
+	-- If all requests fail give something so the game loads
+	local fallback = ""
+	if not variant then
+		variant = quality_glassware.try_request({})
+		fallback = " (fallback)"
+		if not variant then
+			-- There's over 200 variants, how did you run out?
+			error("quality_glassware has no available variants left!")
+		end
+	end
+
+	log(string.format("Quality Glassware assigned %s=%s/%s%s", id, variant.model, variant.name, fallback))
+	variant.assigned_to = id
+	assigned_variants[id] = variant
+	return variant
+end
+
+local function create_debug_prototypes(variant, index)
+	local model = variant.model
+	local name = "qw-debug-" .. model .. "-" .. variant.name
+	data:extend{
+		meld(
+			{
+				type = "item",
+				name = name,
+				localised_name = {
+					"quality_glassware.glassware_" .. variant.contents,
+					{"quality_glassware." .. (variant.color or "invalid")},
+					{"quality_glassware." .. variant.model},
+				},
+				order = string.format("a[%s]%02i", model, index),
+				stack_size = 10,
+			},
+			quality_glassware.item_graphics_for(variant)
+		),
+		meld(
+			{
+				type = "technology",
+				name = name,
+				localised_name = {
+					"quality_glassware.glassware_" .. variant.contents,
+					{"quality_glassware." .. (variant.color or "invalid")},
+					{"quality_glassware." .. variant.model},
+				},
+				order = string.format("a[%s]%02i", model, index),
+				unit = {
+					time = 30,
+					count = 1,
+					ingredients = {{name, 1}},
+				}
+			},
+			quality_glassware.technology_graphics_for(variant)
+		)
+	}
+	local lab_inputs = data.raw.lab.lab.inputs
+	lab_inputs[#lab_inputs + 1] = name
+end
+
+if settings.startup.quality_glassware_create_debug_prototypes.value then
+	for _, model in pairs(designs.models) do
+		local index = 0
+		for _, variant in pairs(model.variants) do
+			create_debug_prototypes(variant, index)
+			index = index + 1
+		end
+	end
+end
+
+-- For advanced usage
+quality_glassware.models = designs.models
+quality_glassware.colors = designs.colors
+quality_glassware.contents = designs.contents

src/designs.lua

@@ -0,0 +1,171 @@
+local lib = require("lib")
+
+---@alias QGColor
+---| "red"
+---| "green"
+---| "black"
+---| "cyan"
+---| "purple"
+---| "yellow"
+---| "white"
+---| "orange"
+---| "pink"
+---| "blue"
+---| "lime"
+---Color of the contents of a flask
+
+---@type table<number, QGColor>
+local colors = {
+	"red",
+	"green",
+	"black",
+	"cyan",
+	"purple",
+	"yellow",
+	"white",
+	"orange",
+	"pink",
+	"blue",
+	"lime",
+}
+
+---@alias QGContents
+---| "empty"
+---| "liquid"
+---| "frozen"
+---Contents of a flask
+
+---@type table<number, QGContents>
+local contents = {
+	"empty",
+	"liquid",
+	"frozen",
+}
+
+---@alias VariantName
+---| "empty"
+---| "liquid_red"
+---| "liquid_green"
+---| "liquid_black"
+---| "liquid_cyan"
+---| "liquid_purple"
+---| "liquid_yellow"
+---| "liquid_white"
+---| "liquid_orange"
+---| "liquid_pink"
+---| "liquid_blue"
+---| "liquid_lime"
+---| "frozen_red"
+---| "frozen_green"
+---| "frozen_black"
+---| "frozen_cyan"
+---| "frozen_purple"
+---| "frozen_yellow"
+---| "frozen_white"
+---| "frozen_orange"
+---| "frozen_pink"
+---| "frozen_blue"
+---| "frozen_lime"
+
+---@alias ModelId
+---| "cone_normal"
+---| "cone_slim"
+---| "cone_inverted"
+---| "cylinder"
+---| "tube_one"
+---| "tube_two"
+---| "tube_three"
+---| "sphere_normal"
+---| "sphere_tiny"
+---| "sphere_double"
+---| "sphere_tubed"
+---| "sphere_hemi"
+---| "sphere_spiked"
+---| "hourglass"
+---| "torus"
+---| "klein"
+---| "pyramid"
+---| "cube"
+---| "triangle"
+---| "triangle_alt"
+---| "pentagon"
+---| "hexagon" 
+---Identifier for a model of flask.
+
+---@type table<number, ModelId>
+local base_models = {
+	"cone_normal",
+	"cone_slim",
+	"cone_inverted",
+	"cylinder",
+	"tube_one",
+	"tube_two",
+	"tube_three",
+	"sphere_normal",
+	"sphere_tiny",
+	"sphere_double",
+	"sphere_tubed",
+	"sphere_hemi",
+	"sphere_spiked",
+	"hourglass",
+	"torus",
+	"klein",
+	"pyramid",
+	"cube",
+	"triangle",
+	"triangle_alt",
+	"pentagon",
+	"hexagon",
+}
+
+---@type table<number, ModelId>
+local frozen_models = {
+	"cone_normal",
+}
+
+---@alias Variant { name: VariantName, model: ModelId, color: QGColor?, contents: QGContents, assigned_to: string?  }
+---A variant of a flask
+
+---@alias Model { name: ModelId, variants: table<VariantName, Variant>  }
+
+---@type table<ModelId, Model>
+---Table of all flask models and their variants provided by Quality Glassware
+local models = {}
+for _, model in ipairs(base_models) do
+	---@type table<VariantName, Variant>
+	local variants = {
+		empty = {
+			name = "empty",
+			model = model,
+			contents = "empty"
+		}
+	}
+	for _, color in ipairs(colors) do
+		variants["liquid_" .. color] = {
+			name = "liquid_" .. color,
+			model = model,
+			color = color,
+			contents = "liquid"
+		}
+	end
+	if lib.contains(frozen_models, model) then
+		for _, color in ipairs(colors) do
+			variants["frozen_" .. color] = {
+				model = model,
+				name = "frozen_" .. color,
+				color = color,
+				contents = "frozen"
+			}
+		end
+	end
+	models[model] = {
+		name = model,
+		variants = variants,
+	}
+end
+
+return {
+	models = models,
+	colors = colors,
+	contents = contents,
+}