blockbench/README.md

51 lines
2.4 KiB
Markdown
Raw Normal View History

2021-06-14 21:00:42 +08:00
# Blockbench
2017-06-08 20:39:12 +08:00
Blockbench is a free, modern model editor for low-poly and boxy 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.
2020-10-31 02:11:21 +08:00
Blockbench features a modern and intuitive UI, plugin support and innovative features. It is the industry standard for creating custom 3D models for the Minecraft Marketplace.
2020-03-11 05:19:17 +08:00
Website and download: [blockbench.net](https://www.blockbench.net)
2019-07-18 00:02:07 +08:00
2020-10-31 02:11:21 +08:00
2021-06-18 03:38:46 +08:00
![Interface](https://web.blockbench.net/content/front_page_app.png)
2020-10-31 02:11:21 +08:00
2020-03-11 05:19:17 +08:00
## Contribution
2021-06-14 21:00:42 +08:00
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](code_of_conduct.md)
If you are contributing to Blockbench in any way, you must adhere to the [Code of Conduct](https://github.com/JannisX11/blockbench/blob/master/CODE_OF_CONDUCT.MD).
* To submit a suggestion or report a bug, please [open an issue](https://github.com/JannisX11/blockbench/issues/new).
* If you want to contribute to the Blockbench code, please contact me on [Discord](https://discord.gg/sGkj78W) before.
* If you want to contribute Blockbench translations, you can visit [blockbench.net/translations](https://blockbench.net/translations/). Thank you!
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`
* Finally, launch Blockbench using
`npm run dev`
2020-03-11 05:19:17 +08:00
## Plugins
2020-10-31 02:11:21 +08:00
Blockbench supports Javascript-based plugins. Learn more about creating plugins on [https://documentation.blockbench.net](https://documentation.blockbench.net).
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.
2021-06-14 21:00:42 +08:00
* All assets created with Blockbench (models, textures, animations, screenshots etc.) are your own!