gridplay/gridplayapi

GridPlay API

Maintainers

Details

github.com/gridplay/gridplayapi

Source

Issues

Installs: 47

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

v3.1.2 2025-06-12 16:07 UTC

Requires

MIT 2e43f1d94f424e06cd39d90b91751166af6c2ffd

apigridplay

This package is auto-updated.

Last update: 2025-06-12 16:08:52 UTC

README

A API to use the GridPlay.net services for SecondLife and opensim residents.

Currently only working for SecondLife as we are still working on getting code writen to support opensim

To use first install with composer

composer require gridplay/gridplayapi

For config just do

php artisan vendor:publish --provider="GridPlayAPI\GPAPIServiceProvider"

This will create a config file located in config/gridplay.php

This config file MUST contain your GPAPI_ID and GPAPI_SECRET API key in order for the request to go through.

Made for Laravel 11+.

To use is easy

GridPlay::Name2Key($user_name); // [put] string of the user's UUID key
GridPlay::Key2Name($user_uuid); // [put] string of the user's name
GridPlay::Wmps(); // [get] array shows a list of those using WMPS
GridPlay::getImg($texture_uuid); // [get] array ['img' => (url of pic)]
GridPlay::getProfPic($user_uuid); //[get] array ['img' => (url of pic)]
GridPlay::sendIM($towhouuid, $msg); //[put] array as ['status' => true] if successful
GridPlay::isOnline($uuid); //[put] array as ['isOnline' => true|false]
GridPlay::getGrid($userFromHeader); // [get] gets the grid's initals
GridPlay::getNews($site, $show, $page); // [get] returns news from the news api

Ventalkie::getChannel($search); // [get] array gets all the channels or of $search

GridHaul::getHub($search); // [get] array gets all hubs or of $search
GridHaul::getItems($search); // [get] array same for here
GridHaul::getJobs(); // [get] array shows all current jobs

ALL [put] functions requires config setup in config/gridplay.php

Please use Log::debug() or dd() to see what is returned before coding any further with these functions. All data returned is in json format and should be in a array when returned to your function call.

For errors....

Connection invalid = The connection to the gridplay server was invalid for some odd reason Unable to connect = Unable to reach the gridplay server, please try again in afew minutes Invalid key = Your ID and SECRET in gridplay.php config was invalid.

Changelog

== 3.1.2 - June 12 2025 ==

  • Only added parseName($name) to help parse .resident out of someone's name

== 3.1.1 - April 23 2025 ==

  • Support for Laravel 12
  • Added in centralized achievements and levels with XP
  • Added titles and achievements

== 3.1 - Dec 28 2024 == Last update for the year

  • Now ALL API's will go to their own site. ie. ventalkie goes directly to the ventalkie.com website
  • Took out the api key requirement for GET calls
  • Did some code clean up to reduce memory usage
  • Ventalkie API can ONLY fetch channel data, no able to send on a channel
  • Took out referrence to Canadian Grid and Opensim due to the fact GridPlay is staying exclusivly to SL
  • Updated the README to be more clear and updated of all the functions
  • Moved key2name and name2key to be a put call to reduce spam

== 3.0.2 - Dec 26 2024 ==

  • Added getting news from our API in a GET method

== 3.0.1 - Dec 23 2024 ==

  • Added Multigrid support, converting user from header to initals
  • Added GridHaul api back into the system, still gotta work on ventalkie
  • Took out GridPhone since that ended sorry

== 3.0.0 - April 22 2024 ==

  • Switched to support Laravel 11 plus