User:YukinoAi/Tutorial Scratchpad: Difference between revisions

==Introduction==

# The file metadata (resolution, audio tracks, subtitles, etc).

* Before creating an entry for a file, the unique ed2k hash must first be calculated because the ed2k hash will be used in identifying the file.

* The file's metadata should be updated using the Avdump2 tool.

And so, it is convenient to use the Avdump2 tool to both generate the unique identifier and also update file metadata.

# Obtain a file to add to AniDB.

===Theory===

===Procedure===

On the left navigation pane, at the bottom is a section labeled <code>Account</code>. Click on <code>Settings</code>.

There should be a section called <code>UDP API Key</code> with two fields, one with a label and another empty one.

In the last box of characters labeled <code>a-z, A-Z, 0-9</code>, highlight 20-30 characters as shown below.

Then copy the selected characters to the clipboard.

* <code>Ctrl + c</code>

Change tabs back to AniDB's page.

In the empty field under the <code>UDP API Key</code>, right-click and select <code>Paste</code>. Alternatively: <code>Ctrl + v</code>.<br />

Click on the <code>Apply</code> button at the bottom. It should be right above <code>Back</code>.<br />

The <code>UDP API Key</code> field should turn into asterisks (*) to show that it has saved it properly.<br />

The API key should also be saved for use with Avdump2 later on, so lets save it to notepad.

<code>Windows key</code> or Click on the start menu and type in <code>notepad</code>.

Save the file as something descriptive or as <code>anidb_apiKey.txt</code> in your user profile folder (<code>C:\Users\User</code>) or desktop (<code>C:\Users\User\Desktop</code>).

* <code>Ctrl + s</code>

The Avdump2 GUI will simply not respond when authentication fails. More on this later.

===Theory===

{| class="wikitable"

!width="5%"| Group Name or [Tag]

|-

===Procedure===

At the top right next to <code>Search</code> change the search type from <code>all</code> to <code>group</code>.

Click on the group name in the <code>Name</code> column. In the below example it would be <code>Doki Fansubs</code>.

For the purposes of this tutorial, it will be assumed the group name already exists.

===Theory===

* A file entry in AniDB has 2 main components, the entry itself and the associated metadata.

* AniDB stores metadata information for files that are not yet in the database. This means it is possible to add a file entry and then add the metadata, or alternatively, add the metadata to AniDB and create the file entry later.

Thus, to create a file entry in AniDB, the ed2k hash must be known and the group name should be known.

# Hash files to identify them (ed2k).

===Installation===

For the purposes of this tutorial, it will be assumed the CLI tool is at:<br />

And the GUI tool is available at:<br />

To calculate and export the identifier information, including the ed2k hash, use either the Avdump2 CLI or GUI.

Start a command prompt:

* <code>Windows key</code> - Type <code>cmd.exe</code> and press <code>Enter</code>.

Let's change the current path to <code>C:\Users\User\Downloads\avdump-gui-2.3.2-portable\appdata\avdump-gui-2.3.2.win32</code> using <code>cd</code> or <code>pushd</code>.

<code>pushd C:\Users\User\Downloads\avdump-gui-2.3.2-portable\appdata\avdump-gui-2.3.2.win32</code>

Open an explorer window to: <code>C:\Users\User\Downloads\avdump-gui-2.3.2-portable\appdata\avdump-gui-2.3.2.win32</code> and drag and drop the folder icon on the top left of the address bar to the command prompt window.

This will populate the command prompt window with the path to the folder automatically, as shown below. This technique can also be used for individual files.

With the command prompt window selected, press the <code>Home</code> key or hold the <code>Left Arrow</code> on the keyboard to change the cursor to the position furthest to the left.

Enter <code>cd</code> and a single space.

Press <code>Enter</code>.

Or check for the executable directly by typing the first few characters <code>av</code> and using <code>Tab</code> to cycle through the available options.

For the purproses of this tutorial, there is a file named:<br />

<code>C:\Users\User\Downloads\Log Horizon</code>

The file name with the full path will be automatically populated in the command prompt window.

Press <code>Enter</code>.

So Avdump2cl.exe complains that no processing options has been specified, so there is nothing to do. So let's give it something to do.

Let's run the command and see what happens.

<code>Avdump2cl.exe</code> seems to have processed the file and created a text file called <code>ed2k.txt</code> in its current directory. The file contains one line of contents:

<code>ed2k://|file|[Yuki] Log Horizon - 01 (BD 720p HEVC Dual-Audio AAC) [F8708ABE].mkv|484345397|C33743B735BF1B282B185E1B2E611270|/</code>

This is what the ed2k links used by AniDB look like. After the protocol specifier (<code>ed2k://</code>), is the <code>file</code> keyword, the filename, the file size, and then finally the ed2k hash.

The file size <code>484345397</code> is in raw bytes. <code>484345397</code> divided by <code>1024</code> is <code>472,993.55</code> which is the size shown in explorer:

<code>C33743B735BF1B282B185E1B2E611270</code> happens to be the ed2k hash of this specific file. Every file will have a different ed2k hash.

Let's inform AniDB that this file exists using the ed2k link.

Go to the entry of the Anime in AniDB you want to add a release for. This can be done by using the search feature.

At the top right, enter the name of the Anime. For the purposes of this tutorial the series name is <code>Log Horizon</code>. Change the content type to <code>anime</code> and then click on <code>Search</code>.

Log Horizon has multiple seasons, so each of them are displayed. Click on the correct season.

Scroll down to the <code>Group Status</code> section. Click on the <code>+ Add New Release</code> button.

This should bring up the mass add files page.

Set the group, source, release date, quality, track, and language options.

Let's start with the group. Enter the group name and click on <code>Search</code>.

The group name should change and have a drop down menu. Be sure to select the correct group name, identified above in Part B. For the purposes of this tutorial, the correct group name is <code>Yuki Subs [YukinoAi]</code>.

Change the template from manual to the most appropriate setting. <code>[Yuki] Log Horizon - 01 (BD 720p HEVC Dual-Audio AAC) [F8708ABE].mkv</code> is labeled as Dual-Audio so the <code>dual</code> template should be used. For most fansub releases with only a single japanese audio track and subtitles, the <code>fansub</code> template should be used instead.

Select source and quality of the file:

If you happen to know any more information about the file, like if the CRC32 of the file matches the official source, enter it. When in doubt, leave that field unmodified. Audio and subtitle track information can usually be left alone alone because that information will be updated later when the meta-data dump uploaded to AniDB becomes associated with the file entry.

Make sure the episode number is correct. If you happen to know the date the file was first distributed, enter it in <code>dd.mm.yyyy</code> format. When the information looks correct, click on <code>Add Files</code>.

Success!

To verify the stub-entry exists, go back to the Anime page. In the <code>Group Status</code> Section, click on the expand button for the group.

* The bottom file has <code>CRC</code> overlayed with a checkmark. That means the entry has been marked to indicate that the CRC for the file, matches the official one provided by the release group.

Back in command prompt world...

Note: Please note that all data sent to the server will be logged using IP and user id. If you would like to check what data will be submitted to the server after authentication, run the following command:<br />

<code>username</code> in the above command should be subtituted with your AniDB username. The <code>api_key</code> is the character string that was specified in the AniDB profile in Part A. Notice the colon <code>:</code> in between the <code>username</code> and <code>api_key</code>. If following this tutorial, it should be available at <code>C:\Users\User\anidb_apiKey.txt</code> or <code>C:\Users\User\Desktop\anidb_apiKey.txt</code>. Copy it and right-click paste it into the command prompt:

Enter a space and then drag and drop the file to add to AniDB into the command prompt window as before:

The command below should be sufficent to submit the meta-data.

Press <code>Enter</code>. If it works, the following should appear after processing completes:

The line that says:<br />

<code>ACReq( Done: 0 Todo: 1 Failed: 0 Pending: 0 )</code><br />

The line that says:<br />

<code>ACReq( Done: 1 Todo: 0 Failed: 0 Pending: 0)</code><br />

If you get an error like the following:<br />

* Double check the API key is correct.

If you get an error like the following:

* In the above command, that is due to a syntax error in the <code>--Auth</code> switch. The correct syntax is <code>--Auth=username:api_key</code> but in the above command the <code>username</code> is missing.

* Press the up arrow key to bring up the previous command in the command prompt window. Then fix the syntax and run the command again. It should then work.

Assuming dump submission succeeds, the AniDB page for the file will likely show the following:

In other words, while the correct meta-data has been submitted as part of a dump to AniDB, the information for that file has not changed.

For the file above, this is what the information looked like less than 24-hours later:

With the above information, the actual command to run would be:<br />

If using the drag and drop technique instead of copy-paste, quotation marks will automatically be added as appropriate.

Open notepad and copy-paste the following cryptic text into a file called <code>AniDBUpdate.bat</code> or just download it [here].

set username=putUsernameHere

set api_key=putApiKeyHere

goto usage)

goto usage)

