API rajapinnat


Tällä sivulla on dokumentoituna Truen julkiset rajapinnat mistä tietoa voi lukea koneellisesti JSON muodossa.

Tällähetkellä ei ole käytössä tunnistautumista mutta se saattaa muuttua tarvittaessa. Rate limittiä ei ole v1 apissa mutta v2 se on 600 requestia per 1 minuutti per ip (jaettu kaikkien v2 endpointtien kesken).

HUOM! Muutokset ovat mahdollisia. Mistään ei anneta mitään takuuta. Käyttö omalla vastuulla. Rakentavaa palautetta voi antaa jeeukolle.

Muutosloki (viimeisin ylimpänä)

13.10.2021: Ratelimitti muutettu 10req/1sec -> 600req/60sec. V1 api on nyt vanhentunut, siirry lähes identtiseen v2 endpointtiin.

25.9.2021: Rankkeihin lisätty Penta-Respected.

21.9.2021: Esinelistassa uusi mahdollinen custom_model_data kenttä. Pelaajatietoihin lisätty rangaistukset.

1.9.2021: Esinelistassa uusi mahdollinen axolotl_variant kenttä. Peliajassa ei näy survin peliaikaa.

Arkkukauppat DEPRECATED

Tämä endpoint tulee poistumaan pian. Siirry käyttämään lähes identtistä v2 endpointtia.

https://trueworlds.net/api/v1/shops.json

Rakenne
{
  "updated": "2021-01-01T12:00:00+03:00",
  "shops": [
    {
      "world": "survival",           // Joko "survival" tai "nether"
      "x": 100,
      "y": 50,
      "z": -200,
      "item": "EnchantedBook#a",     // Mitä myyntikyltissä lukee
      "tag": "a",                    // Risuaidan jälkeen olevat merkit tai null
      "item_type": "enchanted_book", // Sama mitä tiedostonimissä yms
      "amount": 1,
      "price_buy": 100,
      "price_sell": null,
      "shopkeeper": {
        "uuid": "6825974a-7b2d-47e9-9155-1c568ceed43c",
        "username": "jeeukko"
      },
      "id": "survival_100_50_-200"   // maailma_x_y_z
    }
  ]
}
		
NBT:tä sisältävät esineet DEPRECATED

Tämä endpoint tulee poistumaan pian. Siirry käyttämään lähes identtistä v2 endpointtia.

https://trueworlds.net/api/v1/items.json

Rakenne
{
  "updated": "2021-01-01T12:00:00+03:00",
  "items": [
    {
                                         // Vain type ja tag on varmasti jokaisessa. Muut vaihtelee itemin mukaan
      "type": "stone",                   // Itemin tyyppi (sama kuin mitä advanced tooltipseissa on)
      "tag": "a",                        // Kauppakyltissä olevat merkit risuaidan jälkeen


      "name": "§aEsimerkki itemi",       // Anvililla laitettu nimi, formatoinnit § -merkillä
      "lore": [                          // Lore, formatoinnit § -merkillä
        "Rivi 1",
        "Rivi 2"
      ],


      "enchants": {                      // Enchantit
        "unbreaking": 3,
        "silk_touch": 1
      },


      "potion_type": "weakness",         // Potionin efekti (Käytetään myös tipped arrowissa)
      "potion_upgraded": false,          // Onko käytetty glowstonea
      "potion_extended": false,          // Onko käytetty redstonea


      "firework_effects": [              // Ilotulituspanosten ja rakettien efektit
        {
          "trail": false,                // Onko käytetty timanttia
          "flicker": false,              // Onko käytetty glowstonea
          "colors": [                    // Käytetyt värit rgb hexana (RRGGBB)
            "b3312c",
            "253192"
          ],
          "fadecolors": [
            "6689d3"
          ]
        }
      ],
      "firework_duration": 1,            // Montako ruutia käytetty


      "armor_color": "1d1d21",           // Nahkaarmorin väri (RRGGBB)


      "fish_body_color": "white",        // Tropicalfishin perusväri
      "fish_pattern_type": "clayfish",   // Kuvionti https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/TropicalFish.Pattern.html
      "fish_pattern_color": "red",       // Kuvion väri


      "banner_patterns": [               // Bannerien kuviot järjestyksessä
        {
          "pattern": "flower",           // Kuvio https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/banner/PatternType.html
          "color": "white"               // Kuvion väri
        },
        {
          "pattern": "triangle_top",
          "color": "green"
        }
      ],


      "book_title": "Eeppinen tarina",   // Kirjoitetun kirjan nimi
      "book_author": "Kallekirjailija",  // Kirjoittaja
      "book_generation": "original",     // Monesko kopio (original, copy_of_original, copy_of_copy)


      "axolotl_variant": "cyan",         // Axolotlin väri https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/Axolotl.Variant.html


      "custom_model_data": 100           // Hattujen sekä muiden custom itemien ID resurssipakettia varten
    }
  ]
}
		
Arkkukauppat v2

https://trueworlds.net/api/v2/shops

https://trueworlds.net/api/v2/shops/<pelinimi tai uuid>

