{"id":19840085,"url":"https://github.com/faster-games/whiskey","last_synced_at":"2026-05-19T05:41:16.625Z","repository":{"id":74700087,"uuid":"378740420","full_name":"faster-games/whiskey","owner":"faster-games","description":"Data and Events framework for Unity. 🥃⚡","archived":false,"fork":false,"pushed_at":"2021-10-24T03:10:39.000Z","size":775,"stargazers_count":3,"open_issues_count":11,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-28T22:21:51.088Z","etag":null,"topics":["data","events","framework","unity3d"],"latest_commit_sha":null,"homepage":"https://whiskey.faster-games.com","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/faster-games.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","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":"2021-06-20T21:08:23.000Z","updated_at":"2023-11-22T22:22:53.000Z","dependencies_parsed_at":null,"dependency_job_id":"55325567-1b10-4402-be94-b651996d5204","html_url":"https://github.com/faster-games/whiskey","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/faster-games/whiskey","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faster-games%2Fwhiskey","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faster-games%2Fwhiskey/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faster-games%2Fwhiskey/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faster-games%2Fwhiskey/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/faster-games","download_url":"https://codeload.github.com/faster-games/whiskey/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faster-games%2Fwhiskey/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279007339,"owners_count":26084282,"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","status":"online","status_checked_at":"2025-10-11T02:00:06.511Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["data","events","framework","unity3d"],"created_at":"2024-11-12T12:25:32.410Z","updated_at":"2025-10-11T13:32:56.789Z","avatar_url":"https://github.com/faster-games.png","language":"C#","funding_links":["https://www.buymeacoffee.com/bengreenier"],"categories":[],"sub_categories":[],"readme":"# Whiskey\n\nData and Events framework for Unity. 🥃⚡\n\n![Project logo; A pink package on a grey background, next to the text \"Whiskey\" in purple](./Documentation~/header.png)\n\n![GitHub package.json version](https://img.shields.io/github/package-json/v/faster-games/whiskey)\n[![openupm](https://img.shields.io/npm/v/com.faster-games.whiskey?label=openupm\u0026registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.faster-games.whiskey/)\n[![CI](https://github.com/faster-games/whiskey/actions/workflows/main.yml/badge.svg)](https://github.com/faster-games/whiskey/actions/workflows/main.yml)\n[![Discord](https://img.shields.io/discord/862006447919726604)](https://discord.gg/QfQE6rWQqq)\n\nWhiskey is a framework for managing data and events within [Unity](https://unity3d.com). It leans heavily on [ScriptableObject](https://docs.unity3d.com/Manual/class-ScriptableObject.html), and is inspired by [Ryan Hipple's Unite 2017 Talk](https://www.youtube.com/watch?v=raQ3iHhE_Kk). Whiskey lets game designers own and edit data definitions while programmers continue to evolve code - Whiskey brings the two together with references, to reduce merge conflicts.\n\nGoals:\n\n- Create, Edit, and Visualize data within the Editor, not code.\n- Encourage decoupling, by using asset references rather than singletons.\n- Quickly swap between data constants and references without rewriting code.\n\nFeatures:\n\n- Boxed data, stored as assets on disk using [ScriptableObject](https://docs.unity3d.com/Manual/class-ScriptableObject.html).\n- Weighted loot tables, for easy to manage [probability based loot drops](https://lostgarden.home.blog/2014/12/08/loot-drop-tables/).\n- Events, stored as assets on disk using [ScriptableObject](https://docs.unity3d.com/Manual/class-ScriptableObject.html).\n- Event Listeners, for binding to Events using [MonoBehaviours](https://docs.unity3d.com/Manual/class-MonoBehaviour.html).\n- References, for consuming data in code indirectly.\n\n## Installing\n\nThis package supports [openupm](https://openupm.com/packages/com.faster-games.whiskey/) - you can install it using the following command:\n\n```\nopenupm add com.faster-games.whiskey\n```\n\nOr by adding directly to your `manifest.json`:\n\n\u003e Note: You may also use specific versions by appending `#{version}` where version is a [Release tag](https://github.com/faster-games/whiskey/releases) - e.g. `#v1.2.0`.\n\n```\ndependencies: {\n\t...\n\t\"com.faster-games.whiskey\": \"git+https://github.com/faster-games/whiskey.git\"\n}\n```\n\nOr by using [Package Manager](https://docs.unity3d.com/Manual/upm-ui-giturl.html) to \"Add a package from Git URL\", using the following url:\n\n```\nhttps://github.com/faster-games/whiskey.git\n```\n\n## Documentation\n\n\u003ccenter\u003e\n\n[Manual 📖](https://whiskey.faster-games.com/manual/getting-started.html) | [Scripting API 🔎](https://whiskey.faster-games.com/ref/FasterGames.Whiskey.html)\n\n\u003c/center\u003e\n\n\n### Quickstart\n\n\u003e Disclaimer: By nature, Whiskey isn't easy to demonstrate. As such, this may not be as \"quick\" as you'd expect! 😅\n\n- Right click in the [Project Window](https://docs.unity3d.com/Manual/ProjectView.html) select: `Create, Whiskey, Boxes, Int`\n- Name the created data instance\n- Select the data instance\n- Edit the data in the [Inspector Window](https://docs.unity3d.com/Manual/UsingTheInspector.html)\n- Right click in the [Project Window](https://docs.unity3d.com/Manual/ProjectView.html) select: `Create, C# Script`\n- Name the created script `IntTestBehaviour`\n- Edit the script, adding the following:\n```cs\nusing FasterGames.Whiskey.Boxes;\nusing UnityEngine;\n\npublic class IntTestBehaviour : MonoBehaviour\n{\n    public Ref\u003cint\u003e intRef;\n\n    private void Start()\n    {\n        Debug.Log(intRef.Value);\n    }\n}\n```\n- Right click in the [Hierarchy Window](https://docs.unity3d.com/Manual/Hierarchy.html) select: `Create Empty`\n- Name the created object\n- Select the object in the [Hierarchy Window](https://docs.unity3d.com/Manual/Hierarchy.html), then in the [Inspector Window](https://docs.unity3d.com/Manual/UsingTheInspector.html) select `Add Component` and search for `IntTestBehaviour`, selecting the first result (which should be the script you created above)\n- Note the `Int Ref` field is displayed, by default it is a `Direct` reference. A direct reference is effectively a hard coded value.\n- Select the `Direct` dropdown, and change it to `Boxed`. Note the field changes, allowing you to drag and drop an object reference, and showing an additional dropdown field.\n- Ensure the additional dropdown field is set to `BoxedInt`, which will allow the editor to more accurately assist you in selecting the object.\n- Click the object reference field, and select the data instance you created above.\n- You have now made your first data reference using Whiskey. Run the code, and note that the value stored in your data instance is logged by the `IntTestBehaviour` script on `Start`.\n\n🚀🚀🚀 Thanks for bearing with us! There's a lot of features in Whiskey, this quickstart only demonstrates one. To learn more, see [The manual](https://whiskey.faster-games.com/manual/getting-started.html).\n\n## Supporting the project\n\nIf this project saved you some time, and you'd like to see it continue to be invested in, consider [buying me a coffee. ☕](https://www.buymeacoffee.com/bengreenier) I do this full-time, and every little bit helps! 💙\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffaster-games%2Fwhiskey","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffaster-games%2Fwhiskey","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffaster-games%2Fwhiskey/lists"}