Installation

Installation

Installing AnimeScrape is an easy process.

Upon plug-in purchase you will be given a zip file containing the plug-in. If you have purchased the subscription, you will also receive a license key. Here is how to get your site up and running:

  1. Go to Plugins-> Add New. Use the Upload plugin to install and activate AnimeScrape. Two red messages should appear at the top of the screen.
  2. Go to Settings-> Permalinks. Choose the “Post name” option, then save. You can now click “Hide Notice” to hide the warning message at the top of the screen.
  3. Go to AnimeScrape->AnimeScrape. Review the options. If you have a subscription, tick “Enable Scraping Service”. Please Note: Make sure your Title Format, Slug Format, Tag Format, and Excerpt Format are set to your liking. Episodes must be removed and re-added for changes in these settings to take effect.
  4. If you would like to include Episodes in your theme main post loop, tick “Include Episodes in main Post Loop”. If you check “Hide Posts in main Loop”, only Episodes will appear. If this is unchecked, Episodes will appear alongside your regular WordPress Posts. Please Note: While AnimeScrape integrates seamlessly into your themes Post Loop, you also have the ability to program your own custom post loop for Episodes.
  5. Click the “Save” button when you have reviewed your options.
  6. If you don’t have a subscription, you’re ready to go! If you do have a subscription, navigate to AnimeScrape-> My Account.
  7. Enter your Serial Key, and click “Save”. If your Serial Key is valid, the message on the bottom should change from “Not Authorized” to “Authorized”. If this does not happen, please contact support.
  8. You are ready to go! You can go to Series Management to start adding episodes automatically!

Back To Top

Series Management/Adding Episodes

Introduction

Your subscription to AnimeScrape gives you access to the powerful “Series Management” area. Using this area, you can browse available series, add them to your website, and automatically add episodes for them!

 

Back To Top

Adding Series

Before you can add Episodes to your site, you must first add their corresponding Series.

To Add Series:

  1. Go to the “Find Series” tab. Check the boxes next to the various Anime that you would like to add. When you are ready, click “Add Series”. You will be redirected to the “Add Series” tab.
  2. In the “Add Series” page, click “Process Queue”. The “Status” of each series should automatically change to “done” when the Series has been added.
  3. If the status next to a series is “Fail”, do not worry. You can go back to “Find Series” and add it at any time. Please Note: You can add new Anime Series at any time. 

 

Back To Top

Adding Episodes

Once you’ve added a Series, you can add Episodes for it.

To Add Episodes:

  1. Go to the “Create Queue” tab. This will display the list of all deactivated Anime. Deactivated Series will not have Episodes automatically posted for them. By Activating a Series, all Episodes for that Series will be added to your website, and the subscription service will automatically update your site with the newest Episodes.
  2. Check the boxes next to all the Series that you wish to activate. Then, click “Add Series”. You will be redirected to the “Process Queue” tab.
  3. The Process Queue tab will build a list of Episodes, based on the Series you added in the “Create Queue” tab.
  4. If using shared hosting, keep the “Episodes Per Block” value at 10. If using a VPS, you can increase this value to 100, or even more. Unlike other Plugins, AnimeScrape adds Episodes in batches. This means that if you have a shared hosting account, you don’t have to worry about Episodes not being added properly. For example, if your script were to crash while adding Episodes, a maximum of 10 (or your chosen value) Episodes would not get added. You can then go back later and make sure these get added.
  5. Once the Status of all Series is “done”, you can navigate to the “Add Episodes” tab. If any of them is “failed”, you can try again from the “Create Queue” later.
  6. The “Add Episodes” tab is where Episodes finally get added. Each Queue ID represents a Series. Each colored box represents 10 episodes for that Series, or whatever number you specified in the “Process Queue” section.
  7. Click “Add Episodes” to begin adding Episodes to your site. When a batch is processed, it should become green. Please Note: Leaving this page will stop the process. If the blocks do not automatically change color for a long time, or if you suspect the scripts have crashed, refresh the page, and click “Add Episodes” once more. Do not worry – green blocks won’t get re-added, and any Episodes from blue blocks will get Updated, instead of Duplicated.
  8. When all of the boxes become green all the Episodes have been added. Enjoy!

Back To Top

Deactivating Series

If you no longer want our service to automatically update a Series, navigate to the “Remove Series” tab to deactivate any of your currently activated Series.

Back To Top

Adding Episodes Manually

Introduction

AnimeScrape gives you a powerful interface to Add New Series and Add New Episodes to your website. AnimeScrape doesn’t use full embed links – we instead use the ID in the link. This allows us to dynamically generate embed URL’s for you.

This means that if a video host changes how their URL looks, you don’t need to manually update all of your links. The plug-in will automatically generate the correct URL for you, as the video ID remains the same. All plug-in purchasers get this service, regardless of whether or not you are using a subscription.

If you have purchased a subscription, the Series Management section will allow you to automatically Add Episodes for over 1600 Series.

Back To Top

Adding a Series

AnimeScrape allows you to easily add Series to your website. Follow the steps below to Add Series:

  1. Navigate to Episodes-> Anime Series
  2. Fill out the form on the left-hand side to Add a Series
  3. If the Include flag is unchecked, the Episode will not appear in your post loop. If it is checked, it will appear.
  4. Add a URL to a cover photo for the Series. The plugin will automatically resize large images.
  5. Click “Add New Series” to add the series.

Back To Top

Adding an Episode