Rakenne
[
  {
    "world": "survival",           // Joko "survival" tai "nether"
    "x": 100,
    "y": 50,
    "z": -200,
    "item": "EnchantedBook#a",     // Mitä myyntikyltissä lukee
    "tag": "a",                    // Risuaidan jälkeen olevat merkit tai null
    "item_type": "enchanted_book", // Sama mitä tiedostonimissä yms
    "amount": 1,
    "price_buy": 100,
    "price_sell": null,
    "shopkeeper": {
      "uuid": "6825974a-7b2d-47e9-9155-1c568ceed43c",
      "username": "jeeukko"
    },
    "id": "survival_100_50_-200"   // maailma_x_y_z
  }
]
		
NBT:tä sisältävät esineet v2

https://trueworlds.net/api/v2/items

https://trueworlds.net/api/v2/items/<esineen tagi>

Rakenne
[
  {
                                       // Vain type ja tag on varmasti jokaisessa. Muut vaihtelee itemin mukaan
    "type": "stone",                   // Itemin tyyppi (sama kuin mitä advanced tooltipseissa on)
    "tag": "a",                        // Kauppakyltissä olevat merkit risuaidan jälkeen


    "name": "§aEsimerkki itemi",       // Anvililla laitettu nimi, formatoinnit § -merkillä
    "lore": [                          // Lore, formatoinnit § -merkillä
      "Rivi 1",
      "Rivi 2"
    ],


    "enchants": {                      // Enchantit
      "unbreaking": 3,
      "silk_touch": 1
    },


    "potion_type": "weakness",         // Potionin efekti (Käytetään myös tipped arrowissa)
    "potion_upgraded": false,          // Onko käytetty glowstonea
    "potion_extended": false,          // Onko käytetty redstonea


    "firework_effects": [              // Ilotulituspanosten ja rakettien efektit
      {
        "trail": false,                // Onko käytetty timanttia
        "flicker": false,              // Onko käytetty glowstonea
        "colors": [                    // Käytetyt värit rgb hexana (RRGGBB)
          "b3312c",
          "253192"
        ],
        "fadecolors": [
          "6689d3"
        ]
      }
    ],
    "firework_duration": 1,            // Montako ruutia käytetty


    "armor_color": "1d1d21",           // Nahkaarmorin väri (RRGGBB)


    "fish_body_color": "white",        // Tropicalfishin perusväri
    "fish_pattern_type": "clayfish",   // Kuvionti https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/TropicalFish.Pattern.html
    "fish_pattern_color": "red",       // Kuvion väri


    "banner_patterns": [               // Bannerien kuviot järjestyksessä
      {
        "pattern": "flower",           // Kuvio https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/banner/PatternType.html
        "color": "white"               // Kuvion väri
      },
      {
        "pattern": "triangle_top",
        "color": "green"
      }
    ],


    "book_title": "Eeppinen tarina",   // Kirjoitetun kirjan nimi
    "book_author": "Kallekirjailija",  // Kirjoittaja
    "book_generation": "original",     // Monesko kopio (original, copy_of_original, copy_of_copy)


    "axolotl_variant": "cyan",         // Axolotlin väri https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/Axolotl.Variant.html


    "custom_model_data": 100           // Hattujen sekä muiden custom itemien ID resurssipakettia varten
  }
]
		
Peliaika arvot

https://trueworlds.net/api/v2/ranks

Rakenne
[
  {
    "name": "Quadro Respected",         // Rankin nimi
    "playtime_required": 28800000,      // Vaadittu peliaika sekunteina, null jos ylläpitoarvo
    "playtime_required_human": "8000h", // Vaadittu peliaika ihmisystävällisessä muodossa, null jos ylläpitoarvo
    "color_minecraft": "light_purple",  // Värin nimi jota käytetään kun rajoitettu minen perusväreihin
    "color_hex": "ff55ff",              // RGB-hex väri jota käytetään kun mahdollista
    "prefix": ":]",                     // Respected hymiö tai ylläpitoarvon prefix, null jos ei ole
    "staff": false                      // Onko kyseessä ylläpitoarvo
  }
]
		
Pelaajan peliaika ja rangaistukset

HUOM! Tilapäisesti ei näytä survissa saatua peliaikaa 1.17 päivityksestä johtuen

https://trueworlds.net/api/v2/players/<pelinimi tai uuid>

Rakenne
{
  "username": "jeeukko",                          // Nykyinen nimi
  "uuid": "6825974a-7b2d-47e9-9155-1c568ceed43c", // UUID viivoilla
  "playtime": 7200000,                            // Peliaika sekunteina
  "playtime_human": "2000h 0m",                   // Peliaika ihmisystävällisessä muodossa
  "punishments": [                                // Array jossa mahdolliset rangaistukset, muuten tyhjä
    {
      "reason": "muu, ei tehnyt forkkia",         // Rangaistuksen syy
      "staff": "Vimppura",                        // Ylläpitäjän nimi rangaistuksen antohetkellä
      "start": "2021-01-01T12:00:00+02:00",       // Alkamisajankohta (ISO 8601/RFC 3339)
      "end": "2021-06-01T12:00:00+03:00",         // Loppumisajankohta (null jos pysyvä merkintä)
      "type": "ban"                               // Rangaistuksen tyyppi (ban/mute/permaban/warning/note/kick)
    }
  ]
}