OpenSCAD - Revision history

Xoconoch at 17:31, 13 September 2026

2026-09-13T17:31:15Z

← Older revision		Revision as of 17:31, 13 September 2026
Line 51:		Line 51:
	Some libraries like [https://github.com/JustinSDK/dotSCAD dotSCAD] or [https://github.com/rcolyer/threads-scad threads.scad] are designed to be installed in the root of the path where OpenSCAD searches for files. That is, they are meant to be called as <code>use threads.scad</code>. This introduces namespace conflict problems, so libraries like this are packaged in a way such that you must call them as <code>use dotSCAD/example.scad</code> or similar, which may differ from what upstream documentation will look like.		Some libraries like [https://github.com/JustinSDK/dotSCAD dotSCAD] or [https://github.com/rcolyer/threads-scad threads.scad] are designed to be installed in the root of the path where OpenSCAD searches for files. That is, they are meant to be called as <code>use threads.scad</code>. This introduces namespace conflict problems, so libraries like this are packaged in a way such that you must call them as <code>use dotSCAD/example.scad</code> or similar, which may differ from what upstream documentation will look like.

	In general terms, the root of each installed library is determined by the <code>libName</code> attribute of its package which we as maintainers try and make the best effort to set to a logical name. This may not be always the case, so in order to know the value of that attribute for a given library, you may run this command:<syntaxhighlight lang="bash">nix eval --expr '(import <nixpkgs> {}).openscadPackages.bosl2.libName' --raw --impure</syntaxhighlight>or with the legacy cli:<syntaxhighlight lang="bash">		In general terms, the root of each installed library is determined by the <code>libName</code> attribute of its package which we as maintainers try and make the best effort to set to a logical name (usually the name of the project's repository). This may not be always the case, so in order to know the value of that attribute for a given library, you may run this command:<syntaxhighlight lang="bash">nix eval --expr '(import <nixpkgs> {}).openscadPackages.bosl2.libName' --raw --impure</syntaxhighlight>or with the legacy cli:<syntaxhighlight lang="bash">
	nix-instantiate --eval --expr '(import <nixpkgs> {}).openscadPackages.bosl2.libName'		nix-instantiate --eval --expr '(import <nixpkgs> {}).openscadPackages.bosl2.libName'
	</syntaxhighlight>Or if none of that works, you can always check the package's source code.		</syntaxhighlight>Or if none of that works, you can always check the package's source code.

Xoconoch at 17:30, 13 September 2026

2026-09-13T17:30:34Z

← Older revision		Revision as of 17:30, 13 September 2026
Line 49:		Line 49:

	== Namespace conflicting libraries ==		== Namespace conflicting libraries ==
	Some libraries like [https://github.com/JustinSDK/dotSCAD dotSCAD] or [https://github.com/rcolyer/threads-scad threads.scad] are designed to be installed in the root of the path where OpenSCAD searches for files. That is, they are meant to be called as <code>use threads.scad</code>. This introduces namespace conflict problems, so libraries like this are packaged in a way such that you must call ~~the libraries~~ as <code>use dotSCAD/example.scad</code> or similar, which may differ from what upstream documentation will look like.		Some libraries like [https://github.com/JustinSDK/dotSCAD dotSCAD] or [https://github.com/rcolyer/threads-scad threads.scad] are designed to be installed in the root of the path where OpenSCAD searches for files. That is, they are meant to be called as <code>use threads.scad</code>. This introduces namespace conflict problems, so libraries like this are packaged in a way such that you must call them as <code>use dotSCAD/example.scad</code> or similar, which may differ from what upstream documentation will look like.

	In general terms, the root of each installed library is determined by the <code>libName</code> attribute of its package which we as maintainers try and make the best effort to set to a logical name. This may not be always the case, so in order to know the value of that attribute for a given library, you may run this command:<syntaxhighlight lang="bash">nix eval --expr '(import <nixpkgs> {}).openscadPackages.bosl2.libName' --raw --impure</syntaxhighlight>or with the legacy cli:<syntaxhighlight lang="bash">		In general terms, the root of each installed library is determined by the <code>libName</code> attribute of its package which we as maintainers try and make the best effort to set to a logical name. This may not be always the case, so in order to know the value of that attribute for a given library, you may run this command:<syntaxhighlight lang="bash">nix eval --expr '(import <nixpkgs> {}).openscadPackages.bosl2.libName' --raw --impure</syntaxhighlight>or with the legacy cli:<syntaxhighlight lang="bash">
	nix-instantiate --eval --expr '(import <nixpkgs> {}).openscadPackages.bosl2.libName'		nix-instantiate --eval --expr '(import <nixpkgs> {}).openscadPackages.bosl2.libName'
	</syntaxhighlight>Or if none of that works, you can always check the package's source code.		</syntaxhighlight>Or if none of that works, you can always check the package's source code.

Xoconoch: /* Via flake.nix (recommended) */

2026-09-06T16:21:38Z

Via flake.nix (recommended)

← Older revision		Revision as of 16:21, 6 September 2026
Line 4:		Line 4:
	It is possible to create development envrionemtns with pinned version of OpenSCAD and the libraries you may want to use in your models. There are a number of different ways to do it, but the important part is to recognize that the OpenSCAD package exposes a <code>.withPackages</code> function which works analogously to the one exposed by the Python package.		It is possible to create development envrionemtns with pinned version of OpenSCAD and the libraries you may want to use in your models. There are a number of different ways to do it, but the important part is to recognize that the OpenSCAD package exposes a <code>.withPackages</code> function which works analogously to the one exposed by the Python package.

	In simple terms, to make <code><library></code> available to our OpenSCAD installation, we declare the package as <code>(openscad.withPackages (ps: [ ps.<library>]))</code>.		In simple terms, to make <code><library></code> available to our OpenSCAD installation, we declare the package as <code>(pkgs.openscad.withPackages (ps: [ ps.<library>]))</code>.

	See some examples of it being used.		See some examples of it being used.
Line 26:		Line 26:
	{		{
	devShells.${system}.default = pkgs.mkShell {		devShells.${system}.default = pkgs.mkShell {
	packages = [		packages = with pkgs; [
	# We pass a callable which returns a list of packages		# We pass a callable which returns a list of packages
	(~~pkgs.~~openscad.withPackages (ps: [		(openscad.withPackages (ps: [
	ps.bosl2		ps.bosl2
	]))		]))

Xoconoch: Namespace conflicting libraries

2026-09-06T16:18:44Z

Namespace conflicting libraries

← Older revision		Revision as of 16:18, 6 September 2026
Line 2:		Line 2:

	== OpenSCAD development environments with Nix ==		== OpenSCAD development environments with Nix ==
	It is possible to create development envrionemtns with pinned version of OpenSCAD and the libraries you may want to use in your models. There are a number of different ways to do it.		It is possible to create development envrionemtns with pinned version of OpenSCAD and the libraries you may want to use in your models. There are a number of different ways to do it, but the important part is to recognize that the OpenSCAD package exposes a <code>.withPackages</code> function which works analogously to the one exposed by the Python package.

			In simple terms, to make <code><library></code> available to our OpenSCAD installation, we declare the package as <code>(openscad.withPackages (ps: [ ps.<library>]))</code>.

			See some examples of it being used.

	=== Via <code>flake.nix</code> (recommended) ===		=== Via <code>flake.nix</code> (recommended) ===
	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">{
	{
	description = "A very basic OpenSCAD devshell";		description = "A very basic OpenSCAD devshell";

Line 24:		Line 27:
	devShells.${system}.default = pkgs.mkShell {		devShells.${system}.default = pkgs.mkShell {
	packages = [		packages = [
			# We pass a callable which returns a list of packages
	(pkgs.openscad.withPackages (ps: [		(pkgs.openscad.withPackages (ps: [
	ps.bosl2		ps.bosl2
Line 30:		Line 34:
	};		};
	};		};
	}		}</syntaxhighlight>

	</syntaxhighlight>

	=== Via <code>shell.nix</code> ===		=== Via <code>shell.nix</code> ===
Line 42:		Line 44:
	pkgs.mkShell {		pkgs.mkShell {
	buildInputs = [		buildInputs = [
	(pkgs~~.openscadPackages~~.openscad.withPackages (ps: [ ps.bosl2 ]))		(pkgs.openscad.withPackages (ps: [ ps.bosl2 ]))
	];		];
	}</syntaxhighlight>		}</syntaxhighlight>

			== Namespace conflicting libraries ==
			Some libraries like [https://github.com/JustinSDK/dotSCAD dotSCAD] or [https://github.com/rcolyer/threads-scad threads.scad] are designed to be installed in the root of the path where OpenSCAD searches for files. That is, they are meant to be called as <code>use threads.scad</code>. This introduces namespace conflict problems, so libraries like this are packaged in a way such that you must call the libraries as <code>use dotSCAD/example.scad</code> or similar, which may differ from what upstream documentation will look like.

			In general terms, the root of each installed library is determined by the <code>libName</code> attribute of its package which we as maintainers try and make the best effort to set to a logical name. This may not be always the case, so in order to know the value of that attribute for a given library, you may run this command:<syntaxhighlight lang="bash">nix eval --expr '(import <nixpkgs> {}).openscadPackages.bosl2.libName' --raw --impure</syntaxhighlight>or with the legacy cli:<syntaxhighlight lang="bash">
			nix-instantiate --eval --expr '(import <nixpkgs> {}).openscadPackages.bosl2.libName'
			</syntaxhighlight>Or if none of that works, you can always check the package's source code.

Xoconoch: Add examples

2026-09-06T15:54:54Z

Add examples

← Older revision		Revision as of 15:54, 6 September 2026
Line 1:		Line 1:
	OpenSCAD is a software for creating solid 3D CAD objects.		OpenSCAD is a software for creating solid 3D CAD objects.

			== OpenSCAD development environments with Nix ==
			It is possible to create development envrionemtns with pinned version of OpenSCAD and the libraries you may want to use in your models. There are a number of different ways to do it.

			=== Via <code>flake.nix</code> (recommended) ===
			<syntaxhighlight lang="nix">
			{
			description = "A very basic OpenSCAD devshell";

			inputs = {
			nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
			};

			outputs =
			{ self, nixpkgs }:
			let
			system = "x86_64-linux";
			pkgs = import nixpkgs {
			inherit system;
			};
			in
			{
			devShells.${system}.default = pkgs.mkShell {
			packages = [
			(pkgs.openscad.withPackages (ps: [
			ps.bosl2
			]))
			];
			};
			};
			}

			</syntaxhighlight>

			=== Via <code>shell.nix</code> ===
			<syntaxhighlight lang="nix">let
			# We pin to a specific nixpkgs commit for reproducibility.
			# Last updated: 2026-09-06. Check for new commits at https://status.nixos.org.
			pkgs = import (fetchTarball "https://github.com/NixOS/nixpkgs/archive/17de0b976395537756f30a3e78f2f06e5cec89ed.tar.gz") {};
			in
			pkgs.mkShell {
			buildInputs = [
			(pkgs.openscadPackages.openscad.withPackages (ps: [ ps.bosl2 ]))
			];
			}</syntaxhighlight>

Xoconoch: Created page with "OpenSCAD is a software for creating solid 3D CAD objects."

2026-09-06T15:31:45Z

Created page with "OpenSCAD is a software for creating solid 3D CAD objects."

New page

OpenSCAD is a software for creating solid 3D CAD objects.