Custom Banners

Warning! You are now entering uncharted territory. Proceeding forward may cause issues with your bot that have not been tested. Tread carefully!

Before we begin, please note that modifying the Banners.xml file in any way can restrict your use of the update command. If you still wish to get updates from the official data repository, please refrain from editing your Banners.xml file.

Manually Adding Data & Images

If you proceed forward with this procedure, your custom data will be overwritten if you use the update command.
Using the update r command will delete your custom data AND your custom images.
As a result, you will no longer be able to download data from the repository.
If you wish to keep your custom data and images AND get the latest banners, you have the option to update your Banners.xml file manually.

Editing The Banners.xml File

If you use a text editor and open up Banners.xml, you should see that all the banners follow a specific format.

The format is:

<Banner id="BANNER_ID_HERE">
    <name>BANNER_NAME_HERE</name>
    <type>CHARACTER_BANNER_TYPE_HERE</type>
    <wepType>WEAPON_BANNER_TYPE_HERE</wepType>

    <!--> CHARACTER LIST <-->
    <Character prefix="CHARACTER_PREFIX_HERE" char="CHARACTER_NAME_HERE" rarity="CHARACTER_RARITY_HERE"/>

    <!--> WEAPON LIST <-->
    <Weapon name="WEAPON_NAME_HERE" rarity="WEAPON_RARITY_HERE"/>
</Banner>

To add a custom banner, copy that format and paste it into your Banners.xml file then fill out the details.

Banner ID: Just add 1 to the previous banner's banner ID. Make sure there is no duplicate Banner ID.
Name: Your banner name here, avoid the use of ASCII symbols; keep your name alpha-numeric.
Type: For type, input any of the follow IDs:

0 Normal
Unchanging scout rates for Multi pulls.
No special gimmicks.

1 Step Up
Step 1: Costs 200 Memory Diamonds.
Step 2: Costs 200 Memory Diamonds, 1.5x GOLD character rate.
Step 5: 2.0x GOLD character rate, reset back to Step 1.

2 Record Crystal
Get "Record Crystals" every multi scout to use in a guaranteed scout.
Guaranteed scouts can be performed via scout <banner id> rc.

3 Step Up v2
Step 1: Costs 200 Memory Diamonds.
Step 3: Costs 200 Memory Diamonds, 1.5x PLATINUM character rate.
Step 5: Guaranteed one PLATINUM character.
Step 6: 2.0x PLATINUM character rate, repeats.

4 Birthday Step Up
Step 1: Costs 125 Memory Diamonds.
Step 3: 2.0x GOLD and PLATINUM character rate, reset back to Step 1.

5 Record Crystal v2
Costs 125 Memory Diamonds on the first scout.
Larger GOLD character pool than Record Crystal.
Otherwise, same as Record Crystal.

6 Memorial
Costs 1 Memory Diamond per scout. Unchanging scout rates.
Single pulls only; Multi pulls are disabled.

7 Step Up v3
Step 1: Costs 125 Memory Diamonds.
Step 3: 2.0x PLATINUM character rate, reset back to Step 1.

wepType: For wepType, input any of the following IDs:

0 Normal
Unchanging scout rates for Multi pulls.
No special gimmicks.

1 Step Up
Step 1: Costs 100 Memory Diamonds.
Step 3: 2.0x GOLD weapon rate, reset back to Step 1.

Character: Input character details here.
For example, if you wanted 4★ [Black Swordsman] Kirito to be in a banner, a Character line would look like this:

<Character prefix="Black Swordsman" char="Kirito" rarity="4"/>

To add another character, just add a Character line below an existing Character line.

Weapon: Input weapon details here. For example, if you wanted 4★ Elucidator x Dark Repulser to be in a banner, a Weapon line would look like this:

<Weapon name="Eludicator x Dark Repulser" rarity="4"/>

Adding Custom Images

For both character/weapon images, you'll need the Unit_Background.png template to put your own custom images on. You can get the Unit_Background.png file here.

Once you have the file, open up your favorite image editor and apply your custom unit/weapon within the background image boundaries (The rarity border will be applied automatically later).

For your file name, you will need to follow this naming format:

Characters: prefix_name.png
If your character is 4★ [Black Swordsman] Kirito, the file name will be Black_Swordsman_Kirito.png

Weapons: name.png
If your weapon is 4★ Elucidator x Dark Repulser, the file name will be Elucidator_x_Dark_Repulser.png

Once you have your image, throw it in either your images/Characters/ or images/Weapons/ folder depending on what they are.

Creating Your Own Data Repository

If you proceed forward with this procedure, you will regain safe access to the update command.
HOWEVER, the latest banners will still no longer be available to you.
To get the latest banner data, you must update your data repository manually.

Follow the instructions above and edit your Banners.xml file and create the necessary images like normal.
Upload the Banners.xml and image files to their appropriate locations in your data repository.

You can now update your bot by running the update command.

For a guide on how to make your own data repository, read this link.