Commit b698591a authored by Aaron Bray's avatar Aaron Bray

Merge branch 'patch-1' into 'master'

Update README.md with new IL2CPP contents

See merge request !15
parents e5a228e1 9a36e4cf
......@@ -92,17 +92,18 @@ The binaries/plugins above will be built along with the Pulse engine (steps [her
### IL2CPP Build Support
The Pulse Unity Asset is not currently supported in Unity projects built with the [IL2CPP compiler](https://docs.unity3d.com/Manual/IL2CPP.html). The IL2CPP compiler performs [bytecode stripping](https://docs.unity3d.com/Manual/IL2CPP-BytecodeStripping.html) on the provided Pulse plugins (Google Protocol Buffers used in Pulse for serialization), which results in stripping of code that is actually necessary for Pulse.
The link.xml file (described below) can be used to effectively disable bytecode stripping by preserving both types and full assemblies.
The Pulse Unity Asset will not work out of the box in Unity projects built with the [IL2CPP compiler](https://docs.unity3d.com/Manual/IL2CPP.html) due to [bytecode stripping](https://docs.unity3d.com/Manual/IL2CPP-BytecodeStripping.html).
The provided Pulse plugins are impacted by this (Google Protocol Buffers used in Pulse for serialization), which results in stripping of code that is actually necessary for Pulse.
A link.xml file (contents below) should be placed in your assets folder root to effectively disable bytecode stripping by preserving both types and full assemblies.
```xml
<linker>
<assembly fullname="System" preserve="all"/>
<assembly fullname="System" preserve="all"/>
<assembly fullname="Google.Protobuf" preserve="all"/>
<assembly fullname="DataModelBindings" preserve="all"/>
</linker>
```
Note that the IL2CPP AOT compiler may also error out when processing the provided `Google.Protobuf.dll` managed plugin. We are currently in touch with the Protobuf team to find a solution.
If you need to use the IL2CPP compiler and it is preventing you from integrating Pulse in your Unity application, you can find support on our [Discourse support forum](https://discourse.kitware.com/c/pulse-physiology-engine).
If you need to use the IL2CPP compiler and it is preventing you from integrating Pulse in your Unity application, let us know on our [Discourse support forum](https://discourse.kitware.com/c/pulse-physiology-engine).
### Missing C++ functionality from the Pulse engine in the C# assets
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment