-
-
Notifications
You must be signed in to change notification settings - Fork 218
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
34 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,84 +1,54 @@ | ||
<a href="https://dust3d.org" target="_blank"><image src="https://dust3d.org/images/dust3d-logo-wide.png" width="320" height="102"></a> | ||
# Dust3D | ||
|
||
[![appveyor status](https://ci.appveyor.com/api/projects/status/github/huxingyi/dust3d?branch=master&svg=true)](https://ci.appveyor.com/project/huxingyi/dust3d) [![travis status](https://travis-ci.org/huxingyi/dust3d.svg?branch=master)](https://travis-ci.org/huxingyi/dust3d) [![readthedocs status](https://readthedocs.org/projects/dust3d/badge/?version=latest)](https://docs.dust3d.org/en/latest/?badge=latest) [![](https://img.shields.io/twitter/follow/jeremyhu2016.svg?label=%20%40follow&style=social)](https://twitter.com/jeremyhu2016) [![](https://img.shields.io/badge/mailing%20list%20-join-blue.svg)](https://www.freelists.org/list/dust3d) [![](https://img.shields.io/github/downloads/huxingyi/dust3d/total.svg)](https://docs.dust3d.org/en/latest/install.html) | ||
Dust3D is a cross-platform 3D modeling software that makes it easy to create lowpoly 3D models for video games, 3D printing, and more. | ||
|
||
## Getting Started | ||
|
||
Buy me a coffee for staying up late coding :-) [![](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=GHALWLWXYGCU6&item_name=Support+me+coding+in+my+spare+time¤cy_code=AUD&source=url) | ||
These instructions will get you a copy of the Dust3D up and running on your local machine for development and testing purposes. | ||
|
||
Overview | ||
---------- | ||
### Prerequisites | ||
|
||
Dust3D is brand new 3D modeling software. It lets you create watertight 3D models in seconds. Use it to speed up character modeling for games, 3D printing, and so on. | ||
In order to build and run Dust3D, you will need the following software and tools: | ||
|
||
- [Qt](https://www.qt.io/) | ||
- Visual Studio 2019 (Windows only) | ||
- GCC (Linux only) | ||
|
||
<a href="https://blogs.dust3d.org/2019/07/18/dust3d-awarded-epic-megagrants/"><img width="128" height="128" src="https://dust3d.org/images/Epic_MegaGrants_Recipient_logo.png" /></a> | ||
#### Windows | ||
|
||
- [Download Dust3D](https://docs.dust3d.org/en/latest/install.html) | ||
- [Quick Start](https://docs.dust3d.org) | ||
- __[Join Mailing List to get Updated](https://www.freelists.org/list/dust3d)__ | ||
1. Download and install the [Qt Online Installer](https://www.qt.io/download) | ||
2. Run the installer and choose the Qt archives you want to install (required: qtbase, qtsvg) | ||
3. Install Visual Studio 2019 | ||
|
||
Examples | ||
------------- | ||
#### Linux | ||
|
||
<a href="https://github.com/Dust3D-Modeling/10minuteseveryday/tree/master/jeremyhu2016/giraffe"><image src="https://raw.githubusercontent.com/Dust3D-Modeling/10minuteseveryday/master/jeremyhu2016/giraffe/giraffe.png" width="358" height="216"></a> <a href="https://github.com/Dust3D-Modeling/10minuteseveryday/tree/master/jeremyhu2016/honda-monkey"><image src="https://raw.githubusercontent.com/Dust3D-Modeling/10minuteseveryday/master/jeremyhu2016/honda-monkey/honda-monkey.png" width="358" height="216"></a> | ||
1. Install Qt using your distribution's package manager (e.g. `apt-get install qt5-default libqt5svg5-dev` on Ubuntu) | ||
|
||
### Building | ||
|
||
Installation | ||
---------------------- | ||
A step by step series of examples that tell you how to get a development environment running | ||
|
||
Dust3D is available for Windows, macOS, and Linux under the [MIT license](https://github.com/huxingyi/dust3d/blob/master/LICENSE). Its completely free and [open source](#license) | ||
|
||
You can get the <strong><a href="https://github.com/huxingyi/dust3d/releases">latest version</a></strong> in the Releases tab of this GitHub repository. If you're feeling adventurous, you can also <a href="https://docs.dust3d.org/en/latest/builds.html">build from source</a>. | ||
|
||
### Windows | ||
1. Clone the repository | ||
``` | ||
git clone https://github.com/huxingyi/dust3d.git | ||
``` | ||
|
||
[Download the .exe](https://github.com/huxingyi/dust3d/releases) – no installation necessary. | ||
2. Build using qmake | ||
|
||
### macOS | ||
#### Windows | ||
|
||
On macOS, you can download the `.dmg` file or with homebrew: | ||
```sh | ||
brew cask install dust3d | ||
``` | ||
1. Open the Qt Creator IDE | ||
2. Select "Open Project" from the File menu | ||
3. Navigate to the project directory `dust3d/application` and open the `.pro` file | ||
4. Select the desired build configuration (e.g. Debug or Release) from the dropdown menu at the bottom left of the window | ||
5. Click the "Run" button to build and run the project | ||
|
||
### Linux | ||
#### Linux | ||
|
||
[<img width="240" src="https://flathub.org/assets/badges/flathub-badge-i-en.png">](https://flathub.org/apps/details/org.dust3d.dust3d) | ||
1. Change to the project directory `dust3d/application` | ||
2. Run `qmake` to generate a Makefile | ||
3. Build the project using `make` | ||
|
||
We provide a `.AppImage` file in the [releases tab](https://github.com/huxingyi/dust3d/releases): | ||
```sh | ||
chmod a+x ./dust3d-1.0.0-rc.6.AppImage | ||
./dust3d-1.0.0-rc.6.AppImage | ||
``` | ||
## License | ||
|
||
External Links | ||
------------- | ||
- [DUST3D–A NEW OPEN SOURCE 3D MODELLER](http://www.gamefromscratch.com/post/2018/04/20/Dust3D-A-New-Open-Source-3D-Modeller.aspx) **gamefromscratch.com** | ||
- [Dust3D - простая система 3D моделирования для игр](https://www.linux.org.ru/news/opensource/14198146) **linux.org.ru** | ||
- [Бета-выпуск Dust3D, нового открытого пакета для создания 3D-моделей](https://www.opennet.ru/opennews/art.shtml?num=49694) **opennet.ru** | ||
- [Dust3D - ユニークなモデリングフローが印象的な無料の3Dモデリングソフト!Win&Mac&Linux!オープンソース!](https://3dnchu.com/archives/dust3d/) **3dnchu.com** | ||
- [Review: Free and easy 3d modeling with Dust3D](https://magazine.renderosity.com/article/5482/review-free-and-easy-3d-modeling-with-dust3d) **renderosity.com** | ||
- [Get promising free low-poly 3D modeling tool Dust3D](http://www.cgchannel.com/2020/01/get-promising-free-low-poly-3d-modeling-tool-dust3d/) **cgchannel.com** | ||
- [Dust3D, new free modeling tool](https://www.3dvf.com/dust3d-nouvel-outil-de-modelisation-gratuit/) **3dvf.com** | ||
- [Epic MegaGrantsも受賞したオープンソースの無料3Dモデリングソフトウェア「Dust3D」](https://cginterest.com/2020/03/23/epic-megagrants%e3%82%92%e5%8f%97%e8%b3%9e%e3%81%97%e3%81%9f%e3%82%aa%e3%83%bc%e3%83%97%e3%83%b3%e3%82%bd%e3%83%bc%e3%82%b9%e3%81%ae%e7%84%a1%e6%96%993d%e3%83%a2%e3%83%87%e3%83%aa%e3%83%b3%e3%82%b0/) **cginterest.com** | ||
|
||
External Media | ||
------------- | ||
<a href="https://www.youtube.com/watch?v=YBnEQk_5D70" target="_blank"><image src="https://raw.githubusercontent.com/huxingyi/dust3d/master/docs/images/dust3d-free-open-source-3d-modelling-application-video-thumbnail.png" width="480" height="270"></a> | ||
|
||
- [Dust3D -- Free Open Source 3D Modelling Application](https://www.youtube.com/watch?v=YBnEQk_5D70) **gamefromscratch** | ||
- [Dust3D -- Incredibly Unique, Easy and Free Open Source 3D Modeller](https://www.youtube.com/watch?v=MytN8t4guuM&feature=emb_logo) **gamefromscratch** | ||
- [EASILY MAKE 3D MODELS FROM SCRATCH! - WITH THIS FREE OPEN SOURCE TOOL](https://www.youtube.com/watch?v=6hf2yJ8CiW4&feature=youtu.be) **askNK** | ||
- [fastest way to model 3d animals dust 3d](https://www.youtube.com/watch?v=AENQJWwn1HA&feature=youtu.be) **TopChannel1on1** | ||
|
||
Contributing | ||
--------------- | ||
Any contributions are welcome including bugfixes, fixing typos, adding tests, proposing new features, and letting more people know about Dust3D. | ||
|
||
License | ||
----------- | ||
Dust3D's source code is available under the MIT license, however, some third party libraries we use are not MIT license compatible, such as CGAL. You can use the released Dust3D software freely no matter for personal or for commercial purpose, and you can integrate the source code of Dust3D to your project as MIT licensed, but with the third party libraries on the specified license respectively. | ||
|
||
Acknowledgements | ||
------------------- | ||
https://raw.githubusercontent.com/huxingyi/dust3d/master/ACKNOWLEDGEMENTS.html | ||
Dust3D is licensed under the MIT License - see the [LICENSE](https://github.com/huxingyi/dust3d/blob/master/LICENSE) file for details. |