Kiranime

documentation v3.5.27

Introduction

First of all, Thank you so much for purchasing this template and for being my loyal customer. You are awesome!
You are entitled to get updates to this product + exceptional support from the author directly.

This documentation is to help you regarding each step of installation and customization. Please go through the documentation carefully to understand how this template is made and how to edit this properly. Basic HTML and CSS knowledge is required to customize this template. You may learn basics from w3schools, Developer.mozilla.

Features

  1. Anime info Grabber from MAL/Anilist/TheMovieDB
  2. Episode grabber From TheMovieDB
  3. Episode import from CSV file
  4. User account
  5. User Notification system
  6. User bookmark or watchlist system
  7. Hero Slider
  8. Popular list widget
  9. Anime list widget
  10. Scheduled Widget
  11. Most popular widget
  12. Customizable color
  13. Trending widget
  14. Featured widget
  15. Embed using URL or Shortcode or HTML directly (iframe or video)
  16. Auto embed from gogoanime***

Requirements

You will need the following requirements to install and use kiranime Theme.

  1. Web Server: NginX, Litespeed (Openlitespeed), Apache
  2. PHP version 8.2 or later (Should be already available on many panel or hosting. If not, please ask your hosting.)
  3. Redis software if you want to use redis as cache driver.
  4. Memcached software and Memcached Extension for PHP if you want to use memcached as cache driver.
  5. WordPress version 6.x or later

Be carefull if updating or installing. It's recommended to put the site into maintenance mode before installing the theme.
No support is provided for faulty customization.

Getting Started

You have to install WordPress and setup it first. Please follow the next section to see the tutorial.

How to Install WordPress

Please read more about WordPress here. WordPress Installation via FTP.

How to Install Theme

This section assumes that you have already installed WordPress and Ready.

Uploading the theme into wp-admin

  1. Login on your admin panel.
  2. Go to Appearance -> Install Themes
  3. Upload -> and "Select file" which will open the File Upload dialog window.
  4. Browse to the folder where you have kiranime_pro.zip (Kiranime Theme/Main Theme/kiranime_pro.zip) and upload it.
  5. Now you can activate the theme.

Upload via FTP

  1. Connect to your FTP using a FTP software, example Filezilla.
  2. Unzip the kiranime_pro.zip (Kiranime Theme/Main Theme/kiranime_pro.zip) file on your computer.
  3. Upload the extracted kiranime theme folder into wp-content / themes in your WordPress installation.
  4. Login on your WordPress admin panel.
  5. Go to Appearance and activate kiranime.

Before Using The Theme

Before using the theme, make sure to check these.

  1. Mixed HTTP/HTTPS Error

    Make sure your site uses HTTPS, mixed HTTP/HTTPS will cause the theme to not work properly.

  2. WP REST API

    Make sure your WordPress REST API is not disabled, check by visiting https://yourdomain/wp-json. change "yourdomain" to your domain.

Installing Required Features

Install Optional Plugin

Installing Kirki Customizer Plugin
  1. Login on your admin panel.

  2. Go to Plugins -> Add New Plugin

  3. Search for Kirki customizer plugin

  4. Click install and activate.

Necessary Settings

Permalink Settings
  1. Go to Settings -> Permalink

  2. Select "Post Name" like so:

  3. Scroll down and click save.

Activating Theme

Activation step

  1. Go to Kiranime Tools

  2. Grab Your license key from Tukutema.
  3. Fill the license and email field.
  4. Click activate and wait for the result.
  5. Now your theme should be activated.

Creating Necessary Page (If not created)

Page Template Available

How to apply custom page template

  1. A-Z List

    For anime list by alphabet order.

  2. Continue Watching (history)

    For the user's history.

  3. Homepage

    For the homepage.

  4. News Archive

    For the archive template (post) articles.

  5. User notification

    For the user's notification page.

  6. user Profile page

    For the user's profile page.

  7. User settings

    For the user's setting page.

  8. User watchlist

    For the user's watchlist page.

  9. Advanced Search

    For the advanced search page.

