From 841d8dbd923ba05c42b83b9cc3f3cd5fd8bae80f Mon Sep 17 00:00:00 2001 From: "Simon (darkside) Jackson" Date: Fri, 3 Jun 2016 10:26:37 +0100 Subject: [PATCH] Added ReadME files for the compression and serialization components --HG-- branch : develop_5.3 --- .../CLFZ2-CompressionHelper-ReadME.md | 25 +++++++++++++++++ .../CLFZ2-CompressionHelper-ReadME.md.meta | 8 ++++++ .../Serialization/Serialization-ReadME.md | 27 +++++++++++++++++++ .../Serialization-ReadME.md.meta | 8 ++++++ 4 files changed, 68 insertions(+) create mode 100644 Scripts/Utilities/CLFZ2-CompressionHelper-ReadME.md create mode 100644 Scripts/Utilities/CLFZ2-CompressionHelper-ReadME.md.meta create mode 100644 Scripts/Utilities/Serialization/Serialization-ReadME.md create mode 100644 Scripts/Utilities/Serialization/Serialization-ReadME.md.meta diff --git a/Scripts/Utilities/CLFZ2-CompressionHelper-ReadME.md b/Scripts/Utilities/CLFZ2-CompressionHelper-ReadME.md new file mode 100644 index 0000000..9d42d85 --- /dev/null +++ b/Scripts/Utilities/CLFZ2-CompressionHelper-ReadME.md @@ -0,0 +1,25 @@ +Sourced from Unity forums - [LZF compression and decompression for Unity](http://forum.unity3d.com/threads/lzf-compression-and-decompression-for-unity.152579/) + +#Description# +The LZF Compression component is a useful extension to Unity to be able to compress data for sending over a network or for more efficient saving. + +This was provided via Unity forum guru [mrbroshkin](http://forum.unity3d.com/members/mrbroshkin.124231/) based of [Agent_007](http://forum.unity3d.com/members/agent_007.78088/) initial conversion work. + +#What's included# +The library is complete and has even been patched a few times already through the forum thread, so I took the most stable version without issues. (issus were reported on other versions, so I didn't take them) + +There are some Unit Tests included in the following file: +>Assets\unity-ui-extensions\Scripts\Editor\CompressionTests.cs + +These details some sample use cases and also provide a good way to test that the compression/decompression works as expected. +To run these Unit Tests In Unity 5.3, open the following editor window from the menu to see the tests and run them. +>Window\Editor Tests Runner + +(For earlier versions of Unity, you will need to install the "Unity Test Tools" asset from the store and follow the instructions from there.) + +#Contribute# +Feel free to submit patches (if required) back to the project to increase the scope and enjoy + +#Notes# +When encoding data to byte array's for compression, it's best to use the Unicode character set to avoid issue. Some other encodings don't work as well with this lib. Example details found in the UnitTests. +Part of the reason I added this library, since it's not really UI, is to support the Serialisation component. Both together provide a useful solution for packing data to save or send over a network. \ No newline at end of file diff --git a/Scripts/Utilities/CLFZ2-CompressionHelper-ReadME.md.meta b/Scripts/Utilities/CLFZ2-CompressionHelper-ReadME.md.meta new file mode 100644 index 0000000..68deb1b --- /dev/null +++ b/Scripts/Utilities/CLFZ2-CompressionHelper-ReadME.md.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 125e21ede8cf31746b15797b86e6a479 +timeCreated: 1464945707 +licenseType: Pro +DefaultImporter: + userData: + assetBundleName: + assetBundleVariant: diff --git a/Scripts/Utilities/Serialization/Serialization-ReadME.md b/Scripts/Utilities/Serialization/Serialization-ReadME.md new file mode 100644 index 0000000..9eb1714 --- /dev/null +++ b/Scripts/Utilities/Serialization/Serialization-ReadME.md @@ -0,0 +1,27 @@ +Sourced from Unity forums - [serializehelper-free-save-and-load-utility-de-serialize-all-objects-in-your-scene](http://forum.unity3d.com/threads/serializehelper-free-save-and-load-utility-de-serialize-all-objects-in-your-scene.338148/) + +#Description# +The serializationHelper is a useful extension to Unity to be able to serialise the base Unity structs (such as Vector3 / Quanterion) without having to employ custom classes or convertors. +It uses the standard ISerializationSurrogates to provide a serialisation interface for the base classes themselves + +This starter pack was provided via Unity forum guru [Cherno](http://forum.unity3d.com/members/cherno.245586/) + +#What's included# +Not all classes have had surrogates provided for as yet, here is what is working: +* Color +* Quaternion +* Vector2 +* Vector3 +* Vector4 + +There are some initial templates for other items but they do not seem fully implemented yet: +* GameObject +* Texture2D +* Transform +Feel free to re-enable them by uncommenting their code (in the Surrogates folder) and test. Have a look at the working examples for reference. + +#Contribute# +Feel free to get other surrogates working and submit them back to the project to increase the scope and enjoy + +#Notes# +Part of the reason I added this library, since it's not really UI, is to support the LZF compression component. Both together provide a useful solution for packing data to save or send over a network. \ No newline at end of file diff --git a/Scripts/Utilities/Serialization/Serialization-ReadME.md.meta b/Scripts/Utilities/Serialization/Serialization-ReadME.md.meta new file mode 100644 index 0000000..c690307 --- /dev/null +++ b/Scripts/Utilities/Serialization/Serialization-ReadME.md.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 0b972ef82b6647d4fa774ed6de28650c +timeCreated: 1464945707 +licenseType: Pro +DefaultImporter: + userData: + assetBundleName: + assetBundleVariant: