starcitizenwiki/apiunto

Lua Extension for MediaWiki to access the Star Citizen Wiki API.

2.0.0 2023-07-19 10:32 UTC

Requires

• php: >=8.0
• guzzlehttp/guzzle: ^7.4.0

Requires (Dev)

• mediawiki/mediawiki-codesniffer: v40.0.0
• mediawiki/mediawiki-phan-config: 0.12.0
• mediawiki/minus-x: 1.1.1
• php-parallel-lint/php-console-highlighter: 0.5.0
• php-parallel-lint/php-parallel-lint: v1.3.2

MIT

README

Lua Extension for MediaWiki to access the Star Citizen Wiki API

Installation

wfLoadExtension( 'Apiunto' );

$wgApiuntoKey = ''; // Key from api.star-citizen.wiki
$wgApiuntoUrl = 'https://api.star-citizen.wiki'; // Or self-host https://github.com/StarCitizenWiki/API
$wgApiuntoTimeout = '5'; // 5 seconds
$wgApiuntoDefaultLocale = 'de_DE'; // Or en_EN

Lua Usage

local api = mw.ext.Apiunto

-- Request the ship data for the 300i with german locale
-- Docs: https://docs.star-citizen.wiki/star_citizen_api.html#raumschiffe
-- Output: https://api.star-citizen.wiki/api/v2/vehicles/300i?locale=de_DE
local ship_300i = api.get_raw( 'v2/vehicles/300i', {
    locale = 'de_DE',
} )
local json = mw.text.jsonDecode( ship_300i )


-- Request data for the 300i with both german and english locale
local ship_300i = api.get_raw( 'v2/vehicles/300i' )

-- Request data for the 300i with english locale and included components
local ship_300i = api.get_raw( 'v2/vehicles/300i', {
    locale = 'en_EN',
    include = { 'components' }
} )

-- Request data for the Greycat Industrial ROC
-- Docs: https://docs.star-citizen.wiki/v2
-- Output: https://api.star-citizen.wiki/api/v2/vehicles/ROC
local roc = api.get_raw( 'v2/vehicles/ROC' )

-- RSI Manufacturer data
-- Docs: https://docs.star-citizen.wiki/v2
-- Output: https://api.star-citizen.wiki/api/v2/manufacturers/RSI
local rsi = api.get_manufacturer( 'RSI' )

-- RSI Manufacturer data with vehicles
-- Docs: https://docs.star-citizen.wiki/v2
-- Output: https://api.star-citizen.wiki/api/v2/manufacturers/RSI
local rsi = api.get_manufacturer( 'RSI', {
    include = 'vehicles'
} )

-- Comm-Link Metadata
-- Docs: https://docs.star-citizen.wiki/v2
-- Output: https://api.star-citizen.wiki/api/v2/comm-links/12667
local commLink = api.get_comm_link_metadata( 12667 )

-- Comm-Link Metadata including images and image hashes
-- Docs: https://docs.star-citizen.wiki/star_citizen_api.html#comm-links
-- Output: https://api.star-citizen.wiki/api/v2/comm-links/12667
local commLink = api.get_comm_link_metadata( 12667, {
    include = {
        'images',
        'images.hashes',
    }
} )

-- Star System Data
-- Includable: "jumppoint_entries", "jumppoint_exits", "celestial_objects"
-- Output: https://api.star-citizen.wiki/api/v2/starsystems/sol
local sol = api.get_starsystem( 'sol' ) -- Or: 'SOL' / 355 (id)

-- Celestial object data
-- Output: https://api.star-citizen.wiki/api/v2/celestial-objects/SOL.JUMPPOINTS.CROSHAW
local jumppoint = api.get_celestial_object( 'SOL.JUMPPOINTS.CROSHAW', {
    include = { }
} )

-- Output: https://api.star-citizen.wiki/api/v2/celestial-objects/2702
-- YULIN.STATION.YULINFLOTILLA
local objectById = api.get_celestial_object( 2702, {
    include = { }
} )