Widgets

Kiranime uses widget to display the homepage. These are the widgets available.

Open Appearance -> Widgets to customize the widget area.

  1. Kiranime Anime List Module

    For displaying anime grid/slider.

  2. Kiranime Scheduled Episode Module

    For scheduled widget.

    To learn more about scheduling. please watch this video:

  3. Kiranime Popular List

    To display popular anime by day, week, month.

  4. Kiranime Genre List

    To display the genres available on your site.

  5. Kiranime News Module

    To display the latest article (post).

  6. Kiranime Most Popular List

    To display the most popular anime, based on the total views.

How to Use Option Panel

Settings

The main settings of kiranime.

Grabber Tab

  1. TMDB API Key (v3)

    To be able to access TMDB, you need an API KEY. Get it from TMDB here. After signing up or sign in, go to api settings and copy the api key. Required if you want to use episode info grabber.

  2. Jikan Self Hosted URL

    Only fill this if you're hosting Jikan on your own server. More information: Jikan Rest

  3. TMDB Language

    This will tell the tmdb grabber to use the language rather than default english. Please note that TMDB will not necessarily have all shows translated to the defined language, if so, then the search result will not match your expectation.

  4. Use Post date

    Tell the grabber to use the post date instead of the API/TMDB release date.

  5. Use Random Prefix [episode slug]

    Add a prefix to the episode URL structure. example: https://kiranime.moe/watch/avqewwd-sengoku-youko-senma-konton-hen-episode-13/ [avqewwd is the prefix]. this is to avoid auto grabber that uses the sequence number of the episode.

  6. Use External Image

    Use TMDB/Anilist/MAL to load the images instead of downloading them. This will make your site to rely on TMDB/Anilist/MAL service and not able to do something like optimization on the images (compress, new format features like webp or avif). Default false.

Queries Tab

  1. Episode list by

    Query the episode order. This is for ordering the episodes on the anime page.

  2. Episode Video Meta

    Wether to automatically generate video meta for episode page for rich result or not.

  3. Show Completed badge

    Use completed badge (only for anime grid widget) and recommendation widgets.

  4. Completed badge color

    The background color of the badge.

  5. Completed Taxonomy Slug

    If you're changing the status taxonomy to be your liking, then fill this field with the slug of the "completed" status taxonomy.

Sites Tab

  1. Use ReCaptcha

    Wether to use ReCaptcha captcha service for important form.

  2. ReCaptcha Secret Key (v2)

    The ReCaptcha secret key, make sure it's version 2.

  3. ReCaptcha Site Key (v2)

    The ReCaptcha site key, make sure it's version 2.

  4. Use Lazy Load [image]

    Use lazy loading module for images. You can disable this if you're using other image/cache plugin that add lazy loading to images.

  5. Use Title Switcher

    Use title switcher.

  6. EN Label [title switcher]

    The "EN" label. You can change it to your own label. But it'll use the "english" field in the anime post.

  7. JP Lable [title switcher]

    The "JP" label. You can change it to your own label. It's using the "post title" field, or the anime title.

  8. Disable WP Login page

    Disable the WP login page completely. This will prevent access to wp-login.php page. Be careful, because if something happen you must change this value directly by editing your database [option key: kira_disable_login_page].

  9. Watchlist Page Title

    The watchlist page title for public view. This is used to display on the browser tab and browser meta.

  10. Watchlist Description

    The meta description for watchlist page.

  11. Enable Custom Avatar

    Wether to allow user upload their own avatar image or not.

  12. Loggedin Report

    Only allow logged in user who able to report an episode.

Grabber

Kiranime grabber.

Anime info

  1. Mode

    Select the grabbing mode.

    Selected ID - use the id you provide on the ID field.

    Season list - use season to grab (multiple animes).

  2. Service

    The service to use.

    MyAnimeList - Use myanimelist anime info data.

    Anilist - Use anilist.co anime info data.

    TMDB - use TheMovieDB data, the TMDB key must be filled to use this.

  3. Include Characters

    Include the characters and their voice actors. This only affects MyAnimeList and Anilist.

  4. Publish Status

    The created post status.

