Extension:3D

MediaWiki extensions manual

3D Release status: beta
Implementation	Media
Description	Provides support for 3D file formats.
Author(s)	Gilles Dubuc Matthias Mullie Mark Holmquist
Latest version	0.0.1
Compatibility policy	Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki	>= 1.43
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (GitHub) commit history repository contributors (GitHub) code review
Help	Help:Extension:3D/en
Parameters $wgMax3d2pngMemory $wg3dProcessEnviron $wgAjaxPatentPreview
Hooks used BeforePageDisplay UploadForm:getInitialPageText UploadFormInitDescriptor
Quarterly downloads	97 (Ranked 56th)
Vagrant role	three_d
Issues	Open tasks · Report a bug

The 3D extension gives the user of a wiki support for uploading and viewing 3D models. See Help:Extension:3D for usage documentation.

It currently supports the STL file format, which is common in the 3D printing field.

Installation

Allow 3D file uploads

Tell MediaWiki that it can handle STL uploads. Add this to your LocalSettings.php:

$wgTrustedMediaFormats[] = 'application/sla';
$wgFileExtensions[] = 'stl';

Install Extension:3D

• Download and place the file(s) in a directory called 3D in your extensions/ folder.
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( '3D' );
  

•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Install 3d2png

3d2png is the thumbnail renderer for 3D files. It will render png thumbnails exactly like this extension will display the objects, using the same JS libraries running in Node.js instead of the browser.

To install, clone and activate the 3d2png repository:

git clone https://gerrit.wikimedia.org/r/3d2png
cd 3d2png
npm install

On Linux, you'll also need to install a virtual framebuffer in order for 3d2png to be able to headlessly capture the 3D object.

apt-get install xvfb

After having successfully installed 3d2png, we'll need to tell Extension:3D how to call this thumbnail generator service. Add this to your LocalSettings.php, and make sure to update the paths to match your configuration:

$wg3dProcessor = [
    '/usr/bin/xvfb-run',
    '-a',
    '-s',
    '-ac -screen 0 1280x1024x24',
    '/path-to-your-repository/3d2png.js'
];

Install Extension:MultimediaViewer

MultimediaViewer is not a hard dependency of the 3D extension, but you will need to install it if you want to interact (move, pan, zoom) with the 3D models. After installing MultimediaViewer, you will need to associate the STL file type with the correct viewer extension, by adding this to your LocalSettings.php file:

$wgMediaViewerExtensions['stl'] = 'mmv.3d';

Configuration

Patent agreement

Special:Upload

To add patent agreement selection options to Special:Upload, edit your wiki's MediaWiki:3d-patents page. Every line on that page will be turned into an <option>, where everything after the last | character is the text, and everything before is the template that will be added to the upload content. Check out commons:MediaWiki:3d-patents for an example.

Make sure to create the template(s) that will be added to the content. i.e. Template:3dpatent

Special:UploadWizard

Special:UploadWizard also supports patent agreement, though slightly less flexible. When uploading a third party STL file, a dialog will be displayed to confirm your upload does not infringe any patents. When uploading one of your own, it'll also ask to confirm the 3d objects depicted are your own work. The template added to the upload content will be {{3dpatent}} or {{3dpatent|ownwork}} respectively.

To change the phrasing of these messages, these pages can be altered: MediaWiki:Mwe-upwiz-patent-dialog-text-warranty & MediaWiki:Mwe-upwiz-patent-dialog-text-license.

To change which file types require patent agreement, which template is added to the upload content or where the urls point to, change LocalSettings.php. Below are the default settings:

$wgUploadWizardConfig['patents'] = [
	'extensions' => [ 'stl' ],
	'template' => '3dpatent',
	'url' => [
		'legalcode' => '//wikimediafoundation.org/wiki/Wikimedia_3D_file_patent_license',
		'warranty' => '//meta.wikimedia.org/wiki/Wikilegal/3D_files_and_3D_printing',
		'license' => '//meta.wikimedia.org/wiki/Wikilegal/3D_files_and_3D_printing',
		'weapons' => '//meta.wikimedia.org/wiki/Wikilegal/3D_files_and_3D_printing#Weapons',
	],
];

Extension:CommonsMetadata

Lastly, Extension:CommonsMetadata provides a way to track 3D uploads without said patent license, though it is not configurable at all. It will just check for uploads with a application/sla MIME type (currently the only ones supported by Extension:3D) that lack the 3dpatent template. Matching files lacking this template in their content will automatically be added to Category:Files_with_no_machine-readable_patent.

If you use any other template than 3dpatent, this will not be useful for you, as this is not currently configurable.