Skip to content

Commit f464c1f

Browse files
committed
doc: Update README and remove obsolete metas.
1 parent 541b30a commit f464c1f

File tree

6 files changed

+9
-77
lines changed

6 files changed

+9
-77
lines changed

Assets/Art/Particles.meta

Lines changed: 0 additions & 8 deletions
This file was deleted.

Assets/Art/Scenes.meta

Lines changed: 0 additions & 8 deletions
This file was deleted.

Assets/Art/StreamingAssets.meta

Lines changed: 0 additions & 8 deletions
This file was deleted.

Assets/Art/Materials.meta renamed to LICENSE.md.meta

Lines changed: 2 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 5 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# VisualPinball AssetLibrary
1+
# Assets for Visual Pinball Engine
22

3-
This repository contains the asset library for the [Visual Pinball Engine](https://github.com/freezy/VisualPinball.Engine).
3+
*Common assets for all render pipelines.*
44

5-
More to come.
5+
## Where Are We?
6+
7+
![image](https://user-images.githubusercontent.com/70426/102674961-0b93c480-4198-11eb-950e-431500aaf3f5.png)
68

79
## Setup
810

@@ -13,50 +15,6 @@ git lfs install
1315
git clone https://github.com/freezy/VisualPinball.AssetLibrary.git
1416
```
1517

16-
## Packages
17-
18-
*This section will move to somewhere more global.*
19-
20-
VPE comes in a bunch of Unity packages. There are two reasons there are so many of them:
21-
22-
1. HDRP and URP are incompatible.
23-
2. We want to separate assets from the code in order to keep the code light.
24-
25-
We haven't got a player project yet. So there are even more packages to come! Anyway, because package names are long
26-
and there are subtle differences, here's how will be referring to them:
27-
28-
| | Package Name | Repository |
29-
|-------------------------|-------------------------------------------|---------------------------------------|
30-
| vpe (also "core") | org.visualpinball.engine.unity | [VisualPinball.Engine](https://github.com/freezy/VisualPinball.Engine) |
31-
| vpe.hdrp | org.visualpinball.engine.unity.hdrp | [VisualPinball.Unity.Hdrp](https://github.com/freezy/VisualPinball.Unity.Hdrp) |
32-
| vpe.assets | org.visualpinball.unity.assetlibrary | [VisualPinball.Unity.AssetLibrary](https://github.com/freezy/VisualPinball.AssetLibrary/tree/refactor/repos/VisualPinball.Unity.AssetLibrary) |
33-
| vpe.assets.hdrp | org.visualpinball.unity.assetlibrary.hdrp | [VisualPinball.Unity.AssetLibrary.Hdrp](https://github.com/freezy/VisualPinball.AssetLibrary/tree/refactor/repos/VisualPinball.Unity.AssetLibrary.Hdrp) |
34-
| unity.hdrp | com.unity.render-pipelines.high-definition | [Unity/Graphics](https://github.com/Unity-Technologies/Graphics/tree/master/com.unity.render-pipelines.high-definition) |
35-
36-
37-
- **vpe** is the main repo. It contains mainly the code, and some resources, which will
38-
probably move into vpe.unity.assets at some point. It doesn't have any dependencies, neither
39-
to any of the other vpe packages nor to Unity's HDRP or URP. If only this repo is used in a
40-
project, the standard renderpipeline is used.
41-
- **vpe.hdrp** contains HDRP-specific code.
42-
- **vpe.assets** contains common assets only, i.e. asses that are render pipeline-agnostic.
43-
- **vpe.assets.hdrp** contains HDRP-specific assets.
44-
45-
### Dependencies
46-
47-
We have the following dependencies:
48-
49-
![](https://user-images.githubusercontent.com/70426/102411603-7a371d80-3ff2-11eb-8210-6203a74a635d.png)
50-
51-
So we see that vpe.hdrp pulls in three other dependencies. These have to be added manually at the moment. So when
52-
working with HDRP, you would have the following packages under *Custom* in the package manager:
53-
54-
- Visual Pinball Engine
55-
- Visual Pinball Engine (Common Assets)
56-
- Visual Pinball Engine (HDRP Assets)
57-
- Visual Pinball Engine (HDRP)
58-
59-
6018
## License
6119

6220
[Creative Commons Attribution-ShareAlike 4.0](LICENSE.md)

Assets/Art/Media.meta renamed to README.md.meta

Lines changed: 2 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)