Skip to content

gmitch215/kasciffy

kasciffy

πŸ“ Asciffy images and videos

Overview

Kotlin GitHub License

badge-android badge-mac badge-jvm badge-linux-x64 badge-windows badge-js

Kasciffy is a Kotlin/Multiplatform library, CLI tool, and Application for converting images and videos into ASCII art. It is designed to be simple and easy to use, with a focus on performance and flexibility. The library can be used in a variety of applications, including command-line tools, desktop applications, and web applications.

Installation

Maven

<dependencies>
    <dependency>
        <groupId>dev.gmitch215.kasciffy</groupId>
        <artifactId>kasciffy-core</artifactId>
        <version>[VERSION]</version>
    </dependency>
</dependencies>

Gradle (Groovy)

dependencies {
    implementation 'dev.gmitch215.kasciffy:kasciffy-core:[VERSION]'
}

Gradle (Kotlin DSL)

dependencies {
    implementation("dev.gmitch215.kasciffy:kasciffy-core:[VERSION]")
}

Browser

To use Kasciffy in a browser, you can include the following script tag in your HTML file. Make sure to replace <version> with the desired version of Kasciffy.

Kasciffy is not supported on server-side JavaScript like Node.js.

<script src="https://cdn.gmitch215.dev/lib/kasciffy/kasciffy-core-<version>.js"></script>

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request.