Reorganized contents of the readme file in a more intuitive way.
This commit is contained in:
Kristijonas Jalnionis 2022-02-23 18:38:02 +01:00 коммит произвёл GitHub
Родитель 6aaa6e843d
Коммит e450f5f9a5
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 59 добавлений и 56 удалений

115
README.md
Просмотреть файл

@ -1,50 +1,21 @@
# Fontainebleau
Project for Unity 2019.4.1f1 using HDRP 7.4.1
**Check the [changelog](https://github.com/Unity-Technologies/FontainebleauDemo/blob/master/Changelog.md) to see the latest updates.**
<img src = "https://forum.unity.com/proxy.php?image=https%3A%2F%2Fblogs.unity3d.com%2Fwp-content%2Fuploads%2F2018%2F03%2Fimage5-1280x720.png&hash=d4dd82baaada0823f75c693064c8c964" title = "Fontainebleau title screen" alt >
## Summary
Check the [changelog](https://github.com/Unity-Technologies/FontainebleauDemo/blob/master/Changelog.md) to for the latest updates and Unity editor compatibily information.
We created the Fontainebleau demo to illustrate the photogrammetry workflow and the use of the LayeredLit shader.
This technical demo is authored with game development condition in mind: its a representative game level and targets the standard PlayStation 4 platform at 1080p @ 30fps.
This technical demo is authored with game development condition in mind: its a representative game level and targets the base PlayStation 4 at 1080p @ 30fps.
The level represents a part of the Fontainebleau forest and uses a limited set of meshes and textures that are reused with different variation with the help of the LayeredLit shader.
There is a playable first person and third person mode to walk inside the forest. Targeting consoles like XboxOne or PlayStation 4 requires consideration of how to get the most from these platforms.
There is a playable first person and third person mode to walk inside the forest. Targeting consoles like Xbox One or PlayStation 4 requires consideration of how to get the most from these platforms.
The demo also supports three different lighting condition to illustrate that correctly authored and de-lighted assets work fine in any lighting condition:
<img src = "https://github.com/Unity-Technologies/FontainebleauDemo/blob/master/Documentation/Images/0.PNG" >
- Day lighting
<img src = "https://github.com/Unity-Technologies/FontainebleauDemo/blob/master/Documentation/Images/3.PNG" >
- Sunset lighting
<img src = "https://github.com/Unity-Technologies/FontainebleauDemo/blob/master/Documentation/Images/5.PNG" >
- Night lighting with lights off
<img src = "https://github.com/Unity-Technologies/FontainebleauDemo/blob/master/Documentation/Images/6.PNG" >
- Night lighting with lights on
<img src = "https://github.com/Unity-Technologies/FontainebleauDemo/blob/master/Documentation/Images/7.PNG" >
Finally, we included 3 modes to explore the demo:
<img src = "https://github.com/Unity-Technologies/FontainebleauDemo/blob/master/Documentation/Images/1.PNG" title = "Fontainebleau menu screen" alt width="200" height="400" >
- Cinematic mode: select your lighting program, then sit back, relax and enjoy the show,
- First Person & Third Person Modes: these are very rudimentary exploration modes to let you discover the environment on your own, with bonuses in First Person mode.
<img src = "https://github.com/Unity-Technologies/FontainebleauDemo/blob/master/Documentation/Images/11.PNG" >
<img src = "https://github.com/Unity-Technologies/FontainebleauDemo/blob/master/Documentation/Images/4.PNG" >
**Why Fontainebleau?**
### Why Fontainebleau?
Fontainebleau is the name of a forest close to the Unity Paris office. The forest is a good subject to speak about photogrammetry. Natural assets are often complex and hard to reproduce realistically. For our artists, it was important to have the subject close to them to go on site and do all the tests needed to analyze the best workflow possible for games.
**The features implemented in this demo are:**
## Features
- Deferred rendering
- Layered lit shader
@ -60,52 +31,84 @@ Fontainebleau is the name of a forest close to the Unity Paris office. The fores
- Fabric Shader graph (3rd character mode)
- Cinemachine
# Setup
## Setup
- Download **Unity 2019.3.0f1** or a more recent version of 2019.3
- Clone the repository using the tool of your preference (Git, Github Desktop, Sourcetree, ...).
1. Download **Unity 2019.3.0f1** or a newer version of the Unity editor.
2. Clone the repository using the tool of your preference (Git, Github Desktop, Sourcetree, Fork, etc.).
| IMPORTANT |
| ------------------------------------------------------------ |
| This project uses Git Large Files Support (LFS). Downloading a zip file using the green button on Github **will not work**. You must clone the project with a version of git that has LFS. You can download Git LFS here: <https://git-lfs.github.com/> or use the [Github Desktop](https://desktop.github.com/) which already uses LFS. |
- Open the repository folder in Unity. **The first time you open the project Unity will import all the assets, this operation can take more than 1 hour.**
3. Open the repository folder in Unity. The first time you open the project Unity will import all the assets. **This operation can take more than 1 hour.**
# Exploring the project
## Exploring the project
### Discover wizard
When the project opens, you should see a popup window appear named **Discover Fontainebleau**.
- When the project opens, you should see a popup window appear named **Discover Fontainebleau**
<img src = "https://github.com/Unity-Technologies/FontainebleauDemo/blob/master/Documentation/Images/DiscoverLevels.png" >
- The Levels tab allows you to load the different scene setups included in the project.
The Levels tab allows you to load the different scene setups included in the project.
<img src = "https://github.com/Unity-Technologies/FontainebleauDemo/blob/master/Documentation/Images/DiscoverItems.png" >
- The Discover tab allows you to inspect different interesting elements in the project and read small explanations.
# Controls layout
The Discover tab allows you to inspect different interesting elements in the project and read small explanations.
## Keyboard
### Exploration modes
We included three modes to explore the demo:
<img src = "https://github.com/Unity-Technologies/FontainebleauDemo/blob/master/Documentation/Images/1.PNG" title = "Fontainebleau menu screen" alt width="200" height="400" >
- **Cinematic mode**. Select your lighting program, then sit back, relax and enjoy the show.
- **First Person & Third Person modes**. These are very rudimentary exploration modes to let you discover the environment on your own, with bonuses in First Person mode.
<img src = "https://github.com/Unity-Technologies/FontainebleauDemo/blob/master/Documentation/Images/11.PNG" >
<img src = "https://github.com/Unity-Technologies/FontainebleauDemo/blob/master/Documentation/Images/4.PNG" >
## Lighting Treatments
The demo also supports three different lighting condition to illustrate that correctly authored and de-lighted assets work fine in any lighting condition.
<img src = "https://github.com/Unity-Technologies/FontainebleauDemo/blob/master/Documentation/Images/0.PNG" >
### Day lighting
<img src = "https://github.com/Unity-Technologies/FontainebleauDemo/blob/master/Documentation/Images/3.PNG" >
### Sunset lighting
<img src = "https://github.com/Unity-Technologies/FontainebleauDemo/blob/master/Documentation/Images/5.PNG" >
### Night lighting - lights off
<img src = "https://github.com/Unity-Technologies/FontainebleauDemo/blob/master/Documentation/Images/6.PNG" >
### Night lighting - lights on
<img src = "https://github.com/Unity-Technologies/FontainebleauDemo/blob/master/Documentation/Images/7.PNG" >
## Controls layout
### Keyboard
<img src = "https://github.com/Unity-Technologies/FontainebleauDemo/blob/master/Documentation/Images/8.PNG" >
## Gamepad
### Gamepad
<img src = "https://github.com/Unity-Technologies/FontainebleauDemo/blob/master/Documentation/Images/9.PNG" >
# Scripts used in this demo
## Scripts used in this demo
- Character controller from standard assets
- Gameplay ingredients
- Lightmap switching script
- [Lightmap switching tool](https://github.com/laurenth-unity/lightmap-switching-tool)
- Lightmapped LODs
For instructions on how to bake lightmaps with the **Lightmap switching script** check this [repository](https://github.com/laurenth-unity/lightmap-switching-tool)
## Known issues
# Known issues
- On some platforms the night lighting has bright white areas. This is due to reflection probes capture happening before the light probe proxy volumes used for lighting the trees and foliage get refreshed to the night values.
- On Some platforms the night lighting has bright white areas. This is due to reflection probes capture happening before the light probe proxy volumes used for lighting the trees and foliage get refreshed to the night values.
## Feedback
# Feedback - Bugs
Don't hesitate to use the forum thread to send us your feedback or share the work you did based on this scene :
[Forum Thread](https://forum.unity.com/threads/photogrammetry-in-unity-making-real-world-objects-into-digital-assets.521946/)
Visit the [forum thread](https://forum.unity.com/threads/photogrammetry-in-unity-making-real-world-objects-into-digital-assets.521946/) to send us your feedback or share the work you did based on this scene.
You can also use the [issue tab](https://github.com/Unity-Technologies/FontainebleauDemo/issues) to report bugs.