if /i &quot;%username%&quot; equ &quot;putUsernameHere&quot; goto usage

if /i &quot;%api_key%&quot; equ &quot;putApiKeyHere&quot; goto usage

goto end

echo  OMG^! Hi^!^!^!  Usage Help:

echo.

echo  Please update &quot;username&quot; and &quot;api_key&quot; before using %~nx0.

echo.   

:end

</pre>

The three highlighted items need to be changed before using the script. Update the username and API key appropriately. Make sure there are no trailing whitespaces in either the username or api_key. &quot;Name&quot; will work but &quot;Name &quot; will not. Example:

For the pathToAvdump2 entry, the path should not include a trailing <code>\</code>.

1) Hardest: Command prompt method: Navigate to the correct directory and type <code>AniDBUpdate.bat</code>.

2) Drag and drop method: Drag and drop a file or folder onto the batch file.

3) Easiest: Send-to method: Use the right-click <code>Send to</code> context menu.

For the send-to method to work, the file, or a shortcut to it, must be placed at:<br />

# <code>Windows key + r</code>

# <code>Ctrl + v</code> to Paste the above contents

# Press <code>Enter</code>

# Right-Click - create a new shortcut

# Rename the shortcut appropriately.

===Avdump2 GUI===

Avdump2 GUI Limitations. The GUI:

* always requires authenticating.

* will not generate links without specifying a valid username and valid API key pair, every time.

* must be deliberately started every time to be used.

* will not issue an error message when authentication fails and simply not respond.

* requires updating prior to usage.

# Specify the username and api-key.

# Use the <code>Files</code> and <code>Folder</code> buttons too add files to process.

# When complete, click start to see what happens.

# If it works, nothing will happen for a while, and then eventually ed2k links will appear in the ed2k export window. The dump data should have been submitted to AniDB in the background, although there is no way to check.

AniDB is a user-driven database. A normal way to contribute is to issue change requests (creqs for short), which means that a moderator has to approve suggested changes before they are published. Request links can usually be found on every page that has editable content for logged in users.

More info:<br />

Avdump2, used above, is AniDB's mechanism to submit automatic change requests (acreqs or auto-creq). These automatic change requests do not always require moderator approval because the information (file-metadata) has been verified programmatically. For auto-creqing:

* It is possible to dump files currently not in the database. The data is still stored and will be used later if/after the file has been registered.

To learn more about creqs please check out:

For further help with a problem or just for chatting visit IRC:

Channel Address: irc://irc.synirc.net/anidb