AnimeScrape provides a powerful interface for adding new Episodes. Episode Titles, Excerpts, Slugs etc. are generated automatically depending on the options you have set in AnimeScrape-> AnimeScrape.

  • Each Episode can have many different Sources (aka Mirrors). Clicking the “Add Source” button will allow you to add a new Source.
  • Some Episodes might be split into multiple embed links. If this is the case, click “Add Part” to add a new part to a Source.
  • To obtain the “Source Video ID”, obtain the ID from the embed link. For example, if you have this link: http://auengine.com/embed.php?file=JjUIIVdx&w=650&h=370, your Source Video ID will be: JjUIIVdx, and your Source Host will be: AU Engine. By using this system, AnimeScrape helps to prevent broken links, even if you are not a subscriber.
  • If an Episode is selected as “hidden”, it will not appear in your Post Loop.
  • If you want to set the thumbnail image of an Episode, you can use the Featured Image section.

 

Back To Top

Development

Introduction

AnimeScrape was made by webmasters for webmasters. The entire plug-in extends naturally on core WordPress functionalities. This means that developing themes, and even plug-ins, will feel natural to those of you with experience in WordPress. If you make something cool, and want to sell it on our shop, just let us know! A strong development community is something we definitely support.

 

Back To Top

Episodes

All Episodes take advantage of custom post types in WordPress. The slug of this post type is “anime”. This is important to know when developing custom themes and features.

Each Episode has many different kinds of data. Here are the useful ones:

  • Episode mirrors
  • Episode number
  • Episode title (the english title, Ex: “Pass or Fail: Survival Test!”)
  • Pageview counter (how many times the episode has been viewed on your site)
  • Subbed/Dubbed

By taking advantage of this available data, you can easily generate custom functions into your theme.

This data is stored in a PHP object, in a custom field for each Episode. Warning: DO NOT modify this data. Doing so can result in unexpected behavior. This data is meant for reading only.

Here are the steps you must undergo to access this data. You can view a useful example at the end of this section:

  1. On the page of the Episode, or in your Post Loop, use the get_post_meta function to return the field ‘episode_data’. This will return a PHP object
  2. You can dereference the returned object to obtain any of the following useful member variables:
  • epnum_int – Contains the Episode Number
  • subdub_flag – 0 = subbed, 1 = dubbed
  • hidden_flag – 0 = public, 1 = hidden
  • pageview_counter – The number of pageviews for this Episode
  • wordtitle – Stores the English title of the Episode

Please refer to the example below which shows how to use this data to return the links to any episode. This is particularly useful when creating links to the previous and next episode, on your video page.


/*
* Returns the link to the desired episode as well as the title in $link['permalink'] and $link['title'] respectively
* else, if not found, returns NULL
* $series is the series slug
* $epnum is the number of the episode to find
* $subdub indicates whether to return a link to to a subbed video or dubbed video
*/

function get_episode_link( $series, $epnum, $subdub ){
    $args = array(
    'post_type' => 'anime',
    'series' => $series,
    'meta_key' => 'episode_num',
    'meta_value' => $epnum,
    'post_status' => 'publish'
    );

     $my_query = new WP_Query( $args );
    if($my_query->have_posts() ) :
        while($my_query->have_posts() ) : $my_query->the_post();
            $_ep = get_post_meta( get_the_ID(), 'episode_data', true );
            if( $subdub == $_ep->subdub_flag ){
                $link['title'] = get_the_title();
                $link['permalink'] = post_permalink( get_the_ID() );
                wp_reset_postdata();
                return $link;
             }
        endwhile;
    endif;
    wp_reset_postdata();
    return NULL;
}

Back To Top

Series

All Series take advantage of custom taxonomies in WordPress. The slug of this custom taxonomy is “series”. This is important to know when developing custom themes and features.

To create a custom archive page for a Series, so that you can list out all Episodes, the Series Cover Image, and the Description/Summary, you must create a file named “taxonomy-series.php” in the main directory of your theme.

For you to get the most out of AnimeScrape, we’ve included a plethora of useful information for you to develop around. Each Series includes the following:

  • The Series Status (Ongoing, Completed, or Cancelled)
  • The Series description/summary
  • The Series genres
  • The Series cover image

This information is stored using WordPress options.

Here are the steps you must undergo to access this data. You can also view an example at the end of this section.

  1. Use the get_term_by function to return the taxonomy.
  2. To obtain the Series name, dereference the return of step 1 for “name”.
  3. To obtain the Series description, dereference the return of step 1 for “description”.
  4. Similar to steps 2 and 3, use step 1 to get the “term_taxonomy_id”.
  5. We must use this id to get an option value. Use the get_option function to return “taxonomy_$id”, where $id is the term_taxonomy_id that you retrieved in the previous step. This returns an array of all the data you need
  6. Here are the keys of the array:
  • image_term_meta – The URL for the Cover Image of the Series
  • status_term_meta – 0 = On-going, 1 = Completed, 2 = Cancelled
  • genre_term_meta – A comma separated String of Genre’s

Please refer to the example below to see these steps in action. The following code can be run on a taxonomy-series page:


$term = get_term_by('slug', get_query_var( 'term' ), get_query_var( 'taxonomy' ) ); // Step 1, returning the taxonomy

$name = $term->name; //Step 2, getting the Series name

$description = $term->description; //Step 3, getting the Series description

$id = $term->term_taxonomy_id; //Step 4, getting the taxonomy id

$series = get_option("taxonomy_$id"); //Step 5, using get_option to return the array of data

$img = $series[image_term_meta]; // Cover image url

$status = $series[status_term_meta]; // The status of the Series

$genre = $series[genre_term_meta]; // The genres of the Series

Back To Top

Got some Questions? Contact Us!

I am responsive!