{"id":22781804,"url":"https://github.com/fronkongames/gamework-local-data","last_synced_at":"2025-04-15T16:34:29.390Z","repository":{"id":49521179,"uuid":"499910069","full_name":"FronkonGames/GameWork-Local-Data","owner":"FronkonGames","description":"Async load / save local data with compression, encryption and integrity check.","archived":false,"fork":false,"pushed_at":"2022-08-13T20:54:16.000Z","size":2298,"stargazers_count":13,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-28T22:22:14.998Z","etag":null,"topics":["compression","encryption","game-development","gamedev","gamedev-framework","gamedev-library","gamedevelopment","serialization","unity","unity3d"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FronkonGames.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-06-04T18:45:19.000Z","updated_at":"2023-12-19T16:20:01.000Z","dependencies_parsed_at":"2022-08-12T20:20:11.893Z","dependency_job_id":null,"html_url":"https://github.com/FronkonGames/GameWork-Local-Data","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FronkonGames%2FGameWork-Local-Data","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FronkonGames%2FGameWork-Local-Data/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FronkonGames%2FGameWork-Local-Data/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FronkonGames%2FGameWork-Local-Data/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FronkonGames","download_url":"https://codeload.github.com/FronkonGames/GameWork-Local-Data/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249108906,"owners_count":21214088,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["compression","encryption","game-development","gamedev","gamedev-framework","gamedev-library","gamedevelopment","serialization","unity","unity3d"],"created_at":"2024-12-11T21:08:39.128Z","updated_at":"2025-04-15T16:34:29.367Z","avatar_url":"https://github.com/FronkonGames.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003cimg src=\"docs/Animation.gif\" /\u003e\u003c/p\u003e\n\u003cp align=\"center\"\u003e\u003cb\u003eAsync Load/Save Local Data With Compression, Encryption And Integrity Check\u003c/b\u003e\u003c/p\u003e\n\u003cbr\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca style=\"text-decoration:none\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/package-json/v/FronkonGames/GameWork-Local-Data?style=flat-square\" alt=\"version\" /\u003e\n  \u003c/a\u003e  \n  \u003ca style=\"text-decoration:none\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/license/FronkonGames/GameWork-Local-Data?style=flat-square\" alt=\"license\" /\u003e\n  \u003c/a\u003e\n  \u003ca style=\"text-decoration:none\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/languages/top/FronkonGames/GameWork-Local-Data?style=flat-square\" alt=\"top language\" /\u003e\n  \u003c/a\u003e\n  \u003ca style=\"text-decoration:none\"\u003e\n    \u003cimg src=\"https://img.shields.io/codacy/grade/f124de6116ed47099d017f8ae6011e26?style=flat-square\" alt=\"code quality\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n'**Local Data**' is a module of '**Game:Work**' dedicated to read and write local files asynchronously.\n\n## Features 🎇\n\n* Fully asynchronous read, load and cancel.\u003cbr\u003e\n* Integrity check using MD5, SHA-1, SHA-256 or SHA-512 algorithms.\u003cbr\u003e\n* Compression / decompression using algorithms: GZip, Zip or Brotli.\u003cbr\u003e\n* Encryption / decryption using algorithms: AES, DES, RC2, DES or TripleDES.\u003cbr\u003e\n* Supports typical Unity data such as: Vector, Quaternion, Color, etc.\n\n## Requisites 🔧\n\n- Unity 2020.3 or higher.\n- [Game:Work Core](https://github.com/FronkonGames/GameWork-Core).\n- [Game:Work Foundation](https://github.com/FronkonGames/GameWork-Foundation).\n- Test Framework 1.1.31 or higher.\n\n## Installation 📦️\n\n### Editing your 'manifest.json'\n\n- Open the manifest.json file of your Unity project.\n- In the section \"dependencies\" add:\n\n```c#\n{\n  ...\n  \"dependencies\":\n  {\n    ...\n    \"FronkonGames.GameWork.Modules.LocalData\": \"git+https://github.com/FronkonGames/GameWork-Local-Data.git\",\n    \"FronkonGames.GameWork.Core\": \"git+https://github.com/FronkonGames/GameWork-Core.git\",\n    \"FronkonGames.GameWork.Foundation\": \"git+https://github.com/FronkonGames/GameWork-Foundation.git\"\n  }\n  ...\n}\n```\n\n### Git\n\nFirst clone the dependencies inside your Assets folder:\n\n```\ngit clone https://github.com/FronkonGames/GameWork-Foundation.git\n\ngit clone https://github.com/FronkonGames/GameWork-Core.git\n```\n\nThen clone the repository:\n\n```\ngit clone https://github.com/FronkonGames/GameWork-Local-Data.git\n```\n\n## Use 🚀\n\nCreate a class inheriting from ILocalData and add the attribute _Serializable_:\n\n```c#\n[Serializable]\npublic class MyLocalData : ILocalData\n{\n  public string Signature =\u003e \"MySignature\";\n  \n  public string playerName = \"Guybrush Threepwood\";\n  \n  public Vector3 position = new(0.0f, -10.0f, 0.0f);\n}\n```\n\nTo serialize it in the file '_Guy.brush_':\n\n```c#\nlocalDataModule.Write(myLocalData, \"Guy.brush\", null, (result) =\u003e\n{\n  if (result == FileResult.Ok)\n    Debug.Log(\"Guybrush Threepwood saved!\");\n  else\n    Debug.Error($\"{result} writing 'Guy.brush'.\");\n});\n```\n\nTo deserialise the file '_Guy.brush_' into an object:\n\n```c#\nMyLocalData myLocaldata = null;\n\nlocalDataModule.Read\u003cMyLocalData\u003e(\"Guy.brush\", null, (result, file) =\u003e\n{\n  if (result == FileResult.Ok)\n    myLocalData = file;\n  else\n    Debug.Error($\"{result} reading 'Guy.brush'.\");\n});\n```\n\n## License 📜\n\nCode released under [MIT License](https://github.com/FronkonGames/GameWork-Scene-Module/blob/main/LICENSE).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffronkongames%2Fgamework-local-data","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffronkongames%2Fgamework-local-data","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffronkongames%2Fgamework-local-data/lists"}