KawAnime/README.md

5.8 KiB

KawAnime

License Chat

Features

Disclaimer : KawAnime is built for otaku/anime-fans. The software will contain images and sounds sourced from anime. Do not try if you're not prepared.

Use KawAnime to:

  • Manage your pirate anime life with a single software.
  • Get updated on anime releases as soon as they are subbed (or not).
  • Download or Stream your torrents easily (in-app torrent client included!).
  • Magnet links for all episodes can be generated through the Downloader.
  • Get anime information, news, and seasonal information from your preferred anime information source (Anilist, Kitsu.io, MAL).
  • Manage your anime files (watch and delete on click).
  • Manage local watch lists as well as those from your preferred provider (Anilist, Kitsu.io, MAL).
  • Auto track entry progress on Anilist and Kitsu.io.
  • Keep track of what you watched with the History.
  • Easily binge watch your local anime or while streaming.

Feel free to check the official website for a demo of all the available features.

About OS

KawAnime is completely cross-platform.

If you have any problems installing for your OS, you can contact me anytime in the issues section.

Building

Dependencies

  • Be sure that Npm is installed. You can find how to install npm (node) here.

  • You will need CMake (v3.12 minimum) to build native dependencies as this project using cmake-js; you can download and install CMake here. Also, you will need a C++ compiler to build native libraries (Clang, GCC and MSVC are all supported).

  • You will need to have Boost (version 1.65.0 minimum) installed on your system. You can find Boost here.Only the system library is required by this project.

  • This app uses MPV via mpv.js but you will need libmpv on your machine. You can find instructions on how to install libmpv here.

git clone --recursive https://github.com/Kylart/KawAnime
cd KawAnime/
npm install

If postinstall script fails, it probably means that you lack one of the requirements listed above. You should install them and retry.

Run in dev

Build native bindings
npm run build:bindings
Start app
npm run dev
Lint
npm run lint

Testing

To run tests, you have to build a production ready bundle:

npm run pack

then simply run

npm run test

Generating distributable apps

This feature uses electron-builder.

Find help to use it on your platform here.

For Mac OS

npm run collect:dylibs
npm run dist:mac

For Linux OS

On Linux you'll need to install dependency packages first. Either from source or using your package manager (e.g. apt on Debian-like systems).

Here's the list of the dependencies:

  • (Required) A C/C++ Compiler, gcc is recommended.
  • (Required) Boost > 1.65.0 -- Used by Libtorrent, only the system component is required. You can install libboost-dev or libboost-all-dev using apt
  • (Optional) LibtorrentRasterbar > 1.2 -- If you don't have any valid version installed, the build command will install it for you.
  • (Optional) MPV -- Only if you want to use the internal player. You can install libmpv1 and libavformat-dev using apt

Once all those are installed, you can run the following commands. This will generate a .snap and a .AppImage in the dist folder that you can use. Alternatively you can use the kawanime executable in the dist/linux-unpacked folder.

npm run postinstall
npm run dist:linux

For Windows OS

npm run dist:win

# Or, to have a portable version. This will give you a `KawAnime.exe`
# file that you can move around, e.g. on a USB key
npm run dist:portable

Distributable will then be in the dist folder.

Contributing

Any contribution is appreciated.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request.

Thanks

KawAnime is developed using the following technologies, many thanks to

License

MIT License

Copyright (c) Kylart