https://github.com/tnthomas/bang-scriptable-events
An event system for Unity based upon Ryan Hipple's implementation presented at Unite 2017
https://github.com/tnthomas/bang-scriptable-events
csharp events scriptableobject unity
Last synced: 20 days ago
JSON representation
An event system for Unity based upon Ryan Hipple's implementation presented at Unite 2017
- Host: GitHub
- URL: https://github.com/tnthomas/bang-scriptable-events
- Owner: TNThomas
- License: mit
- Created: 2023-01-27T17:56:48.000Z (about 2 years ago)
- Default Branch: develop
- Last Pushed: 2023-02-10T21:15:52.000Z (about 2 years ago)
- Last Synced: 2024-03-25T03:46:23.718Z (about 1 year ago)
- Topics: csharp, events, scriptableobject, unity
- Language: C#
- Homepage:
- Size: 163 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Scriptable Events
Event system for Unity based upon Ryan Hipple's implementation presented at Unite 2017
## Installation
Scriptable Events is used through [Unity's Package Manager](https://docs.unity3d.com/Manual/CustomPackages.html). In order to use it you'll need to add the following lines to your `Packages/manifest.json` file. After that you'll be able to visually control what specific version of Scriptable Events you're using from the package manager window in Unity. This has to be done so your Unity editor can connect to NPM's package registry.
```json
{
"scopedRegistries": [
{
"name": "NPM",
"url": "https://registry.npmjs.org",
"scopes": [
"com.bang"
]
}
],
"dependencies": {
"com.bang.scriptable-events": "1.0.0"
}
}
```
## Releases
Archives of specific versions and release notes are available on the [releases page](https://github.com/TNThomas/bang-scriptable-events/releases).
## Nightly Builds
To access nightly builds of the `develop` branch that are package manager friendly, you'll need to manually edit your `Packages/manifest.json` as so.
```json
{
"dependencies": {
"com.bang.scriptable-events": "https://github.com/TNThomas/bang-scriptable-events.git#nightly"
}
}
```
Note that to get a newer nightly build you must delete this line and any related lock data in the manifest, let Unity rebuild, then add it back. As Unity locks the commit hash for Git urls as packages.
## Development Environment
If you wish to run the development environment you'll need to install the [Node.js](https://nodejs.org/en/) version in the [.nvmrc](.nvmrc) file. The easiest way to do this is install [NVM](https://github.com/nvm-sh/nvm) and run `nvm use`.
Once you've installed Node.js, run the following from the root once.
`npm install`
If you wish to create a build run `npm run build` from the root and it will populate the `dist` folder.
### Making Commits
All commits should be made using [Commitizen](https://github.com/commitizen/cz-cli) (which is automatically installed when running `npm install`). Commits are automatically compiled to version numbers on release so this is very important. PRs that don't have Commitizen based commits will be rejected.
To make a commit type the following into a terminal from the root.
```bash
npm run commit
```
### How To Contribute
Please see the [CONTRIBUTIONS.md](CONTRIBUTING.md) file for full details on how to contribute to this project.
---
This project was generated with [Oyster Package Generator](https://github.com/ashblue/oyster-package-generator).