Extension:RobloxAPI

MediaWiki extensions manual

RobloxAPI Release status: experimental
Implementation	Parser function
Description	provides easy access to the Roblox API via parser functions
Author(s)	SomeRandomDeveloper
Latest version	1.0.0 (Continuous updates)
Compatibility policy	Master maintains backward compatibility.
MediaWiki	1.41+
License	GNU General Public License 2.0 or later
Download	GitHub: project page git repository URL [help ] commit history Note: No localisation updates are provided by translatewiki.net .
Parameters $wgRobloxAPIRequestUserAgent $wgRobloxAPIParserFunctionsExpensive $wgRobloxAPIEnabledDatasources $wgRobloxAPIAllowedArguments $wgRobloxAPIDisableCache $wgRobloxAPIEnabledParserFunctions $wgRobloxAPICachingExpiries
Hooks used ParserFirstCallInit

The RobloxAPI extension provides easy access to the Roblox API via parser functions. The Roblox API is generally very poorly documented, and using ExternalData or Lua can be hard or not viable for all wiki users. This extension aims to make it easy for you to grab data from Roblox and put it on your wiki.

Installation

• Download and place the file(s) in a directory called RobloxAPI in your extensions/ folder.
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'RobloxAPI' );
  

•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Usage

Refer to this section on how to use the extension. Alternatively, refer to the USAGE.md file in the respoistory

Parser functions

Data parser functions

These functions return processed data from the Roblox API. See below on how to get the universe ID of any experience.

Name	Description	Arguments	Example	Internal name
{{#rblxGroupRank}}	Get the name of a user's rank in a group.	GroupId, UserId	{{#rblxGroupRank: 32670248 | 4182456156}}	roblox_grouprank
{{#rblxPlaceActivePlayers}}	Get the number of active players in a place.	UniverseId, PlaceId	{{#rblxPlaceActivePlayers: 4252370517 | 12018816388}}	roblox_activeplayers
{{#rblxPlaceVisits}}	Get the number of visits to a place.	UniverseId, PlaceId	{{#rblxPlaceVisits: 4252370517 | 12018816388}}	roblox_visits
{{#rblxGroupMembers}}	Get the number of members in a group.	GroupId	{{#rblxGroupMembers: 32670248}}	roblox_groupmembers
{{#rblxUserAvatarThumbnailUrl}}	Get the URL of a user's avatar thumbnail.	UserId, ThumbnailSize	{{#rblxUserAvatarThumbnailUrl: 1995870730 | 140x140 }}	roblox_useravatarthumbnailurl

JSON parser functions

These functions return the raw data from the Roblox API as JSON with little to no processing. Each function is automatically enabled if the corresponding data source is enabled.

Name	Arguments	Example	Data source
{{#rblxGameData}}	UniverseId, PlaceId	{{#rblxGameData: 4252370517 | 12018816388}}	gameData
{{#rblxGroupRoles}}	UserID	{{#rblxGroupRoles: 4182456156}}	groupRoles
{{#rblxGroupData}}	GroupId	{{#rblxGroupData: 32670248}}	groupData
{{#rblxUserAvatarThumbnail}}	UserId, ThumbnailSize	{{#rblxUserAvatarThumbnail: 1995870730 | 140x140 }}	userAvatarThumbnail
{{#rblxBadgeInfo}}	BadgeId	{{#rblxBadgeInfo: 2146223500}}	badgeInfo
{{#rblxUserInfo}}	UserId	{{#rblxUserInfo: 1995870730}}	userInfo
{{#rblxAssetDetails}}	AssetId	{{#rblxAssetDetails: 102611803}}	assetDetails

Data sources

The following data sources are available:

Name	Description
gameData	Game data for a place in a universe.
groupRoles	Returns all group roles of a user.
groupData	Returns data about a group.
userAvatarThumbnail	Returns the URL of a user's avatar thumbnail.
badgeInfo	Returns information about a badge.
userInfo	Returns information about a user.
assetDetails	Returns information about an asset.

Argument types

IDs

Allowed values: Any positive integer.

Obtaining the Universe ID

To get an experience universe ID, input the game ID to this API:

https://apis.roblox.com/universes/v1/places/<GAMEID>/universe

ThumbnailSize

Allowed values: 30x30, 48x48, 60x60, 75x75, 100x100, 110x110, 140x140, 150x150, 150x200, 180x180, 250x250, 352x352, 420x420, 720x720

Configuration

$wgRobloxAPIEnabledDatasources

An array of data sources that should be enabled and available. By default, all data sources are enabled:

$wgRobloxAPIEnabledDatasources = [
    'gameData',
    'groupRoles',
    'groupData',
    'userAvatarThumbnail',
    'badgeInfo',
    'userInfo',
    'assetDetails',
];

$wgRobloxAPIEnabledParserFunctions

An array of parser functions that should be enabled. JSON parser functions cannot be enabled or disabled here, instead they are enabled if their corresponding data source is enabled. By default, all data parser functions are enabled:

$wgRobloxAPIEnabledParserFunctions = [
    'roblox_grouprank',
    'roblox_activeplayers',
    'roblox_visits',
    'roblox_groupmembers',
    'roblox_useravatarthumbnailurl',
];

$wgRobloxAPICachingExpiries

An array of cache expiry times (in seconds) for each data source. By default, all data sources have a cache expiry time of 10 minutes:

$wgRobloxAPICachingExpiries = [
    '*' => 600,
];

If you want to set a different cache expiry time for specific data sources, you can do so like this:

$wgRobloxAPICachingExpiries = [
    '*' => 600,
    'gameData' => 120,
    'groupRoles' => 180,
];
</source>

In this example, all other data sources will have a cache expiry time of 60 seconds.

=== <code>$wgRobloxAPIAllowedArguments</code> ===

An array of allowed arguments per argument type. If empty, all arguments for the type are allowed. Any argument types that do not have an entry in this array will allow any value. This is useful for restricting arguments. By default, all arguments are allowed:

<syntaxhighlight lang="php">
$wgRobloxAPIAllowedArguments = [];

If you want to restrict the allowed arguments for a specific type, you can do so like this:

$wgRobloxAPIAllowedArguments = [
    'GameID' => [123456, 789012],
];

In this example, only the Game IDs 123456 and 789012 are allowed.

$wgRobloxAPIRequestUserAgent

The user agent that should be used when making requests to the Roblox API. By default, it uses the default one provided by MediaWiki. If you want to change it, you can set this variable to a custom user agent:

$wgRobloxAPIRequestUserAgent = 'RobloxAPI MediaWiki Extension';

$wgRobloxAPIDisableCache

Whether to disable the cache for the extension. By default, caching is enabled:

$wgRobloxAPIDisableCache = false;

If you want to disable caching, you can set this variable to true:

$wgRobloxAPIDisableCache = true;

$wgRobloxAPIParserFunctionsExpensive

Whether to mark the extension's parser functions as expensive. By default, they are marked as expensive:

$wgRobloxAPIParserFunctionsExpensive = true;

If you don't want to mark the extension's parser functions as expensive, you can set this variable to false:

$wgRobloxAPIParserFunctionsExpensive = false;