Quote:
Originally Posted by Wriggle
Reinboooooom, you haven't forgotten us, have you?
|
I have not!
So here's the quick rundown of the API, in steps.
Step 1 - Location
The path you will be looking for is:
%LOLINSTALLDIR%\Config\Champions\%CHAMPIONID%\Reco mmended\
%LOLINSTALLDIR% is wherever your PBE install is
%CHAMPIONID% is the game folder ID for a champion. Such as Ahri or DrMundo
This location isn't made for you. Go ahead and create the Characters, the ID, and the Recommended folders as necessary.
Step 2 - The File
You place any number of *.json files (the actual filename isn't relevant, as long as it ends in .json) in this folder.
The JSON file commands the recommended item page and the overall structure appears like the following:
Code:
{"champion":"Ahri","title":"default","type":"riot","map":"any","mode":"any","priority":false,"blocks":[{"type":"starting","items":[{"id":"1001","count":1},{"id":"3010","count":3}]},{"type":"essential","items":[{"id":"3001","count":1},{"id":"3089","count":1}]},{"type":"offensive","items":[{"id":"3100","count":1},{"id":"3128","count":1},{"id":"3135","count":1}]},{"type":"defensive","items":[{"id":"3140","count":1},{"id":"3157","count":1}]}]}
Or, in slightly more human readable form:
Code:
{
"champion":"Ahri",
"title":"default",
"type":"riot",
"map":"any",
"mode":"any",
"priority":false,
"blocks":[
{
"type":"starting",
"items":[
{
"id":"1001",
"count":1
},
{
"id":"3010",
"count":3
}
]
},
{
"type":"essential",
"items":[
{
"id":"3001",
"count":1
},
{
"id":"3089",
"count":1
}
]
},
{
"type":"offensive",
"items":[
{
"id":"3100",
"count":1
},
{
"id":"3128",
"count":1
},
{
"id":"3135",
"count":1
}
]
},
{
"type":"defensive",
"items":[
{
"id":"3140",
"count":1
},
{
"id":"3157",
"count":1
}
]
}
]
}
(Note: It likely requires to be minified).
The important keys here:
1. "map"
This key may either be "any" or a single map id number (in string form). Some common ones you may wish to use:
"1" is Summoners Rift
"8" is Crystal Scar
"10" is Twisted Treeline
2. "mode"
This key may either by "any" or a single mode string id. The available modes are:
"CLASSIC"
"ODIN" (Dominion)
"ARAM"
3. "priority"
This defines if it should be loaded at top priority or not. This is mostly to reorder the data structure internally. We've left it false for most of the Riot made ones.
Make sure this is true. This gives it priority over the Riot ones.
The keys champion, title, and type are all used for organizational purposes and you won't have to use it. They also open us up to enabling multiple recommended pages in the future, so I still encourage you to use them. Just not required yet.
Just make sure "type" is NOT "riot"
4. "blocks"
This is where the actual page begins. Blocks is an array of section. Each section begins with a type. The type is displayed as the header. The types "starting", "essential", "offensive", and "defensive" will also be localized for you (if you need more, I can add more based on recommendation).
Each piece in the block, under the "items" key lists an item. The item currently simply has an id and a count to purchase.
Overall, pretty simple. Though, there are parts of this that will likely expand and change.
??
Adjudicator
??
??