Episode info

  1. Status

    The created episode post status.

  2. Anime Title

    The anime title for the episode. Use it by typing on the input field, then wait for a bit to search, then select the dropdown.

  3. Type

    The anime type, whether it's a serie or movie.

  4. Anime ID

    The tmdb show ID.

  5. Anime Season (number)

    The season number you want to grab.

    Don't forget to change the anime title to match the season you want to grab.

  6. Episode Start (number)

    The start episode number to grab. You can grab starting with any number. This is the starting number for the current season. example: if season 1 has 10 episodes, then you can fill "11" episode start for season 2, the script will try both "episode 1" or "episode 11". If found, it'll be saved as "episode 11".

  7. Episode End (number)

    The end episode number to grab. You can grab starting with any number. This is the ending number for the current season. example: if season 1 has 10 episodes, then you can fill "10".

Episode Importer

  1. File

    Use only csv or xlxs file to import the episode. Use the xlxs template by visiting this XLXS Example.

Reports

The episode reports sent by the users.

Manage the user reports.

Search Index

Used to index the anime post for search purposes.

Support Desk

Please remember you have purchased a very affordable theme and you have not paid for a full-time web design agency. Occasionally we will help with small tweaks, but these requests will be put on a lower priority due to their nature. Support is also 100% optional and we provide it for your connivence, so please be patient, polite and respectful.

Please visit our Support ticket

Support for my items includes:
  • * Responding to questions or problems regarding the item and its features
  • * Fixing bugs and reported issues
  • * Providing updates to ensure compatibility with new software versions
Item support does not include:
  • * Customization and installation services
  • * Support for third party software and plug-ins
Before seeking support, please...
  • * Make sure your question is a valid Theme Issue and not a customization request.
  • * Make sure you have read through the documentation and any related video guides before asking support on how to accomplish a task.
  • * Make sure to double check the theme FAQs.
  • * Try disabling any active plugins to make sure there isn't a conflict with a plugin. And if there is this way you can let us know.
  • * If you have customized your theme and now have an issue, back-track to make sure you didn't make a mistake. If you have made changes and can't find the issue, please provide us with your changelog.
  • * Almost 80% of the time we find that the solution to people's issues can be solved with a simple "Google Search". You might want to try that before seeking support. You might be able to fix the issue yourself much quicker than we can respond to your request.
  • * Make sure to state the name of the theme you are having issues with when requesting support via Tukutema.

Files & Sources

Included Stylesheets

These are the primary CSS files used for general front-end styling. Use these to customize your theme even further. All included JavaScript codes under kiranime_pro/assets/

  • 1. style.css - Primary stylesheet
Included JavaScript

These are the various attribution inks to the Javascript files included or modified to work with in this theme. All included JavaScript codes under kiranime_pro/assets or kiranime_pro/core/helper

  • 1. kiranime-frontend.js - Javascript for frontend.
  • 2. kiranime-backend.js - Javascript for backend.
  • 3. *.js - Other dependencies.
  • 3. jsholder.js - For inline javascript placeholder.
  • 3. lazysizes.min.js - Lazyload plugin.

Translating the Theme

Offline Mode

Offline translation can be done using poedit software.

How to translate

  1. Open poedit and then select new translation. Locate the "kiranime.pot" file in the theme package you downloaded Kiranime Theme/translation/kiranime.pot

  2. You'll be prompted to select the target language. Select the language you want to translate kiranime to.

  3. Begin translating the text, put the translation to the bottom box. Top box is the source text to be translated. You can track the progress on the bottom left of the software.

  4. After done translating, select file then click on "compile to MO". Then save as PO file.

  5. Kiranime uses JSON translation for some part. Follow this guide to compile .po file to .json file.

Online Editor

