To make it easy for you to get started with GitLab, here's a list of recommended next steps.
- Add the `BanimatePluginGroup` to your app
- Load one or more animation sets (see below for defining animation sets in files)
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
- Spawn an entity with a `SpriteSheetBundle` and attach a `SpriteAnimationBundle` component, providing a `Handle` to an
animation set
## Add your files
- Watch your sprites doing their thing!
- Optional: Use `AnimationQuery` in one of your systems to control the animations
-[ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-[ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
-[ ] [Set up project integrations](https://lab.lcr.gr/microhacks/micro-banimate/-/settings/integrations)
## Collaborate with your team
### Simple Animations
-[ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
TODO: Describe simple animations
-[ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-[ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-[ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy
- A simple looping animation with a single set of frames and frame rate, no control needed or provided
Use the built-in continuous integration in GitLab.
### Sprite Animations
-[ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
TODO: Describe sprite animations
-[ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-[ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-[ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-[ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
- Sets the name of the animation to play, play the animation. Simple.
- Interrupt the current animation temporarily with an `AnimationOverride`
# Editing this README
### Directional Animations
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
TODO: Describe directional animations
## Suggestions for a good README
- Includes a component for altering the name of a playing animation based on its value, representing direction
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
### Child Animations
Choose a self-explaining name for your project.
## Description
Adding a `ChildAnimationBundle` to an entity will cause its status to by synced to it's `Parent` entity
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
## Animation Sets
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
An animation set maps a name to a series of frames and a frame rate. A given animation has one frame rate for the whole
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
animation,
but different animations can have different frame rates (i.e. a "walk" animation could play at 100ms per frame,
and an "idle" animation could play at 250ms per frame, but you can not set the duration of an individual frame within
either animation).
## Installation
An `AnimationSet` might contains many animations, and a given `AnimationSet` is likely to be attached to many entities.
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
As such,
animations use the `Asset` system to avoid passing around relatively large duplicate objects. Loaders are included
for `JSON` and `TOML`
data types, but only `JSON` is enabled by default. The loaders are not required, and so can therefore be disabled if
another method
of creating `AnimationSet` assets is desired.
## Usage
### Defining animations with JSON
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
With the `json_loader` feature enabled, you can load an animation set from a file with a `.anim.json` suffix that looks
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
like this:
## Roadmap
```json
If you have ideas for releases in the future, it is a good idea to list them in the README.
{
"idle":{
## Contributing
"frames":[
State if you are open to contributions and what your requirements are for accepting them.
1,
2,
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
3
],
"frame_time":250
},
"shoot_right":{
"frames":[
34,
34,
34,
35,
36
],
"frame_time":100
}
}
```
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
### Defining animations with TOML
## Authors and acknowledgment
With the `toml_loader` feature enabled, you can load an animation set from a file with a `.anim.toml` suffix that looks
Show your appreciation to those who have contributed to the project.
like this:
## License
```toml
For open source projects, say how it is licensed.
[idle]
frames=[1,2,3]
frame_time=250
## Project status
[shoot_right]
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
