blockbench/README.md

# Blockbench

Blockbench is a free and open source model editor for low-poly models with pixel art textures.
Models can be exported into standardized formats, to be shared, rendered, 3D-printed, or used in game engines. There are also multiple dedicated formats for Minecraft Java and Bedrock Edition with format-specific features. 

Blockbench features a modern and beginner friendly interface, but also offers lots of customization and advanced features for experienced 3D artists. Plugins can extend the functionality of the program even further.

Website and download: [blockbench.net](https://www.blockbench.net)


![Interface](https://web.blockbench.net/content/front_page_app.png)


## Contribution

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](CODE_OF_CONDUCT.MD)

Check out the [Contribution Guidelines](CONTRIBUTING.md).


## Launching Blockbench

To launch Blockbench from source, you can clone the repository, navigate to the correct branch and launch the program in development mode using the instructions below. If you just want to use the latest version, please download the app from the website.

* Install [NodeJS](https://nodejs.org/en/).
* Then install all dependencies via
`npm install`
* Bundle the code via
`npm run bundle`
* Finally, launch Blockbench using
`npm run dev`


## Plugins

Blockbench supports Javascript-based plugins. Learn more about creating plugins on [https://www.blockbench.net/wiki/docs/plugin](https://www.blockbench.net/wiki/docs/plugin).


## License

* The Blockbench source-code is licensed under the GPL license version 3. See `LICENSE.MD`.
* Modifications to the source code can be made under the terms of that license.
* Blockbench plugins (external scripts) and themes (theme files to customize the design) that interact with the Blockbench API are an exception. Plugins and themes can be created and/or published as open source, proprietary or paid software.
* All assets created with Blockbench (models, textures, animations, screenshots etc.) are your own!
Include Code of Conduct 2021-06-14 21:00:42 +08:00			`# Blockbench`
Create README.md 2017-06-08 20:39:12 +08:00
Update Readme 2025-01-22 03:30:27 +08:00			`Blockbench is a free and open source model editor for low-poly models with pixel art textures.`
Add custom theme restore button Fix copy paste tool Add Sketchfab categories Fix #1054 Fix #1067 Start menu bottom graphic icon offset Fix template generator face rotation accuracy Update meta data [ci-build] 2021-09-24 03:35:36 +08:00			`Models can be exported into standardized formats, to be shared, rendered, 3D-printed, or used in game engines. There are also multiple dedicated formats for Minecraft Java and Bedrock Edition with format-specific features.`
Update README [ci skip] 2020-10-31 02:11:21 +08:00
Update Readme 2025-01-22 03:30:27 +08:00			`Blockbench features a modern and beginner friendly interface, but also offers lots of customization and advanced features for experienced 3D artists. Plugins can extend the functionality of the program even further.`
Update README [ci skip] 2020-10-31 02:11:21 +08:00
3.4.1 2020-03-11 05:19:17 +08:00			`Website and download: [blockbench.net](https://www.blockbench.net)`
v3.0.0 2019-07-18 00:02:07 +08:00
Update README [ci skip] 2020-10-31 02:11:21 +08:00
Update README image link 2021-06-18 03:38:46 +08:00			`![Interface](https://web.blockbench.net/content/front_page_app.png)`
Update README [ci skip] 2020-10-31 02:11:21 +08:00

3.4.1 2020-03-11 05:19:17 +08:00
			`## Contribution`

Fix broken link 2022-09-14 05:45:58 +08:00			`[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](CODE_OF_CONDUCT.MD)`
Include Code of Conduct 2021-06-14 21:00:42 +08:00
Update contribution guidelines 2023-02-23 02:29:36 +08:00			`Check out the [Contribution Guidelines](CONTRIBUTING.md).`
Update README [ci skip] 2020-10-31 02:11:21 +08:00


			`## Launching Blockbench`

			`To launch Blockbench from source, you can clone the repository, navigate to the correct branch and launch the program in development mode using the instructions below. If you just want to use the latest version, please download the app from the website.`

			`* Install [NodeJS](https://nodejs.org/en/).`
			`* Then install all dependencies via`
			`npm install`
Update Readme 2025-01-22 03:30:27 +08:00			`* Bundle the code via`
			`npm run bundle`
Update README [ci skip] 2020-10-31 02:11:21 +08:00			`* Finally, launch Blockbench using`
			`npm run dev`


3.4.1 2020-03-11 05:19:17 +08:00
			`## Plugins`

Update Readme 2025-01-22 03:30:27 +08:00			`Blockbench supports Javascript-based plugins. Learn more about creating plugins on [https://www.blockbench.net/wiki/docs/plugin](https://www.blockbench.net/wiki/docs/plugin).`
Specify license for plugin API 2021-02-14 19:50:54 +08:00


			`## License`

			* The Blockbench source-code is licensed under the GPL license version 3. See `LICENSE.MD`.
			`* Modifications to the source code can be made under the terms of that license.`
			`* Blockbench plugins (external scripts) and themes (theme files to customize the design) that interact with the Blockbench API are an exception. Plugins and themes can be created and/or published as open source, proprietary or paid software.`
Include Code of Conduct 2021-06-14 21:00:42 +08:00			`* All assets created with Blockbench (models, textures, animations, screenshots etc.) are your own!`