Skip to content

Commit c214c3e

Browse files
committed
docs: update readme [-noci]
1 parent 44288aa commit c214c3e

File tree

1 file changed

+52
-22
lines changed

1 file changed

+52
-22
lines changed

README.md

Lines changed: 52 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
11
# Cinematic Unity Explorer
22

3+
<p align="center">
4+
Adapted for <b>Night-Runners</b>.
5+
</p>
6+
37
<p align="center">
48
<img align="center" src="img/icon.png" width="300" height="300">
59
</p>
610

711
<p align="center">
8-
🎥 Fork of the excellent UnityExplorer mod made by <a href="https://github.com/sinai-dev">sinai-dev</a> focused on providing tools for creating marketing material for Unity games.
12+
Fork of the excellent CinematicUnityExplorer mod made by <a href="https://github.com/originalnicodr">originalnicodr</a> focused on providing support for Night-Runners game.
913
</p>
1014
<p align="center">
11-
To see the forks features I have worked on so far check out the <a href="#features">Features</a> section.
15+
🎥 CinematicUnityExplorer is a fork of the excellent UnityExplorer mod made by <a href="https://github.com/sinai-dev">sinai-dev</a> focused on providing tools for creating marketing material for Unity games.
16+
</p>
17+
<p align="center">
18+
To see the forks features we have worked on so far check out the <a href="#features">Features</a> section.
1219
</p>
1320
<p align="center">
1421
✔️ Supports most Unity versions from 5.2 to 2021+ (IL2CPP and Mono).
@@ -17,9 +24,11 @@
1724
✨ Powered by <a href="https://github.com/yukieiji/UniverseLib">UniverseLib</a>
1825
</p>
1926

