Skip to content

Home

Jump to bottom
Vivien Richter edited this page Aug 28, 2019 · 1 revision

The in-world board is based on simple prims and LSL. It uses the website as gateway to the database.

Gateway API

It's an simple HTTP GET call: https://slsr.org/<CATEGORY>?client=<BOARD_OWNER_ID>&version=<BOARD_VERSION>&location=<BOARD_LOCATION>

Categories

  • shrines (All shrines)
  • inari (Inari shrines)
  • amaterasu (Amaterasu shrines)
  • and so on..

Owner ID

This ID is a legacy attribute. That means, today it is only needed to determine if a board want's to use the website as gateway or a web browser wants to deliver the website. So it's only needed to choose an unsigned integer, greater then zero. It have also the alias id for compatibility reasons.

The following examples will deliver the same content:

  • GET: https://slsr.org/shrines?client=1
  • GET: https://slsr.org/shrines?id=1
  • GET: https://slsr.org/shrines?client=26
  • GET: https://slsr.org/shrines?id=26

Version (since 2.2.0)

This version number follows semantic versioning (https://semver.org).

Location (since 2.5.0)

The current location of the board consists of the escaped region name and it's coordinates. For example: Sallow/140/117/33

Returned result

The calls resulting in a minimized version of the website with a list of articles with the following structure:

<!DOCTYPE html>
<html ... >
    ...
    <body>
        ...
        <main><section>
            ...
            <article>
                <header><h3 id="shrine_ID">TITLE</h3></header>
                <img src="IMAGE_URL" ... >
                <p>SHRINE_DESCRIPTION</p>
                <p class="owner">
                    ...
                    <a href="OWNER_PROFILE_URL" ... >OWNER_NAME</a>
                    ...
                </p>
                <a class="teleport" href="TELEPORT_URL"> ... </a>
            </article>
            ...
        </section></main>
        ...
    </body>
</html>

The result attributes:

  • ID (Internal auto incrementing unsigned integer ID of the shrine)
  • TITLE (Full shrine name)
  • IMAGE_URL (Shrine image URL [Compressed image with half-sized resolution. For full resolution, please remove the part ../small/.. from the URL.])
  • OWNER_PROFILE_URL (SL client compatible profile URL of the shrine owner)
  • OWNER_NAME (Shrine owner name)
  • TELEPORT_URL (SL client compatible teleport URL to the shrine)

© 2019 ⛩️ SL Shinto shrine register

Clone this wiki locally