Online editor can be found in the Here.

  1. After opening the site, locate the "kiranime.pot" file in the theme package you downloaded Kiranime Theme/translation/kiranime.pot. Drag and drop the file on the designated area.

  2. Before starting to translate, make sure to click "POT" button on top until it become "PO" like this:

  3. After finishing the translation. Click save button, you'll be presented with two buttons. One is to download the .po file and the other is to download the compiled .mo file.

  4. Kiranime uses JSON translation for some part. Follow this guide to compile .po file to .json file.

Getting the JSON File

To convert PO file to JSON, You can either use online tools (with extra steps required) or send the PO file to Tukutema support (Telegram @hadezuka).

Online Convert

  1. Open Convert to JSON

  2. Select the .po file you got from previous step. Then fill the "Source language" to "English", then fill the "Translation language" to the language you're targetting. Select "JSON" then select "Simple (key/value pairs)". Example:

  3. Click convert and wait until the process completed.

  4. Download the converted file.

  5. After downloaded, open this site.

  6. Open the json file you downloaded from the previous step. Select open, open from disk and select the downloaded json.

  7. Hover your mouse to the root object, in the example is "id". then right click to open the context, then select transform. After that, directly click transform. Follow the images below:

  8. Now the box on the right side should be filled like this:

  9. Select save on the right box, then save to disk.

  10. Rename the .mo and .json file if it doesn't use the locale you want. To learn the locale for your target language, please visit Wordpress locale csv.

    The code is in the language column:

Installing the Translation

To install the translation, move the files to the kiranime theme folder. You can use file manager on your hosting or ftp. Navigate to kiranime_pro language folder at yourwproot/wp-content/themes/kiranime_pro/language. Then copy or move the .mo and .json file to that location.

Don't forget to change your wordpress language preference. Open settings -> General -> site language.

Version History (Changelog)

You can find the version history (changelog.txt) file on Kiranime Theme V.x.zip folder or you can check changelog on your tukutema dashboard.

Once again, thank you so much for purchasing this theme. As I said at the beginning, I'd be glad to help you if you have any questions relating to this theme. No guarantees, but I'll do my best to assist. If you have a more general question relating to the themes on Tukutema, you might consider visiting the forums and asking your question in the "Item Discussion" section.

Copyright and license

LICENSE

kiranime Theme License

kiranime Theme by Dzul Qurnain is licensed under the following terms. By using, modifying, or distributing this theme, you agree to comply with each applicable license below.

1. GPL License for PHP Files

All PHP files within this theme are licensed under the GNU General Public License v2.0 or later (GPLv2+), in compliance with the WordPress license. This allows for modification and redistribution of PHP files under the same GPL license terms.

GPL License Terms

GNU GENERAL PUBLIC LICENSE
Version 2, June 1991

Copyright (C) 1989, 1991 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA

Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.

For a full version of the GPLv2, please see: [http://www.gnu.org/licenses/gpl-2.0.html](http://www.gnu.org/licenses/gpl-2.0.html)

Summary: You are free to use, modify, and distribute the PHP files under GPLv2+ as long as modifications are also licensed under GPLv2+.

2. Custom License for Non-PHP Files (CSS, JavaScript, HTML, and Images)

All non-PHP files in this theme, including but not limited to CSS, JavaScript, HTML, and image files, are licensed under the following custom license terms:

Custom License Terms

  • Modification: You may modify these files for personal or internal use only.
  • No Resale or Redistribution: You may not sell, resell, redistribute, or transfer these files or any derivative works thereof to third parties, whether for profit or otherwise.
  • No Forking or Public Derivatives: You are not permitted to create and distribute derivative projects based on these files.
  • Commercial Use Prohibition: You may not use these files for any commercial purpose, including within a product sold or licensed to others.

Summary: Non-PHP files are provided for personal use and modification only, without rights for redistribution or commercial use.

Disclaimer

This theme is provided "as-is," without any warranty, either express or implied. The author shall not be liable for any damages arising from the use, modification, or inability to use this theme.