From 62bfdf3cf7a3f6681f12498c965bf161d61b2758 Mon Sep 17 00:00:00 2001 From: Gabriel Tofvesson Date: Fri, 27 Jul 2018 20:02:31 +0200 Subject: [PATCH 1/3] Create LICENSE --- LICENSE | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b5f7260 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2018 Gabriel Tofvesson + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. From 0d1a9f5bf1cde873b012e4f1cdbed6760e59c030 Mon Sep 17 00:00:00 2001 From: Gabriel Tofvesson Date: Fri, 27 Jul 2018 20:04:56 +0200 Subject: [PATCH 2/3] Create README.md --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1b408d5 --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# SyncedVar +An annotation-based serialization system +Designed to mimic the NetworkedVar and SyncedVar systems found in MLAPI and HLAPI +#Features: +* Module-based serializers +* Ability to remove (or override) default serializers +* Support for value delta serialization +* VarInt compression +* Booleans are represented as bits (as they should), rather than bytes From e63b97fea191c35c10cd0f908050a4e5e8351ffe Mon Sep 17 00:00:00 2001 From: Gabriel Tofvesson Date: Sat, 28 Jul 2018 01:07:44 +0200 Subject: [PATCH 3/3] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1b408d5..6fbc293 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -# SyncedVar -An annotation-based serialization system -Designed to mimic the NetworkedVar and SyncedVar systems found in MLAPI and HLAPI -#Features: +# SyncedVar: *An annotation-based serialization system* +Designed to mimic the NetworkedVar and SyncedVar systems found in MLAPI and HLAPI, this library allows serialization of variables to simplify the program flow when sending data between peers. Alternatively, this library can be used to create a "snapshot" of the current state of a set of variables for rollback at a later time. +## Features * Module-based serializers * Ability to remove (or override) default serializers * Support for value delta serialization * VarInt compression -* Booleans are represented as bits (as they should), rather than bytes +* Booleans are represented as bits (as they should), rather than bytes, allowing for an 8x compression rate +* Support for custom (per-field) serialization flags