esi-issues icon indicating copy to clipboard operation
esi-issues copied to clipboard

Skin related routes

Open cppctamber opened this issue 4 years ago • 0 comments

Feature Request

Provide endpoints for skin and space object factory related data. All but the material sets mentioned on the SDE parity checklist https://github.com/esi/esi-issues/issues/1103

  • skins
  • skin type ids
  • skin license ids
  • skin materials
  • material sets

Use case

  • Users who wish to retrieve skin information.
  • Users who want to generate the correct space object factory strings for skins and skinned ships.

Authentication

A public route, no auth required.

Example return

The below routes are examples only and not instructions as they do not all follow current esi patterns. Data shown is for an Immolator Sansha Victory

universe/skins (skins.yaml) Gets an array of all skin ids

[
    ...
    2120,
    2121,
    2131,
    2173,
    2174,
    ... 
]

universe/skins/{skin_id} (skins.yaml) Gets a specific skin by id

{
    "skin_id": 2131,
    "internal_name": "Sansha Victory",
    "skin_material_id": 74
}

universe/skins/2131/types (resolved from shipSkin.yaml) Gets an array of all valid type ids for a skin id

[
     615,
     3514,
     17718,
     17736,
     17924
]

universe/skins/2131/types/{type_id} (resolved name and sof string from graphic id data and material set data) Gets skin and sof details for a specific type with a skin applied to it

{
    "type_id": 615,
    "skin_id": 2131,
    "name": "Immolator Sansha Victory",
    "sof_string": "sf3_t1:sanshabase:sansha:mesh?none;black_onyx_metallic;blue_cobalt_metallic;grey_steel_brushed"
}

universe/skins/2131/licenceTypes (resolved from skinLicense.yaml) Gets an array of all valid license type ids for a skin id

[
     ...
     36854
     ...
]

universe/skins/2131/licenseTypes/{type_id} Gets skin license type by id

{
    "type_id": 36854,
    "skin_id": 2131,
    "duration" : -1
}

universe/skinMaterials (skinMaterials.yaml) Gets an array of all skin material ids

[
   ...
   68,
   69,
   70,
   74,
   ...
]

universe/skinMaterials/{skin_material_id} (skinMaterials.yaml + converted display name id + resolved icon path) Gets a specific skin material by its id

{
    "skin_material_id": 74,
    "material_set_id": 88,
    "name": "Victory",
    "icon_path": "img/icons/ui/74.png"
}

universe/materialSets Gets an array of all material sets by id

[
     ...
    88,
    108,
    110,
    111,
    113,
    ... 
]

universe/materialSets/{material_set_id} Gets a specific material set by its id

{
     "material_set_id": 88,
     "description": "Tournament XIII - Participation SKIN (Sansha Hulls)",
     "colorPrimary": [
        0.29019609093666077,
        0.47058823704719543,
        0.6274510025978088,
        1
     ],
     "colorSecondary": [
         0.6352941393852234,
         0.6666666865348816,
         0.7058823704719543,
         1
     ],
     "colorHull": [
         0.2549019753932953,
         0.250980406999588,
         0.23529411852359772,
         1
     ],
     "colorWindow": [
         0.8039215803146362,
         0.7019608020782471,
         0.5333333611488342,
         1
     ],
     "sof_faction_name": "tournament-x",
     "sof_race_hint": "sansha",
     "sof_mesh_material_1_name": null, 
     "sof_mesh_material_2_name": "black_onyx_metallic",
     "sof_mesh_material_3_name": "blue_cobalt_metallic",
     "sof_mesh_material_4_name": "grey_steel_brushed",
     "sof_pattern_name": null,
     "sof_pattern_material_1_name": null,
     "sof_pattern_material_2_name": null,
     "sof_res_path_insert": null,
     "sof_string_suffix": "mesh?none;black_onyx_metallic;blue_cobalt_metallic;grey_steel_brushed"
}

Checklist

Check all boxes that apply to this issue:

  • [x] Feature request description is provided
  • [x] Use case exists
  • [x] Feature requires a new route
  • [ ] Feature adds data to existing route
  • [ ] Feature requires new auth scope
  • [ ] Feature can reuse existing scope
  • [x] Feature does not require auth
  • [ ] Meta feature, applies to all routes

cppctamber avatar Jun 10 '21 09:06 cppctamber