Skip to content

Commit 533f332

Browse files
jsm174freezy
authored andcommitted
docs: Update README
1 parent 04dcac7 commit 533f332

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,8 @@ but for now you'll need to open it through Unity.
2424

2525
Both gRPC and Protobuf come with dependencies that conflict with Unity's, namely
2626
`System.Buffers`, `System.Memory` and `System.Runtime.CompilerServices`. To
27-
solve this, we pack all dependencies into a single DLL and ship it to Unity as
28-
a single binary. So, what Unity is getting is:
29-
30-
- `VisualPinball.Engine.Mpf.dll`, which is `VisualPinball.Engine.Mpf` including
31-
all its .NET dependencies
32-
- `grpc_csharp_ext.dll`, which is the native gRCP library used by the C# wrapper.
27+
solve this, we disable validation for `Google.Protobuf.dll` in the meta file
28+
located in the `VisualPinball.Engine.Mpf.Unity/Plugins` folder.
3329

3430
### Unity Package
3531

@@ -63,15 +59,28 @@ actual binaries, `.meta` files of uncompiled platforms are cleaned up by Unity.
6359
In order to not accidentally commit those files, we recommend to ignore them:
6460

6561
```bash
62+
git update-index --assume-unchanged VisualPinball.Engine.Mpf.Unity/Plugins/linux-x64/VisualPinball.Engine.Mpf.dll.meta
63+
git update-index --assume-unchanged VisualPinball.Engine.Mpf.Unity/Plugins/linux-x64/Google.Protobuf.dll.meta
64+
git update-index --assume-unchanged VisualPinball.Engine.Mpf.Unity/Plugins/linux-x64/Grpc.Core.Api.dll.meta
65+
git update-index --assume-unchanged VisualPinball.Engine.Mpf.Unity/Plugins/linux-x64/Grpc.Core.dll.meta
6666
git update-index --assume-unchanged VisualPinball.Engine.Mpf.Unity/Plugins/linux-x64/libgrpc_csharp_ext.so.meta
6767
git update-index --assume-unchanged VisualPinball.Engine.Mpf.Unity/Plugins/osx-x64/VisualPinball.Engine.Mpf.dll.meta
68+
git update-index --assume-unchanged VisualPinball.Engine.Mpf.Unity/Plugins/osx-x64/Google.Protobuf.dll.meta
69+
git update-index --assume-unchanged VisualPinball.Engine.Mpf.Unity/Plugins/osx-x64/Grpc.Core.Api.dll.meta
70+
git update-index --assume-unchanged VisualPinball.Engine.Mpf.Unity/Plugins/osx-x64/Grpc.Core.dll.meta
6871
git update-index --assume-unchanged VisualPinball.Engine.Mpf.Unity/Plugins/osx-x64/libgrpc_csharp_ext.dylib.meta
6972
git update-index --assume-unchanged VisualPinball.Engine.Mpf.Unity/Plugins/win-x64/VisualPinball.Engine.Mpf.dll.meta
73+
git update-index --assume-unchanged VisualPinball.Engine.Mpf.Unity/Plugins/win-x64/Google.Protobuf.dll.meta
74+
git update-index --assume-unchanged VisualPinball.Engine.Mpf.Unity/Plugins/win-x64/Grpc.Core.Api.dll.meta
75+
git update-index --assume-unchanged VisualPinball.Engine.Mpf.Unity/Plugins/win-x64/Grpc.Core.dll.meta
7076
git update-index --assume-unchanged VisualPinball.Engine.Mpf.Unity/Plugins/win-x64/grpc_csharp_ext.dll.meta
7177
git update-index --assume-unchanged VisualPinball.Engine.Mpf.Unity/Plugins/win-x86/VisualPinball.Engine.Mpf.dll.meta
78+
git update-index --assume-unchanged VisualPinball.Engine.Mpf.Unity/Plugins/win-x86/Google.Protobuf.dll.meta
79+
git update-index --assume-unchanged VisualPinball.Engine.Mpf.Unity/Plugins/win-x86/Grpc.Core.Api.dll.meta
80+
git update-index --assume-unchanged VisualPinball.Engine.Mpf.Unity/Plugins/win-x86/Grpc.Core.dll.meta
7281
git update-index --assume-unchanged VisualPinball.Engine.Mpf.Unity/Plugins/win-x86/grpc_csharp_ext.dll.meta
7382
```
7483

7584
## License
7685

77-
[MIT](LICENSE)
86+
[MIT](LICENSE)

0 commit comments

Comments
 (0)