Skip to content

Commit 93aea8e

Browse files
committed
Adds instructions for Exporter and release 2.0.0
1 parent 3539b89 commit 93aea8e

File tree

1 file changed

+66
-24
lines changed

1 file changed

+66
-24
lines changed

README.md

Lines changed: 66 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,94 @@
11
# Sketchfab plugin for Unreal Engine
22

3-
*Unreal plugin for Windows to browse and import models from Sketchfab.*
3+
**Unreal plugin Windows to export and import models to and from Sketchfab**
44

5-
*Please note that a Sketchfab account is required to download models, and that animation import is not yet supported.*
5+
Latest releases:
66

7-
Supported versions:
8-
9-
* [Release for 4.26](https://github.com/sketchfab/unreal-plugin/releases/tag/4.26-1.3.0)
10-
* [Release for 4.25](https://github.com/sketchfab/unreal-plugin/releases/tag/4.25-1.3.0)
7+
* [Release for 4.26](https://github.com/sketchfab/unreal-plugin/releases/tag/4.26-2.0.0)
8+
* [Release for 4.25](https://github.com/sketchfab/unreal-plugin/releases/tag/4.25-2.0.0)
119
* [Release for 4.21](https://github.com/sketchfab/unreal-plugin/releases/tag/4.21-1.1.1)
1210
* [Release for 4.20](https://github.com/sketchfab/unreal-plugin/releases/tag/4.20-1.1.1)
1311
* [Release for 4.19](https://github.com/sketchfab/unreal-plugin/releases/tag/4.19-1.1.1)
1412

15-
### Installation
13+
Please note that the exporter is only available in the releases for Unreal Engine 4.25 and 4.26.
14+
15+
16+
## Installation
1617

17-
Download the `.zip` attached to the [release matching your UE version](https://github.com/sketchfab/unreal-plugin/releases) and unzip it into a new plugin folder in your project directory.
18+
Download the **.zip** attached to the [release matching your UE version](https://github.com/sketchfab/unreal-plugin/releases) and unzip it into a new plugin folder in your project directory.
1819

19-
If you already have plugins installed, you only need to add a new `Sketchfab` directory, otherwise you will need to create `Plugins` folder manually.
20+
If you already have plugins installed, you only need to add a new `Sketchfab` directory, otherwise you will need to create `Plugins` folder manually. You should end up with this structure:
21+
22+
`PROJECT_DIRECTORY/Plugins/Sketchfab/[Zip content]`
2023

21-
You should end with this structure: `PROJECT_DIRECTORY/Plugins/Sketchfab/[Zip content]`
2224
If Unreal Engine is running, you will need to close and reopen it in order to make it load the plugin.
2325

26+
Once loaded, the Sketchfab plugins will be available under the `Window` menu:
27+
28+
![Screenshot-0](https://user-images.githubusercontent.com/52042414/118534086-20758380-b749-11eb-837c-d9c2b87cfbda.png)
29+
2430

25-
### Import a Sketchfab model in UE4 project
31+
## Authentication
2632

27-
Once loaded, the Sketchfab asset browser is available in `Window` menu in Sketchfab sub menu:
33+
*Please note that a Sketchfab account is required both to download and upload models.*
2834

29-
![Screenshot-0](https://user-images.githubusercontent.com/4066133/60019503-4cd41280-968e-11e9-8483-0c8a5e51d962.JPG)
35+
To authenticate yourself, click the login button and enter your Sketchfab credentials before validating authentication.
3036

31-
When clicked, it opens a window and shows the latest free downloadable Sketchfab models.
37+
If you encounter errors at this step, please make sure to use the same method you use to connect to sketchfab.com (mail/password, Google, Facebook...).
3238

33-
#### Authentication
34-
You first need to log in with your Sketchfab account in order to be able to download and import Sketchfab models. To do so, use the login button, enter your Sketchfab credentials, and proceed to authentication.
39+
If you are using an email adress and password, the plugin will ask you to accept additional permissions necessary to download and upload models.
3540

36-
#### Asset Browser UI
37-
Once logged-in, you will be able to browse free Sketchfab downloadable models from the plugin using search and filters, as well as models you have purchased in the [Sketchfab Store](https://sketchfab.com/store).
41+
![Authentication](https://user-images.githubusercontent.com/52042414/118534076-1eabc000-b749-11eb-97b8-d274f22f7200.png)
3842

39-
If you are a PRO user, you can also use the **My Models** filter to search and have a private access to your personal library of models, which includes all your published models (including the private ones).
43+
## Download a model from Sketchfab
4044

41-
![Screenshot-1](https://user-images.githubusercontent.com/52042414/104914481-7f8bdd00-598f-11eb-98d1-a01325dcab74.png)
45+
The **Asset Browser** plugin allows you to seamlessly search and import:
46+
* models licensed under Creative Commons licenses from Sketchfab
47+
* your purchases from the [Sketchfab Store](https://sketchfab.com/store)
48+
* models you published to Sketchfab - included private ones - if you have a [PRO plan](https://sketchfab.com/plans)
4249

50+
#### Browsing through available models
4351

44-
#### Select and import model in UE4 project
45-
Once authenticated, double click on a model thumbnail to display more information.
52+
To use the **Asset Browser** interface, you will first have to select which kind of models you want to browse through (all CC models, purchases or your own models) in the dropdown at the left of the search bar.
53+
54+
Browsing through models is quite similar to [Sketchfab's search](https://sketchfab.com/search), and options to filter the results of your search query are available under the search bar:
55+
56+
![Screenshot-1](https://user-images.githubusercontent.com/52042414/118534080-1fdced00-b749-11eb-9870-5b28d2ea14f4.png)
57+
58+
Double clicking a model thumbnail will give you more information about the selected model and its associated license:
4659

4760
![Screenshot-2](https://user-images.githubusercontent.com/4066133/60019521-58bfd480-968e-11e9-902d-9fd3ae0247cf.JPG)
4861

49-
Click "Download model" to download the archive locally (a small progress bar under the thumbnail shows the status of the download).
50-
Then, drag and drop the thumbnail into the Content Browser to import it into your scene: a popup with license info is displayed and must be accepted before importing.
62+
#### Importing models
63+
64+
You can import models either by selecting **Import model** on a specific model information window, or by selecting multiple thumbnails from the Asset Browser main window and clicking the **Download Selected** button.
65+
66+
A progress bar under the model's thumbnail will show the progress of the download.
67+
68+
Once a model has finished downloading, you can import it into your scene by drag-and-dropping the associated thumbnail into your project's **Content Browser**.
69+
70+
A pop-up will then prompt you to accept the terms of the selected model's license (all freely downloadable models on Sketchfab are licensed under CC-attribution licenses, which are each associated with [various requirements](https://help.sketchfab.com/hc/en-us/articles/360038413232-Crediting-users-for-3D-model-downloads)).
5171

5272
![Screenshot-3](https://user-images.githubusercontent.com/4066133/60019527-5cebf200-968e-11e9-89df-5ba86f8c75c8.JPG)
73+
74+
Please note that downloaded models are cached in a directory on your computer, which you can manually clean or clear by clicking the **Clear Cache** button.
75+
76+
## Upload a model to Sketchfab
77+
78+
**(Beta - available for versions [4.25](https://github.com/sketchfab/unreal-plugin/releases/tag/4.25-2.0.0) and [4.26](https://github.com/sketchfab/unreal-plugin/releases/tag/4.26-2.0.0) only)**
79+
80+
The Sketchfab **Exporter** leverages recent [Unreal Engines GlTF export capabilities](https://www.unrealengine.com/marketplace/en-US/product/gltf-exporter) to allow direct upload of your 3D models from Unreal to Sketchfab.
81+
82+
The export process should be pretty straightforward if you have already uploaded a model to Sketchfab: fill in information about your model (title, description and tags), select if you want to upload the currently selected objects or the whole level, and set some publication options according to your needs (keep the model as a draft, set it as private or add an optionnal password protection for PRO users).
83+
84+
Depending on how the materials are set-up, you might want to choose to **bake** the models materials as textures, given that Unreal Engine node materials are not fully compatible with the GlTF file format and Sketchfab.
85+
86+
![Exporter](https://user-images.githubusercontent.com/52042414/118534085-20758380-b749-11eb-8983-21839500d74f.png)
87+
88+
You can find more information about the export capabilities - especially regarding materials - of the plugin [here](https://epicgames.ent.box.com/s/pd2h101708xqofbk4eqfzbko36iu2u7l). Please note that exporting animations and sequences to Sketchfab is not supported yet.
89+
90+
#### Note regarding upload size limit
91+
92+
Baking textures can often create large files depending on the number of materials and the chosen baking settings. As the maximum size of your uploads depends on your [Sketchfab plan](https://sketchfab.com/plans), an error message might pop up if this limit is exceeded.
93+
94+
Depending on the characteristics of your models and materials, disabling texture baking - or lowering the baking resolution - as well as making sure that only selected objects are exported can be good ways to get your model to an appropriate size for your plan.

0 commit comments

Comments
 (0)