FANDOM


Introduction

This is an unofficial and incomplete documentation of the Touken Ranbu Helper as well as a guide on how to tweak it to your preferences such as:

  • Updating the helper for every new sword added.
  • Adding new swords to drop notifications.
  • Customizing the look on your helper interface... soon™

Requirements

  • A copy of Touken Ranbu Helper. Version used for this guide is ver. 0.3.0 (Uchigatana Kiwame)
  • A text editing software like Notepad++ or anything similar.
    • Notepad works just as fine as well, but line numbers in codes are mentioned in this guide which might be hard to find if Notepad is used.
    • For Mac users, Brackets is a good alternative.
  • A photo editing software like Photoshop, GIMP, Paint.Net or anything similar (should support transparency/alpha channel).


Troops-Elite-Big Disclaimer:
I will not be held responsible for any accident/damage that occurs in the event that the instructions have been executed incorrectly. I highly recommend making a copy of the plugin folder before proceeding to avoid any incidents.

Manually Updating Sword Roster

It is important to update the helper accordingly with every new sword/kiwame release as any new sword added to a party will cause the helper to malfunction.

  1. Open define.js located in devtools > panel > app into your text editor.
  2. Inside exports.tohken.define.tohkens, copy the blank field below and paste according to book number. Define the attributes (you can go to the sword's character page to find out the info you need).
  3. Save file.
  4. For adding sword crests, see Crests.
    • For Kiwame swords and swords with multiple Toku forms, you can copy the existing crest and rename the file.
  5. Load TKRB Helper to see if it works. If you have it open before editing, close the helper and refresh from the extensions menu.

Blank Templates

    "[book number]": {
      "name": "[name]",
      "id": [book number],
      "rarity": [1, 2, 3, 4, 5],
      "type": [sword type],
      "group": [sword school],
      "equip": [number of troop slots],
      "area": [attack range],
      "upgrade": [toku rank up level],
  },

Sample (DO NOT COPY THIS):

   "95": {
     "name": "Yamanbagiri",
     "id": 95,
     "rarity": 2,
     "type": 5,
     "group": 5,
     "equip": 2,
     "area": 1,
     "upgrade": 20,
   },

    "[book number]": {
      "name": "[name]",
      "id": [book number],
      "rarity": 2,
      "type": 7,
      "group": [sword school],
      "equip": [number of troop slots],
      "area": [attack range],
      "ktan": 1
  },

Sample (DO NOT COPY THIS):

    "34": {
      "name": "Atsushi 極",
      "id": 34,
      "rarity": 2,
      "type": 7,
      "group": 9,
      "equip": 2,
      "area": 1,
      "ktan": 1
  },

    "[book number]": {
      "name": "[name]",
      "id": [book number],
      "rarity": 3,
      "type": 4,
      "group": [sword school],
      "equip": [number of troop slots],
      "area": [attack range],
      "kwaki": 1
  },

Sample (DO NOT COPY THIS):

      "100": {
      "name": "Horikawa 極",
      "id": 100,
      "rarity": 2,
      "type": 4,
      "group": 5,
      "equip": 2,
      "area": 1,
      "kwaki": 1,
    },

    "[book number]": {
      "name": "[name]",
      "id": [book number],
      "rarity": 3,
      "type": 5,
      "group": [sword school],
      "equip": [number of troop slots],
      "area": [attack range],
      "kuchi3": 1
  },

Sample (DO NOT COPY THIS):

      "88": {
      "name": "Yamatonokami 極",
      "id": 88,
      "rarity": 3,
      "type": 5,
      "group": 1,
      "equip": 2,
      "area": 1,
      "kuchi3": 1,
      
    },

    "[book number]": {
      "name": "[name]",
      "id": [book number],
      "rarity": 4,
      "type": 5,
      "group": [sword school],
      "equip": [number of troop slots],
      "area": [attack range],
      "kuchi4": 1
  },

Sample (DO NOT COPY THIS):

      "92": {
      "name": "Izuminokami 極",
      "id": 92,
      "rarity": 4,
      "type": 5,
      "group": 3,
      "equip": 3,
      "area": 1,
      "kuchi4": 1,
      
    },

About Attributes

Attributes provide information about a certain sword which the helper translates. Attributes are found in lines 8-37 of define.js as exports.tohken.define.xxxx where xxxx is the name of the attribute itself.

  1. name - Sword name.
    • To avoid overlapping text, it is recommended to use the sword's 'first' name (e.g. Ichigo Hitofuri > Ichigo). To differentiate Kiwame swords from their regular counterparts, it's best to add [K] or 極 at the end of the name (e.g. Gokotai [K]).
  2. id - Sword book number
  3. rarity - Petal rarity
  4. type - Sword type: Ootachi (1), Tachi (2), Naginata (3), Wakizashi (4), Uchigatana (5), Yari (6), Tantou (7)
  5. group - Sword/smith school.
  6. equip - Number of troop slots a sword can hold.
  7. area - Attack range (short, wide, horizontal, vertical)
  8. upgrade - Toku rank-up level
    • Do not add this attribute if a sword is in its kiwame form.
  9. k[xxx] - Specifies kiwame type. Value is always 1. Do not add this attribute if a sword is not in its kiwame form.
    • ktan - kiwame tantou
    • kwaki - kiwame wakizashi
    • kuchi[n] - kiwame uchigatana where n represents rarity.

Updating Drop Notifications

Current versions of TKRB Helper only have drop notifications on older swords. Newer swords and possible event/special map drops are not detected by the helper because they are not defined. For those who like hoarding a specific sword, you can also use the same method if you want... just throwing it out there :^)

  1. Open parse.js, which located in the same folder as define.js.
  2. Go to lines 257 and 258. There are arrays named asia and europe.
    • asia - rare swords
    • europe - super rare swords
  3. To add a sword into the drop list, place their sword book number into the arrays. Make sure they are in numerical order.
  4. Save file and load TKRB Helper to see if it works. If you have it open before editing, close the helper and refresh.
Optional steps:
  1. Open index.html located in devtools > panel in the text editor.
  2. Go to line 203 and place the names of the super rare swords you added.
  3. Save and open the html file on your browser (no need to load helper), if you had it open before saving, refresh the page.

Customizing Helper Interface (Optional)

Modifying these is not necessary for the Helper to function, but it makes it more aesthetically pleasing.

Crests

Any new sword added to the helper without its crest added to the folder will result in a broken file link. Crests can also be replaced with other images, such as character portraits.

  1. Go to Sword Crests and find the crest of the sword you want. If the crest file is not there yet, you can always go back and check another time or directly retrieve it from the game.
  2. Crop the image file so that its dimensions are at a 1:1 ratio.
    • Usually the sword crests retrieved from the game are at 109px x 108px. In this case, crop the image so that it is at 108px x 108 px.
    • After cropping, resize the image dimensions to 100 x 100 px
  3. Save the file and place it in assets > sword. The file name of the crest should be the sword's book number.

Recoloring and CSS

The Helper's main.css file can be found in devtools > panel > assets.

Troops-Archers-Big Note:
This recoloring guide was made for readers with background in CSS in mind. If you are interested in customizing your Helper but do not have any experience in coding, I suggest studying the basics on W3Schools.

Keep in mind that you must always keep a clean copy of the CSS file in case you want to revert back.

TBA

Ad blocker interference detected!


Wikia is a free-to-use site that makes money from advertising. We have a modified experience for viewers using ad blockers

Wikia is not accessible if you’ve made further modifications. Remove the custom ad blocker rule(s) and the page will load as expected.