{"id":16369154,"url":"https://github.com/rhys-vdw/peachy-tween","last_synced_at":"2025-03-21T01:31:21.317Z","repository":{"id":44940377,"uuid":"513146884","full_name":"rhys-vdw/peachy-tween","owner":"rhys-vdw","description":"A tweening library for Unity designed to be simple to use and extend.","archived":false,"fork":false,"pushed_at":"2022-11-20T13:42:46.000Z","size":777,"stargazers_count":7,"open_issues_count":38,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-12T02:54:42.681Z","etag":null,"topics":["tween","tweening-engine","tweening-library","unity","unity3d","unity3d-plugin"],"latest_commit_sha":null,"homepage":"https://peachy-tween.rhys.computer/","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/rhys-vdw.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}},"created_at":"2022-07-12T13:09:13.000Z","updated_at":"2024-07-06T01:59:45.000Z","dependencies_parsed_at":"2022-08-03T16:30:15.635Z","dependency_job_id":null,"html_url":"https://github.com/rhys-vdw/peachy-tween","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhys-vdw%2Fpeachy-tween","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhys-vdw%2Fpeachy-tween/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhys-vdw%2Fpeachy-tween/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhys-vdw%2Fpeachy-tween/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rhys-vdw","download_url":"https://codeload.github.com/rhys-vdw/peachy-tween/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221810762,"owners_count":16884188,"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":["tween","tweening-engine","tweening-library","unity","unity3d","unity3d-plugin"],"created_at":"2024-10-11T02:54:41.787Z","updated_at":"2024-10-28T08:59:51.929Z","avatar_url":"https://github.com/rhys-vdw.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PeachyTween :peach:\n\n[![openupm](https://img.shields.io/npm/v/computer.rhys.peachy-tween?label=openupm\u0026registry_uri=https://package.openupm.com\u0026style=flat-square)](https://openupm.com/packages/computer.rhys.peachy-tween/)\n[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n\nA tweening library for Unity designed to be simple to use and extend.\n\n## Background\n\nCreated as an alternative to [DOTween](https://github.com/Demigiant/dotween/), which has a proprietary license with some limitations. PeachyTween intends to create a similarly powerful tweening library that can be installed by UPM and allows public forks and distribution.\n\nPeachyTween does not aim to be API compatible with DOTween, nor to fully mirror its functionality.\n\n:warning: **PeachyTween is still in early development, and is untested**\n\n## Install\n\n### Installing from OpenUPM\n\n[OpenUPM package](https://openupm.com/packages/computer.rhys.peachy-tween/).\n\nPackage can be installed from [OpenUPM](https://openupm.com/) using [OpenUPM CLI](https://openupm.com/docs/getting-started.html);\n\n```console\n$ openupm add computer.rhys.peachy-tween\n```\n\n### Installing from GitHub\n\n[GitHub repository](https://github.com/rhys-vdw/peachy-tween).\n\nTo add to you Unity project, first add the internal dependency [ecslite](https://github.com/LeoECSCommunity/ecslite).\n\nIn Unity package manager, select \"Add package from git URL...\" and add the following two URLs:\n\n1. `https://github.com/LeoECSCommunity/ecslite.git#1.0.0`\n2. `https://github.com/rhys-vdw/peachy-tween.git`\n\nOr add the following two lines to `dependencies` in your `manifest.json`:\n\n```json\n\"dependencies\": {\n  \"com.leoecscommunity.ecslite\": \"https://github.com/LeoECSCommunity/ecslite.git#1.0.0\",\n  \"computer.rhys.peachy-tween\": \"https://github.com/rhys-vdw/peachy-tween.git\",\n```\n\n_Installation will streamlined before full release._\n\n## Usage\n\n```cs\nusing UnityEngine;\nusing PeachyTween;\n\npublic class PeachyExample : MonoBehaviour\n{\n  void Start()\n  {\n    Peachy.Tween(\n      from: 0f,\n      to: 5f,\n      duration: 4f,\n      onChange: v =\u003e Debug.Log($\"value = {v}\")\n    );\n\n    transform\n      .TweenLocalRotation(Quaternion.Euler(90, 90, 90), 2f)\n      .Slerp()\n      .Ease(Ease.BounceInOut)\n      .Loop(4)\n      .OnLoop(() =\u003e Debug.Log(\"Loop complete\"))\n      .OnKill(() =\u003e Debug.Log(\"Four loops complete\"));\n  }\n}\n```\n\n## API\n\n[API Documentation](https://peachy-tween.rhys.computer/api/PeachyTween.html).\n\n## Contributing\n\nContributions welcome. If you wish to make a pull request, please open an issue first.\n\nSee the [GitHub project](https://github.com/rhys-vdw/peachy-tween/projects/1) for the development roadmap.\n\n### Environment setup\n\nTo work on PeachyTween:\n\n1. Clone the GitHub repo.\n2. Create a new Unity project.\n3. In the package manager window, select \"Add package from disk...\" and select your local PeachyTween folder.\n4. Enable tests in the editor ([see below](#enabling-tests-in-the-editor)).\n\n### Enabling tests in the editor\n\nContributions should have test coverage. To run the test suite, edit your project's `manifest.json` to include the following entry:\n\n```json\n  \"testables\": [\n    \"computer.rhys.peachy-tween\"\n  ]\n```\n\n## License\n\n[MIT © Rhys van der Waerden](https://github.com/rhys-vdw/peachy-tween/blob/main/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frhys-vdw%2Fpeachy-tween","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frhys-vdw%2Fpeachy-tween","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frhys-vdw%2Fpeachy-tween/lists"}