20-
# Releases [![](https://img.shields.io/github/downloads/originalnicodr/CinematicUnityExplorer/total.svg)](../../releases)
27+
# Releases [![](https://img.shields.io/github/downloads/Scoolnik/NR-CinematicUnityExplorer/total.svg)](../../releases)
28+
29+
[![](https://img.shields.io/github/release/Scoolnik/NR-CinematicUnityExplorer.svg?label=version)](../../releases/latest) [![](https://img.shields.io/github/actions/workflow/status/Scoolnik/NR-CinematicUnityExplorer/dotnet.yml)](https://github.com/Scoolnik/NR-CinematicUnityExplorer/actions) [![](https://img.shields.io/github/downloads/Scoolnik/NR-CinematicUnityExplorer/latest/total.svg)](../../releases/latest)
2130

22-
[![](https://img.shields.io/github/release/originalnicodr/CinematicUnityExplorer.svg?label=version)](../../releases/latest) [![](https://img.shields.io/github/actions/workflow/status/originalnicodr/CinematicUnityExplorer/dotnet.yml)](https://github.com/originalnicodr/CinematicUnityExplorer/actions) [![](https://img.shields.io/github/downloads/originalnicodr/CinematicUnityExplorer/latest/total.svg)](../../releases/latest)
31+
Nightly build: https://nightly.link/Scoolnik/NR-CinematicUnityExplorer/workflows/dotnet_nightly/development/CinematicUnityExplorer.BepInEx.Unity.IL2CPP.CoreCLR.zip
2332

2433
<p align="center">
2534
<a href="https://www.youtube.com/watch?v=--8DOKWzGJ4" target="_blank">
@@ -30,15 +39,15 @@
3039

3140
## Release schedule
3241

33-
Nightly builds can be found [here](https://github.com/originalnicodr/CinematicUnityExplorer/actions).
42+
Nightly builds can be found [here](https://github.com/Scoolnik/NR-CinematicUnityExplorer/actions).
3443

3544
## BepInEx
3645

3746
| Release | IL2CPP(CoreCLR) | IL2CPP(Unhollower) | Mono |
3847
| ------- | ------ | ------ | ---- |
39-
| BIE 6.X be.647+ |[link](https://github.com/originalnicodr/CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.BepInEx.Unity.IL2CPP.CoreCLR.zip) | ✖️ n/a |[link](https://github.com/originalnicodr/CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.BepInEx6.Unity.Mono.zip) |
40-
| BIE 6.X be.472 to be.577 |[link](https://github.com/originalnicodr/CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.BepInEx.IL2CPP.CoreCLR.zip) |[link](https://github.com/originalnicodr/CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.BepInEx.IL2CPP.zip) |[link](https://github.com/originalnicodr/CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.BepInEx6.Mono.zip) |
41-
| BIE 5.X | ✖️ n/a | ✖️ n/a |[link](https://github.com/originalnicodr/CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.BepInEx5.Mono.zip) |
48+
| BIE 6.X be.647+ |[link](https://github.com/Scoolnik/NR-CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.BepInEx.Unity.IL2CPP.CoreCLR.zip) | ✖️ n/a |[link](https://github.com/Scoolnik/NR-CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.BepInEx6.Unity.Mono.zip) |
49+
| BIE 6.X be.472 to be.577 |[link](https://github.com/Scoolnik/NR-CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.BepInEx.IL2CPP.CoreCLR.zip) |[link](https://github.com/Scoolnik/NR-CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.BepInEx.IL2CPP.zip) |[link](https://github.com/Scoolnik/NR-CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.BepInEx6.Mono.zip) |
50+
| BIE 5.X | ✖️ n/a | ✖️ n/a |[link](https://github.com/Scoolnik/NR-CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.BepInEx5.Mono.zip) |
4251

4352
1. Unzip the release file into a folder
4453
2. Take the `plugins/CinematicUnityExplorer` folder and place it in `BepInEx/plugins/`
@@ -49,9 +58,9 @@ Nightly builds can be found [here](https://github.com/originalnicodr/CinematicUn
4958

5059
| Release | IL2CPP | Mono |
5160
| ------- | ------ | ---- |
52-
| ML 0.6.x |[link](https://github.com/originalnicodr/CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.MelonLoader.IL2CPP.CoreCLR.zip) | ✖️ |
53-
| ML 0.6(only alpha build) |[link](https://github.com/originalnicodr/CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.MelonLoader.IL2CPP.net6preview.zip) | ✖️ |
54-
| ML 0.5 |[link](https://github.com/originalnicodr/CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.MelonLoader.IL2CPP.zip) |[link](https://github.com/originalnicodr/CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.MelonLoader.Mono.zip) |
61+
| ML 0.6.x |[link](https://github.com/Scoolnik/NR-CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.MelonLoader.IL2CPP.CoreCLR.zip) | ✖️ |
62+
| ML 0.6(only alpha build) |[link](https://github.com/Scoolnik/NR-CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.MelonLoader.IL2CPP.net6preview.zip) | ✖️ |
63+
| ML 0.5 |[link](https://github.com/Scoolnik/NR-CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.MelonLoader.IL2CPP.zip) |[link](https://github.com/Scoolnik/NR-CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.MelonLoader.Mono.zip) |
5564

5665
1. Unzip the release file into a folder
5766
2. Copy the DLL inside the `Mods` folder into your MelonLoader `Mods` folder
@@ -61,19 +70,19 @@ Nightly builds can be found [here](https://github.com/originalnicodr/CinematicUn
6170

6271
| IL2CPP | Mono |
6372
| ------ | ---- |
64-
|[link](https://github.com/originalnicodr/CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.Standalone.IL2CPP.zip) |[link](https://github.com/originalnicodr/CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.Standalone.Mono.zip) |
73+
|[link](https://github.com/Scoolnik/NR-CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.Standalone.IL2CPP.zip) |[link](https://github.com/Scoolnik/NR-CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.Standalone.Mono.zip) |
6574

6675
The standalone release can be used with any injector or loader of your choice, but it requires you to load the dependencies manually.
6776

68-
1. Ensure the required libs are loaded - UniverseLib, HarmonyX and MonoMod. Take them from the [`CinematicUnityExplorer.Editor`](https://github.com/originalnicodr/CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.Editor.zip) release if you need them.
77+
1. Ensure the required libs are loaded - UniverseLib, HarmonyX and MonoMod. Take them from the [`CinematicUnityExplorer.Editor`](https://github.com/Scoolnik/NR-CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.Editor.zip) release if you need them.
6978
2. For IL2CPP, load Il2CppAssemblyUnhollower and start an [Il2CppAssemblyUnhollower runtime](https://github.com/knah/Il2CppAssemblyUnhollower#required-external-setup)
7079
2. Load the CinematicUnityExplorer DLL
7180
3. Create an instance of Unity Explorer with `UnityExplorer.ExplorerStandalone.CreateInstance();`
7281
4. Optionally subscribe to the `ExplorerStandalone.OnLog` event to handle logging if you wish
7382

7483
## Unity Editor
7584

76-
1. Download the [`CinematicUnityExplorer.Editor`](https://github.com/originalnicodr/CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.Editor.zip) release.
85+
1. Download the [`CinematicUnityExplorer.Editor`](https://github.com/Scoolnik/NR-CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.Editor.zip) release.
7786
2. Install the package, either by using the Package Manager and importing the `package.json` file, or by manually dragging the folder into your `Assets` folder.
7887
3. Drag the `Runtime/CinematicUnityExplorer` prefab into your scene, or create a GameObject and add the `Explorer Editor Behaviour` script to it.
7988

@@ -94,7 +103,7 @@ If these fixes do not work, please create an issue in this repo and I'll do my b
94103

95104
# Guide and documentation
96105

97-
I wrote a [guide](https://framedsc.com/GeneralGuides/cinematic-unity-explorer.htm) explaining different things regarding the Cinematic Unity Explorer over the Framed website, from knowing what version to download with your game and troubleshooting, to usage and tips and tricks. Feel free to create a PR on the [Framed GitHub repo](https://github.com/framedsc/Sitesource) if you want to improve it.
106+
originalnicodr wrote a [guide](https://framedsc.com/GeneralGuides/cinematic-unity-explorer.htm) explaining different things regarding the Cinematic Unity Explorer over the Framed website, from knowing what version to download with your game and troubleshooting, to usage and tips and tricks. Feel free to create a PR on the [Framed GitHub repo](https://github.com/framedsc/Sitesource) if you want to improve it.
98107

99108
# Default Hotkeys
100109

@@ -124,9 +133,17 @@ Freeze NPC animations | `Numpad 0`
124133

125134
# Features
126135

136+
NR fork features:
137+
- "Follow car" button
138+
- Hide game ui
139+
- Disable default camera behaviour when using free cam
140+
- Move camera container, not camera itself
141+
142+
## The following are features from the original CinematicUnityExplorer project which I have not made myself (text left as is).
143+
127144
The following are the features I developed for this fork. All focused on making things easier for capture artists to get marketing material for studios.
128145

129-
If you found a bug or a problem (or want to see the things I want to work on) head over to the [issues page](https://github.com/originalnicodr/CinematicUnityExplorer/issues).
146+
If you found a bug or a problem (or want to see the things I want to work on) head over to the [issues page](https://github.com/Scoolnik/NR-CinematicUnityExplorer/issues).
130147

131148
## Improved Freecam
132149

@@ -143,25 +160,28 @@ The original Unity Explorer had a Freecam feature, but even if it was useful at
143160
- Blocked rotation from going further when looking directly up or directly down.
144161

145162
### Follow Object
163+
146164
You can click on the "Follow object" button on the panel and select the object you want the camera to follow or click on the "Follow object" button in the inspector screen for more granularity. This can be used as it is, but it's even more useful when playing with [camera paths](#camera-paths), as you can create a path for the camera to walk relative to the object
147165

148166
By default the camera only follows the object's position, but you can also make it follow its rotation as if the camera was physically bound to the object by checking the "Follow Object Rotation" toggle. Should be useful for mimicking a car camera, a character POV, or creating motion blur.
149167

150168
### Game input block for Unity's legacy system
169+
151170
Added game input block for Unity's legacy system. You can now block (or unblock) the game's input when using the freecam, as long as the game is using the Unity Legacy Input system. If the game uses a custom solution or the latest Unity system then this won't work. Implementing this for Unity's new system is in the backlog, so if you find a game using it (should say "Initialized new InputSystem support." on the logs) then please let me know so I can implement it using that game!
152171

153172
## Lights manager
173+
154174
It allows you to spawn spotlights and pointlights, as well as toggle the game's original lights to allow you to relight the scene however you want (a task that is pretty common for screenshots and lighting artists). Please note that this only turns off scene lights and won't turn off ambient light or lights created by emissive materials, effects, or shaders.
155175

156176
<p align="center">
157-
<a href="https://raw.githubusercontent.com/originalnicodr/CinematicUnityExplorer/master/img/lights_demo.jpg">
177+
<a href="https://raw.githubusercontent.com/Scoolnik/NR-CinematicUnityExplorer/master/img/lights_demo.jpg">
158178
<img src="img/lights_demo.jpg" />
159179
</a>
160180
</p>
161181

162182
You can edit the light parameters by clicking on the "Config" button. There might be a ton of stuff there, but you would want to focus on these properties:
163183

164-
- **Intensity**: How strong the light is.
184+
- **Intensity**: How strong the light is.
165185
- **Range**: How far the light travels.
166186
- **Color**: Pretty self explanatory.
167187
- **Color Temperature**: In case you want to use more natural colors. You would also need to enable the `useColorTemperature` property.
@@ -172,9 +192,11 @@ If you want to move an already created light you can use the "Move to Camera" op
172192
There also is a default intensity input field on the panel. Since the intensity varies a lot from game to game you have to increase/decrease this property on a light until it looks right, and once you figure out a value that works for your game you can write it as the default intensity and don't have to edit it on the new lights you spawn from that point.
173193

174194
### Visualizer
195+
175196
You can also draw an arrow or sphere representing the light source from spotlights and point lights respectively, to understand your light setups better. To do so click on the "Toggle visualizer" button on a light in the panel.
176197

177198
## Camera paths
199+
178200
It allows you to create nodes to build camera paths for videos and cinematics. Features include:
179201

180202
- Add and delete camera path nodes.
@@ -192,14 +214,17 @@ It allows you to create nodes to build camera paths for videos and cinematics. F
192214
As a side note, the mod UI will be disabled once the path starts, to ease video recording.
193215

194216
### Visualizer
217+
195218
Similarly to the Light Manager, you can visualize a camera path with arrows, whose origin and orientation represent the position and orientation that the camera will have at that point in the curve. You can turn this on by clicking on the "Visualize path" checkbox. Keep in mind that this will be turned off once the path starts playing since its purpose is to help the user set up the path itself.
196219

197220
## Post-processing panel
221+
198222
It loads all the current vanilla post-processing effects being used and offers togglers to disable them. It also lets you inspect the postprocessing objects yourself if you want to edit their parameters instead.
199223

200224
[Shader toggler](https://github.com/FransBouma/ShaderToggler) would still be preferred (especially as it will be able to catch custom effects that this mod can't), but it might still be useful for some.
201225

202226
## Animator
227+
203228
Allows you to manually play characters and NPC animations in a scene. This should be pretty useful for getting the right animation on each enemy to set up marketing screenshots.
204229

205230
Favorite animations so they appear first on the dropdown list by clicking on the star button with the animation selected.
@@ -213,6 +238,7 @@ Alongside all of this, you can also open each character game object by clicking
213238
For each animator, you can also spawn a Bones Panel. This panel will list all of the character's bones and meshes, and provide easy-to-access toggles to disable them and sliders to move them around, allowing you to pose a character to your liking.
214239

215240
## Misc Panel
241+
216242
- HUD toggle.
217243
- Force high LODs toggle. This means that the highest models possible will be forced on all meshes.
218244
- Screenshot support. Allows you to momentarily render the game at a higher resolution than the one being used and take a screenshot. You can enter the multiplier of the current resolution at which the screenshot should render in the "Supersize" field.
@@ -224,6 +250,7 @@ For each animator, you can also spawn a Bones Panel. This panel will list all of
224250
- Toggle to change the resolution of shadows generated by the game's vanilla lights. Beware using this one with the two options from above. Also, take in mind that lights created with the Light Manager already generate high-resolution shadows.
225251

226252
## And more!
253+
227254
- Refactored the pause to make it more reliable.
228255
- Hotkey to pause the game.
229256
- Added a slider to the TimeScale.
@@ -234,6 +261,7 @@ For each animator, you can also spawn a Bones Panel. This panel will list all of
234261
# IGCSDOF Support
235262

236263
The mod also supports [IGCSConnector](https://github.com/FransBouma/IgcsConnector/releases), and therefore [IGCSDOF](https://opm.fransbouma.com/igcsdof.htm), the best modded DOF available. This is an accumulated DOF solution similar to Forza Horizon's or other offline rendering software. This accumulated solution brings some advantages compared to real-time solutions, such as:
264+
237265
- Accurate near-plane bleed.
238266
- Particle & alpha effects in DOF.
239267
- Depth-accurate reflections.
@@ -245,11 +273,11 @@ The mod also supports [IGCSConnector](https://github.com/FransBouma/IgcsConnecto
245273

246274
You can download it, read how to install it, and how to use it [here](https://opm.fransbouma.com/igcsdof.htm).
247275

248-
>[!IMPORTANT]
249-
> To be able to use IGCSDOF, besides following the instructions above, make sure to download [UnityIGCSConnector.dll](https://github.com/originalnicodr/CinematicUnityExplorer/releases/latest/download/UnityIGCSConnector.dll) and put it in the same folder as the games .exe.
276+
> [!IMPORTANT]
277+
> To be able to use IGCSDOF, besides following the instructions above, make sure to download [UnityIGCSConnector.dll](https://github.com/Scoolnik/NR-CinematicUnityExplorer/releases/latest/download/UnityIGCSConnector.dll) and put it in the same folder as the games .exe.
250278
> This is a necessary middleware so the Reshade add-on can communicate with the mod.
251279
252-
>[!IMPORTANT]
280+
> [!IMPORTANT]
253281
> Be sure to select `Classic (slower)` mode instead of `Fast`, as the latter one seems to render the image out of focus. However `Fast` might still work in some games.
254282
255283
Huge shout out to [etra0](https://github.com/etra0) for implementing this!
@@ -265,7 +293,7 @@ Maybe I would make a separate version one day, but for now, it is what it is.
265293
The following are features from the original UnityExplorer project which I have not made myself.
266294

267295
<p align="center">
268-
<a href="https://raw.githubusercontent.com/originalnicodr/CinematicUnityExplorer/master/img/preview.png">
296+
<a href="https://raw.githubusercontent.com/Scoolnik/NR-CinematicUnityExplorer/master/img/preview.png">
269297
<img src="img/preview.png" />
270298
</a>
271299
</p>
@@ -275,11 +303,13 @@ The following are features from the original UnityExplorer project which I have
275303
If you want to inspect an object or Type from outside the C# console, use the `InspectorManager` class:
276304

277305
**To inspect an object:**
306+
278307
```csharp
279308
UnityExplorer.InspectorManager.Inspect(theObject);
280309
```
281310

282311
**To inspect a Type:**
312+
283313
```cs
284314
UnityExplorer.InspectorManager.Inspect(typeof(SomeClass));
285315
```

0 commit comments

Comments
 (0)