Skip to content

Commit 34c8201

Browse files
authored
Update README.md
1 parent f4ecfcb commit 34c8201

File tree

1 file changed

+24
-6
lines changed

1 file changed

+24
-6
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,29 @@
11
![](/.github/banner.png?raw=true "")
2-
![](/.github/gallery.png?raw=true "")
3-
2+
![](/.github/preview.png?raw=true "")
43

54

65
## ℹ️ Features
76

8-
todo
7+
* Basic portal rendering for Unity.
8+
* Minimal setup required.
9+
* Configurable portal shape.
10+
* Basic teleportation support for objects (player controller etc.).
11+
* 🀞 Reasonably lightweight.
12+
13+
**βŒ› Planned**
14+
15+
* [ ] Basic Valve-esque physics (portal velocity, object funneling etc.).
16+
* [ ] More extensibility and options.
17+
18+
**🐞 Known Issues / Limitations**
19+
20+
* Screen space shadows rendered through portals may flicker at short distances.
921

1022

23+
**Note**
24+
25+
This plugin does not contain any demo assets. Effects such as outlines around portals must be added manually and configured in each case.
26+
1127
<br/>
1228

1329
## πŸ“¦ Install
@@ -18,13 +34,15 @@ todo
1834

1935
<br/>
2036

21-
## πŸš€ Use
37+
# πŸš€ Use
2238

23-
todo
39+
*Documentation page coming soon*
2440

2541
<br/>
2642

43+
44+
2745
## πŸ“œ Credits
2846

29-
todo
47+
* Camera logic largely adapts methods described [here](https://www.youtube.com/watch?v=cWpFZbjtSQg) by Sebastian Lague.
3048

0 commit comments

Comments
Β (0)