浏览代码

Updated README

/main
GitHub 3 年前
当前提交
4875e8d9
共有 1 个文件被更改,包括 76 次插入2 次删除
  1. 78
      README.md

78
README.md


# PhotoMode
A virtual photography system for creating in-game screenshots and photographic effects within Unity projects.
<img src="https://user-images.githubusercontent.com/7104693/128102446-01f5ef64-e445-4a1b-9bd8-64aeb2c03a15.png" width="100%" />
## Overview
The Photo Mode package is a gateway for adding in-game photography systems to your PC and console Unity projects. The included prefab works across a variety of game styles and can be customized to your specific needs. The package also comes with a demo scene for reference and all required scripts, UI, and assets for out-of-the-box functionality.
The primary Unity features used in this package include the Universal Render Pipeline, UI system, Cinemachine, Input System, Post-Processing, and Shader Graph.
Photo Mode comes with the following features: View Roll, View Distance, Focus Distance, Aperture, Exposure, Contrast, Saturation, Vignette, Filters, Frames, Stickers, Camera Height, Camera Rotation, Rule of Thirds Grid, & Hide UI.
<p align="center">
<img src="https://user-images.githubusercontent.com/7104693/128102608-fb4c8072-e63b-4133-bff2-4574737ab586.png" width="49%" />
&nbsp;&nbsp;
<img src="https://user-images.githubusercontent.com/7104693/128102643-6964ab3b-208d-4f3e-9867-c8ca025c68ed.png" width="49%" />
</p>
<br>
## Requirements
- This package requires Unity version 2020.3 LTS or higher, along with the Universal Render Pipeline.
- If importing this demo into your own project, be sure to have the following packages installed: Cinemachine v2.6.5 +, Input System v1.0.2 +, TextMeshPro v3.0.6 +
- A scene containing a Cinemachine Brain and Virtual Camera (set to your preference)
<br>
## Setup
0. &nbsp;Download the Photo Mode package from this repo’s Releases page.
0. &nbsp;Open a Unity project with the requirements listed above. Ensure all required packages are added before importing Photo Mode and that your scene with the Cinemachine Brain and Virtual Camera is open.
0. &nbsp;Import the Photo Mode package into your project by navigating to Assets > Import Package > Custom Package.
0. &nbsp;In your Project window, locate the “PhotoMode” prefab within PhotoMode > Prefabs and drag it into your scene.
0. &nbsp;Select your scene’s newly added PhotoMode prefab and use the Inspector to assign your Player object (or other object you want Photo Mode to focus on) to the “Player Object” field within the Photo Mode script component.
0. &nbsp;Within the Project window, select your project’s main Renderer asset (usually listed as “Forward Renderer”). Go to the asset’s settings within the Inspector window and add a Blit Render Feature to the asset by selecting Add Renderer Feature > Blit.
0. &nbsp;The Render Feature you just created contains a field called “Blit Material.” Set its target to be the material called “BlitMaterial” located within the PhotoMode > Materials folder.
0. &nbsp;Select the “PhotoMode” prefab in your scene and locate the “Blit” field within its “Photo Mode” script component. Ensure that field is populated with the Blit you just added to the Renderer.
0. &nbsp;Enter Play mode to test Photo Mode. By default, Photo Mode can be activated by pressing “P” on a keyboard or “SELECT” on a gamepad.
<br>
## Saving Screenshots
Once you apply your desired effects with Photo Mode, use the Hide UI option to see an unobstructed view of your creation. You can then save it as an image using your device’s native Share or Screenshot button.
<br>
## Customization Notes
Photo Mode contains a Volume with post-processing effects that may override your existing Volume’s Depth of Field or Color Adjustments settings. You can update Photo Mode to work with your Volume’s values by following these two steps:
- In the Hierarchy, select the PhotoMode_Volumes child object of the Photo Mode prefab. Change any conflicting values within its Depth of Field or Color Adjustments settings to match what you have in your original Volume. Also, make sure the PhotoMode_Volumes priority is set to a higher value than your original Volume.
- On the main PhotoMode prefab object, update the Min/Max fields for the corresponding settings within the Photo Mode script component. The value of each slider in Photo Mode defaults to the average between its corresponding Min & Max values. Set your Min/Max range to have an average that matches the value of the setting in your post-processing Volume. For example, if the value you want to use for Post Exposure is 1.5, the Min/Max range for it could be -0.5/3.5.
If you’d like to enable Photo Mode using a different input, UI event, or other custom setup, be sure to turn off the Pause Action Activation checkbox within the Photo Mode Pauser script component on the main PhotoMode prefab object. Once turned off, Photo Mode will no longer open when pressing the default “P” key so you can integrate Photo Mode into your preferred setup.
<br>
## Resources
Here are some links to helpful context regarding the Photo Mode Demo Package:
- Overview Video (LINK TBA)
- Blog Post (LINK TBA)
- Forum Thread (LINK TBA)
正在加载...
取消
保存