{"id":16203415,"url":"https://github.com/emirkivrak/gitostory","last_synced_at":"2025-03-19T07:30:50.174Z","repository":{"id":250498834,"uuid":"834604497","full_name":"emirkivrak/Gitostory","owner":"emirkivrak","description":"Gitostory is an git-history system tailored for Unity. It focuses on asset history and progress. View, Compare and Restore previous versions of your assets.","archived":false,"fork":false,"pushed_at":"2024-07-29T13:02:56.000Z","size":3798,"stargazers_count":27,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-28T16:19:08.489Z","etag":null,"topics":["git","history","unity","version-control"],"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/emirkivrak.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-27T19:25:15.000Z","updated_at":"2024-08-27T04:04:19.000Z","dependencies_parsed_at":"2024-07-27T22:43:43.676Z","dependency_job_id":"6832f4a0-f97b-44a5-99a2-3666260db89f","html_url":"https://github.com/emirkivrak/Gitostory","commit_stats":null,"previous_names":["emirkivrak/gitostory"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emirkivrak%2FGitostory","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emirkivrak%2FGitostory/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emirkivrak%2FGitostory/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emirkivrak%2FGitostory/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/emirkivrak","download_url":"https://codeload.github.com/emirkivrak/Gitostory/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243976647,"owners_count":20377695,"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":["git","history","unity","version-control"],"created_at":"2024-10-10T09:54:05.702Z","updated_at":"2025-03-19T07:30:48.691Z","avatar_url":"https://github.com/emirkivrak.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gitostory\n\n![Gitostory Logo](Images/gitostory_logo.png)\n\n## Overview\n\n**Gitostory** is a Unity package that enables you to view and compare previous versions of your assets without altering the current state.\n\nWith Gitostory, you can:\n- View the history of any asset directly within Unity.\n- Compare previous versions of prefabs, scripts, and other assets without rolling back.\n- Rollback to any previous version if needed.\n- Gain insights and side by side comparison for prefabs.\n- Get current state of file and discard current changes if you want.\n- Add files to .gitignore with one click.\n\n## Asset Store\n\nGitostory will soon be available as a free asset in the Version Control section of the Unity Asset Store.\n\n## Prerequisites\n\n- A Unity project with an initialized Git repository (`.git` folder present).\n- Git installed on your system.\n\n## Compatibility\n\nGitostory has been tested and works on the following platforms:\n- **Windows**\n- **MacOS**\n- **Linux**\n\n### Unity\n\nGitostory is compatible with Unity **2018.3 and later**, as these versions support the .NET Standard 2.0 API set required by LibGit2Sharp.\n\n### Git\n\nIt is recommended to use **Git version 2.20 or later** to ensure compatibility with features and performance improvements.\n\n\n## Installation\n\n1. **Download the Package**:\n    - Download latest release from releases section or clone this repo.\n\n2. **Add to Your Project**:\n    - Open your Unity project.\n    - Drag and drop the Gitostory package folder into your project's `Assets` folder.\n\n3. **Configure Gitostory If Needed**:\n    - Gitostory will most likely work without any configuration. If it doesn't, please check your project's Git path.\n    - Open the Gitostory settings via `Window \u003e Gitostory \u003e Gitostory Settings`.\n    - Set the `Temporary Root Folder` and `Repository Root Folder` as needed.\n\n\n### Viewing History\n\n1. Right-click on an asset.\n2. Select `Gitostory \u003e Show Story`.\n\n![Show History](Images/gitostory_usg.png)\n\n### Preview Any Asset Instantly\n\n1. In the history window, select a commit.\n\n![Comparison Gif](Images/gitostory_usage.gif) \n\n### Comparing Prefabs \n\n1. In the history window, select a commit.\n2. Click `Open in Prefab Comparison` or the appropriate comparison option.\n\n![Comparison View](Images/gitostory_prefab.png) \n\n\n### Rolling Back\n\n1. In the history window, select a commit.\n2. Click `Rollback`.\n3. Confirm the rollback in the prompt.\n\n\n## Usage From Code\n\nRemember, Gitostory is living in editor space.\n\n```csharp\nusing GitostorySpace; // import gitostory space\nusing System.Collections;\nusing System.Collections.Generic;\nusing UnityEngine;\n\n/// \u003csummary\u003e\n/// This method is an example of how to use Gitostory from code.\n/// \u003c/summary\u003e\npublic class GitostoryUsageFromCodeExample \n{\n   public static void Test(string filePath)\n    {\n        Gitostory gitostory = new Gitostory(); // create a instance\n\n        // Use operations like getting status\n        bool isFileModified = gitostory.IsFileModified(filePath); \n\n        // Get working branch\n        string branchName = gitostory.GetCurrentBranchName();\n\n        // Get all past commits where this file changed.\n        List\u003cGitostoryPastCommitData\u003e allCommitsForFile = gitostory.GetAllCommits(filePath);\n        foreach (var commit in allCommitsForFile)\n        {\n            Debug.Log(\"Commit Hash: \" + commit.CommitHash);\n            Debug.Log(\"Commit Message: \" + commit.CommitMessage);\n            Debug.Log(\"Commit Date: \" + commit.CommitDate);\n            Debug.Log(\"Commit Author: \" + commit.Author);\n        }\n    }\n}\n```\n\n\n\n## Contributing\n\nAll pull requests makes this package better will be reviewed and accepted.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n## Support\n\nFor support and questions, just open a ticket.\n\n\n## Dependencies\n\nGitostory is using [LibGit2Sharp](https://github.com/libgit2/libgit2sharp) library to provide Git functionalities within the Unity Editor. I'm grateful for the contributions of the LibGit2Sharp community. **LibGit2Sharp is used as-is**.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femirkivrak%2Fgitostory","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femirkivrak%2Fgitostory","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femirkivrak%2Fgitostory/lists"}