{"id":15066071,"url":"https://github.com/starciad/starascii","last_synced_at":"2025-04-10T13:40:41.042Z","repository":{"id":257306821,"uuid":"855445304","full_name":"Starciad/StarASCII","owner":"Starciad","description":"🧩 ➥ Library for creating ASCII animations for terminals.","archived":false,"fork":false,"pushed_at":"2024-09-18T18:35:38.000Z","size":1070,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-06T12:43:37.400Z","etag":null,"topics":["animation","art","ascii","cli","console","cross-plataform","csharp","dotnet","framework","graphics","libary","terminal","tools"],"latest_commit_sha":null,"homepage":"","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/Starciad.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-10T22:02:00.000Z","updated_at":"2025-03-01T19:43:09.000Z","dependencies_parsed_at":"2024-09-15T21:53:10.468Z","dependency_job_id":"4e350663-1f0f-4462-bae5-5c24d43e7f6d","html_url":"https://github.com/Starciad/StarASCII","commit_stats":null,"previous_names":["starciad/starascii"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Starciad%2FStarASCII","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Starciad%2FStarASCII/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Starciad%2FStarASCII/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Starciad%2FStarASCII/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Starciad","download_url":"https://codeload.github.com/Starciad/StarASCII/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248225943,"owners_count":21068088,"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":["animation","art","ascii","cli","console","cross-plataform","csharp","dotnet","framework","graphics","libary","terminal","tools"],"created_at":"2024-09-25T01:01:03.418Z","updated_at":"2025-04-10T13:40:41.011Z","avatar_url":"https://github.com/Starciad.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# StarASCII\n\n[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](./LICENSE)\n[![NuGet](https://img.shields.io/nuget/v/StarASCII.svg?label=NuGet)](https://www.nuget.org/packages/StarASCII/)\n\n🧩 ➥ Library for creating ASCII animations for terminals.\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Getting Started](#getting-started)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Installation\n\nThe latest version is available on [NuGet](https://www.nuget.org/packages/StarASCII/). To install, run:\n\n```bash\ndotnet add package StarASCII --version *\n```\n\n\u003e Replace the asterisk (*) with the desired version.\n\nAlternatively, clone the repository and reference it manually:\n\n```bash\ngit clone https://github.com/Starciad/StarASCII.git\n```\n\n## Getting Started\n\nAfter installation, add the `StarASCII` namespace:\n\n```cs\nusing StarASCII;\n```\n\nYou can now use the `SAnimation` class to create and run animations:\n\n```cs\nSAnimation anim = new SAnimation();\n```\n\nNext, add frames using the `AddFrame(SFrame)` method:\n\n```cs\nSFrame frame = new SFrame(string, uint);\nanim.AddFrame(frame);\n```\n\n- `string`: content of the frame.\n- `uint`: duration in milliseconds.\n\nOnce all frames are added, run the animation:\n\n```cs\nanim.Play();\n```\n\n\u003e [!IMPORTANT]\n\u003e When calling `Play()`, the main thread will be paused according to the frame durations.\n\nExplore the classes and features to fully customize your animations.\n\n### Tips and Recommendations\n\n1. **Frame size:** Keep all frames the same size to avoid visual issues.\n2. **Using text files:** For complex animations, save frames in external text files or use `const` or `readonly static` properties to avoid hardcoded ASCII art.\n3. **Reuse animations:** To save resources, reuse animations by storing them in collections, lists, or static properties, especially in performance-critical scenarios like loops.\n\n## Samples\n\nTry the sample project [here](./src/StarASCII.Samples/). You can also view some GIFs showcasing the library's capabilities:\n\n- Sample 1: Blinking Eye ![sample_01]\n- Sample 2: Walking Man ![sample_02]\n- Sample 3: Zebra ![sample_03]\n\n## Issues\n\nHave a problem? Open an issue!\n\n## Contributing\n\nContributions are welcome! Please check the [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for guidelines.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE.md](./LICENSE) file for details.\n\n\u003c!-- IMAGES --\u003e\n[sample_01]: ./.github/assets/graphics/samples/sample_01.webp\n[sample_02]: ./.github/assets/graphics/samples/sample_02.webp\n[sample_03]: ./.github/assets/graphics/samples/sample_03.webp\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstarciad%2Fstarascii","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstarciad%2Fstarascii","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstarciad%2Fstarascii/lists"}