Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/starciad/starascii
🧩 ➥ Library for creating ASCII animations for terminals.
https://github.com/starciad/starascii
animation art ascii cli console cross-plataform csharp dotnet framework graphics libary terminal tools
Last synced: about 1 month ago
JSON representation
🧩 ➥ Library for creating ASCII animations for terminals.
- Host: GitHub
- URL: https://github.com/starciad/starascii
- Owner: Starciad
- License: mit
- Created: 2024-09-10T22:02:00.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-18T18:35:38.000Z (about 2 months ago)
- Last Synced: 2024-10-13T01:41:42.345Z (about 1 month ago)
- Topics: animation, art, ascii, cli, console, cross-plataform, csharp, dotnet, framework, graphics, libary, terminal, tools
- Language: C#
- Homepage:
- Size: 1.02 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# StarASCII
[](./LICENSE)
[](https://www.nuget.org/packages/StarASCII/)
🧩 ➥ Library for creating ASCII animations for terminals.
## Table of Contents
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Contributing](#contributing)
- [License](#license)
## Installation
The latest version is available on [NuGet](https://www.nuget.org/packages/StarASCII/). To install, run:
```bash
dotnet add package StarASCII --version *
```
> Replace the asterisk (*) with the desired version.
Alternatively, clone the repository and reference it manually:
```bash
git clone https://github.com/Starciad/StarASCII.git
```
## Getting Started
After installation, add the `StarASCII` namespace:
```cs
using StarASCII;
```
You can now use the `SAnimation` class to create and run animations:
```cs
SAnimation anim = new SAnimation();
```
Next, add frames using the `AddFrame(SFrame)` method:
```cs
SFrame frame = new SFrame(string, uint);
anim.AddFrame(frame);
```
- `string`: content of the frame.
- `uint`: duration in milliseconds.
Once all frames are added, run the animation:
```cs
anim.Play();
```
> [!IMPORTANT]
> When calling `Play()`, the main thread will be paused according to the frame durations.
Explore the classes and features to fully customize your animations.
### Tips and Recommendations
1. **Frame size:** Keep all frames the same size to avoid visual issues.
2. **Using text files:** For complex animations, save frames in external text files or use `const` or `readonly static` properties to avoid hardcoded ASCII art.
3. **Reuse animations:** To save resources, reuse animations by storing them in collections, lists, or static properties, especially in performance-critical scenarios like loops.
## Samples
Try the sample project [here](./src/StarASCII.Samples/). You can also view some GIFs showcasing the library's capabilities:
- Sample 1: Blinking Eye ![sample_01]
- Sample 2: Walking Man ![sample_02]
- Sample 3: Zebra ![sample_03]
## Issues
Have a problem? Open an issue!
## Contributing
Contributions are welcome! Please check the [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for guidelines.
## License
This project is licensed under the MIT License. See the [LICENSE.md](./LICENSE) file for details.
[sample_01]: ./.github/assets/graphics/samples/sample_01.webp
[sample_02]: ./.github/assets/graphics/samples/sample_02.webp
[sample_03]: ./.github/assets/graphics/samples/sample_03.webp