Difference between pages "SZYM Tower (building)" and "Global Mod Link System"

(Difference between pages)
 
m
 
Line 1: Line 1:
'''SZYM Tower''' has been the name given to several large high-rise buildings built by [[Will Szymborska]]. Although they are numbered chronologically, they are all formally known as "SZYM Tower" without the numerical designation. The name is a play on the game [https://en.wikipedia.org/wiki/SimTower SimTower], which was one of Will's favorite video games during childhood.
+
The '''Global Mod Link System (GMLS)''' is a free, full-permission script system provided by the NTBI Group. Anyone can implement GMLS into their modifiable vehicle, and anyone can build mods that automatically position themselves when linked to a GMLS-compatible vehicle.
  
 +
==Overview==
 +
GMLS is a set of full-permissions scripts. It is intended for use in modifiable vehicles to simplify the installation of prebuilt modifications. For example, the NTBI Factory Lightbar Package uses GMLS to automatically position lightbars when linked to compatible vehicles.
  
==SZYM Towers I, II, and III==
+
Aftermarket modification manufacturers can set up GMLS by linking a copy of the modification to the desired vehicle and using the Calibration Tool to set up the Alignment Tool. Then, when an end-user links the modification to a compatible vehicle, the modification will reposition itself (and, if necessary, rescale itself) automatically. GMLS can also unlink certain prims from the vehicle for factory prim replacements.
Little is known of these towers. They were constructed on the Teen Grid.
 
  
==SZYM Tower IV==
+
GMLS comes with three scripts:
This tower was located in the [[Bliss]] region. It was demolished when Bliss shut down, in part due to ongoing drama between [[Will Szymborska]] and [[Nelson Jenkins]] before he joined NTBI.
 
  
==SZYM Tower V==
+
* '''NTBI GMLS Alignment Tool''' - Inserted into aftermarket modifications and edited by the modification manufacturer to program alignment positions and other options.
[[File:6829184757_604f7747c3_o.png|200px|thumb|right|SZYM Tower V in Lionheart next to the Union Micro building.]]
+
* '''NTBI GMLS Calibration Tool''' - Used to calibrate alignment positions; outputs alignment data to be placed in the Alignment Tool.
This tower was located in Lionheart. It hosted the NTBI 2010 Christmas Party, where [[Nelson Jenkins]] was formally introduced as an NTBI affiliate. The tower was infamous for its easily broken elevators.
+
* '''NTBI GMLS Vehicle Sample Script''' - Inserted into vehicles and edited by the vehicle manufacturer to define vehicle information for use by modifications.
  
==SZYM Tower VI==
+
The NTBI Group does not maintain a list of compatible vehicles or modifications. GMLS-compatible products should clearly label themselves as such. The NTBI Group does not provide any warranty for third-party GMLS implementations.
[[File:5528673536_da5e1c0c7e_o.png|200px|thumb|right|SZYM Tower VI in Lionheart with the [[Gentek Interregional Tower]] in the background.]]
 
SZYM Tower VI was a total remodel of SZYM Tower V in the same location in Lionheart.
 
  
The tower remained in the same location and was inhabited on a regular basis.
+
<big>[https://marketplace.secondlife.com/p/GMLS-Development-Kit-Tools-for-Integrating-the-Global-Mod-Link-System/20803262 '''Click here''' for the GMLS developer kit.]</big>
  
Soon after, the [[Gentek Interregional Tower]] was built across the street. After a few weeks, GIT was moved to a different location across a different street and a skybridge was erected between them.
+
==End-User Instructions==
 +
Refer to your vehicle's owner's guide for instructions on how to install GMLS-compatible equipment.
  
The tower held mostly offices, with some various stores interspersed throughout the floors.
+
If the owner's guide does not provide instructions, the following is a general checklist for installing GMLS-compatible modifications:
  
==SZYM Tower VII==
+
# Ensure that the vehicle is turned off, including any lighting or other components that may change any attributes while installing the modification.
[[File:6502031933_7c9c783d91_o.png|200px|thumb|right|SZYM Tower VII in the distance during a smoggy morning.]]
+
# Take a copy of your vehicle as-is. Modifications may cause damage or unlink prims accidentally. Save a copy now in case this happens!
This tower was a short-lived endeavor in the Prototype region.
+
# Rez the modification near your vehicle.
 +
# Right click the modification and select "Edit".
 +
# With the Edit window open, hold your SHIFT key and left click the vehicle. This should select both objects at once. Make sure you select the vehicle last.
 +
# Press your CTRL + L keys, or click the "Link" button in the Edit window.
 +
# If prompted, confirm that you want to link the two objects together.
 +
# When linked, the modification should automatically position itself to the recommended position and resize if necessary.
 +
# If prompted, grant link permissions. This may unlink some prims. Make sure to delete them after.
 +
# If desired, you may usually move the equipment once linked.
  
The tower was never completed, as it was deemed too prim-heavy for the region. Shortly after, the first [[Prototype Mall]] was built.
+
If a modification does not use GMLS, is not compatible with your vehicle's GMLS system, or returns an error when linking using the above procedure, follow steps 1 through 6, then manually reposition the modification as needed.
  
The design was reminiscent of previous SZYM Tower designs.
+
==Aftermarket Modification Manufacturer Instructions==
 +
Get the Alignment Tool and Calibration Tool from the [https://marketplace.secondlife.com/p/GMLS-Development-Kit-Tools-for-Integrating-the-Global-Mod-Link-System/20803262 GMLS developer kit.]
  
==SZYM Tower VIII==
+
Before continuing, make sure your mod is finished. Do not continue until you are sure you do not need to make any changes to your object.
[[File:8053582228_98de1cbdfe_o.jpg|300px|thumb|right|Postcard of SZYM Tower VIII.]]
 
This tower was built in Celaeno after the demolition of the [[NTBI Celaeno Complex]] in September 2012. The building structure was completed and floorplans were developed, but only around 1/4th of the building was ever furnished before its demolition in anticipation of the move to the private NTBI region.
 
  
The tower was designed to accommodate the amenities provided by the Celaeno Complex in a more spacious vertical arrangement. As the Celaeno Complex featured only 5 floors (including basements) the tower provided a generous increase by way of 21 accessible floors (25 total) and 3 basements. Floors B1, B2, and 1-8 (1 and 2 being the lobby) were deemed public with plans to lease out upper floors to other companies, while floors 9-24 and B3 (excluding the lower auditorium) were private and only accessible to NTBI affiliates and staff.
+
# Make a two copies of your object. One will be used for calibration. The other will be distributed to your end-users.
 +
# Place the "NTBI GMLS Alignment Tool" script in the distribution object (the one you will keep).
 +
# Place the "NTBI GMLS Calibration Tool" script in the calibration object (the one you will link, then delete).
  
Two public elevators served the public floors, while an express elevator accessed floors L, 9, B1, and B3. A separate bank of elevators beyond an NTBISS checkpoint served floors 9-24. A car elevator was also accessible from the exterior of the building on floor L, as well as floors B1 (private parking) and B3 (vault).
+
For each vehicle you want your object to be compatible with:
  
Below is information obtained from the final revision of the building's directory, on October 1, 2012:
+
# Make a new copy of the calibration object. It should have the "NTBI GMLS Calibration Tool" script already in it.
* The lobby floor featured entrances on all sides with a front desk and access to the central public and express elevator banks. The lobby spanned two floors. Some sections of it were furnished. The back portion of the lobby was to feature a museum on the history of NTBI and its affiliates, but it was never built.
+
# Rez the vehicle. Make sure it is the original size!
* Floors 4-8, which were public, were to be leased out to companies, but never were. None were furnished.
+
# Position the calibration object on the vehicle, exactly where you want it to be once installed by the end-user.
* Floor B1, although accessible from the public elevator bank, only housed private parking, laundry, and maintenance services.
+
# Link the calibration object to the vehicle.
* Floor B2 offered access to a ballroom and the auditorium. It was the lowest level accessible to the public - access to the lower level of the auditorium was done through a large stairwell along the side.
+
# Copy the script snippet line sent to local chat.
* Floor B3 housed a secure vault as well as a data center which would have hosted backup servers.
+
# Open the "NTBI GMLS Alignment Tool" script in the distribution object.
* Floor 9 was the sky lobby, accessible from the ground only from the private express elevators. It was to house a cafe and security checkpoint, beyond which would have been access to the private local elevator serving the upper floors. It was only partially furnished.
+
# Paste the script snippet line between the two marked lines at the top of the script. NOTE: The first part of each line is the GMLS ID of the vehicle you have calibrated to. If you see a line with the same GMLS ID, you have already calibrated to that vehicle, and only the first instance of that vehicle will be used.
* Floor 14 housed employee offices, which was only partially furnished.
+
# Save the "NTBI GMLS Alignment Tool" script.
* Floor 15 was to house another dining area exclusively for private parties, as well as a large kitchen. It was never completed.
 
* Floor 16 was the only floor fully completed, which was the home of the executive lounge. It had a very elaborate smoking lounge area, as well as some extra rooms and an in-house salon.
 
* Floor 17 was the private apartments of [[Will Szymborska]], [[Nelson Jenkins]], and [[Lyte Rae]], the primary owners of the Celaeno land. Although partially completed, they were never inhabited long-term. All apartments featured a living room, bathroom, and bedroom, although the bedroom in Lyte Rae's apartment was used as an office.
 
* Floor 18 housed two boardrooms which extended into the 19th floor.
 
* Floor 20 was an observation floor, featuring an exterior deck.
 
* Floor 21 was the office of [[Nelson Jenkins]], although it was never furnished.
 
* Floor 24 was the office of [[Will Szymborska]], which was partially furnished.
 
* Floors 3, 11, 12, 13, 22, and 23 were never allotted for a specific use, and remained empty.
 
  
In November 2012, the building was demolished and the Celaeno land was abandoned. Construction began on the [[NTBI Development Campus]] in the NTBI region soon after.
+
Once finished, delete any calibration objects and vehicles.
  
==SZYM Tower IX==
+
If you want the root prim of the object to retain its physics type when linked to the vehicle, change root_no_physics to FALSE. (By default, the root prim of this object will be set to physics type "none" and the physics types of child prims will remain the same.)
[[File:43074843562_6c013f0253_k.jpg|300px|thumb|right|SZYM Tower IX at dusk.]]
 
SZYM Tower IX was built in [[Northbridge]] after the demolition of one of the Northbridge complexes in July 2018, then later moved to the [[NTBI (region)|NTBI region]]. The design is based off of the [https://en.wikipedia.org/wiki/NTT_Docomo_Yoyogi_Building NTT Docomo Yoyogi Building]. The tower stands 218 meters (715 feet) above ground level at the tip of its spire, and an additional 23 meters (75 feet) below ground level. On the southern exterior wall of floors 18 through SL/21, a large lit clock face shows the time in the Eastern US timezone, home to [[Will Szymborska]] and [[Nelson Jenkins]]. At night, the top three segments of the tower are lit, much like the [https://en.wikipedia.org/wiki/Empire_State_Building#Lights lighting at the top of the Empire State Building], although all in white. The exterior lighting is the only lighting to operate on estate time; all other time-based lighting and operations in the tower run on Eastern US time.
 
  
The tower itself is split into four general zones - the main tower (floors L through SL/21), the Tower Mall (most of floor B1, as well as a small portion of floors B2 through B4, including the Party Hall), the basement (the rest of floors B1 through B4), and the executive suites (floors 22 through 24, as well as the roof utility area). Certain rooms in the tower are connected using hidden passageways. Additionally, the tower site is the home of the Peter Nelson Convention Center (PNCC), a very large hall attached to the lobby of the tower designed for public events. The tower sees frequent use among NTBI staff and friends.
+
If you want to have the GMLS script automatically unlink prims, list their names in the remove_prims list. If you do this, you can also change remove_move_dist to change the distance unlinked prims will move up, and you can change remove_recolor to FALSE if you do not want unlinked prims to be recolored bright red for visibility.
  
SZYM Tower IX was the first to be built partially in mesh. The tower features the Maestro 512 Background Music System throughout the building in four separate zones - the PNCC (which plays a selection of [https://en.wikipedia.org/wiki/J-pop#City_Pop city pop], particularly [https://www.youtube.com/watch?v=6GEI3PpXEAo Casiopea]), the lobby/skylobby (which plays light jazz), the Party Hall (never used), and Club Shinjuku (which plays piano music). Gentek lighting is installed throughout the building, and lighting in common areas automatically switches into eco mode at 11:45 PM nightly. Additionally, several areas - Ramen Man, KanSalon, the mailroom, the skylobby TahdaMart, and Club Shinjuku - open and close at different times daily using lights and security grate doors. On weekends, some opening times are shortened. Finally, beta NBS Synchron synchronized clocks are installed throughout the building, as are [[Gentek]] [[Security Camera Kit]] cameras, [[Gentek]] [[IntelliDoor]] doors, and [[NBS]] [[NorPhone]] public and private phones. [[Nelson Jenkins]] also beta-tested the [[Gentek]] [[Delta Elevator]] using four elevator cars - two assigned to the main bank, one for the Tower Mall basement levels, and one for the NTBI executive suites above the skylobby. He also designed a proprietary room numbering placard system and installed an early beta of [[BTN]] to broadcast to a handful of televisions throughout the building.
+
If you do not want the object to be set to temporary when unlinking prims in the remove_prims list so that they automatically delete themselves, change make_temp to FALSE.
  
One of the more popular features of SZYM Tower IX was the NTBI Resident bot, which sat at the reception desk in the lobby and walked to the bathrooms and TahdaMart on floor B1 every few hours. The bot ran well for several months, but at the start of December, he trapped himself in a bathroom stall and could not escape for several days. For this reason, he was canonically demoted to mall security at the [[Prototype Gardens Mall]].
+
When finished, make sure you test your modification on each compatible vehicle to make sure it works correctly.
  
The tower layout is as follows:
+
===API===
* Floor B4 houses storage rooms, a vault, a generator room, a development center, and the private apartment of [[Will Szymborska]]. It was also to house a [[Gentek Telecom]] exchange, although this has not been completed.
+
The Alignment Tool and vehicle script send the following link messages that can be used to trigger additional scripts in your modification:
* Floor B3 houses the Party Hall, theater, management office, restrooms, and NTBISS operations and conference rooms, as well as escalators up to floor B2.
 
* Floor B2 houses a laundry room and mailroom, plus access to the projector booth of the theater. Most of this floor is used for the upper half of the Party Hall and theater, as well as an intermediate landing for the escalators between floors B1 and B3.
 
* Floor B1 houses the Tower Mall, including a 24-hour TahdaMart, a KanSalon, Ramen Man (a ramen shop), and two empty spaces, one used for displaying suits. The building security room is located in the mall area, as are restrooms. This floor also has access from the mall to an underground parking garage, drop-off zone, and two loading docks, accessible from ramps to the underground parking lot outside at ground level. An NTBISS garage is located behind the southern loading dock. A second hallway connects to escalators up to the [[Prototype|Prototype Gardens Shopping Centre]]. The main escalators at the center of the Tower Mall connect to floors L and B2.
 
* Floor L is the lobby, which includes the reception desk, escalators to the Tower Mall, and direct elevator connections to all floors except the NTBI executive suites floors. Outside, the building features a covered drop-off area and a large parking lot.
 
* Floors 2-8 are filler floors.
 
* Floor 9 is a public leased floor.
 
* Floors 10-11 are filler floors.
 
* Floor 12 is used for 8 public leased offices, as well as a small break room and restrooms.
 
* Floor 13 is a filler utility floor.
 
* Floor 14 houses the NTBI staff offices, which include a large floor with cubicles, a conference room, a break room, and restrooms.
 
* Floors 15-18 are filler floors.
 
* Floor 19 is a public leased floor.
 
* Floor 20 houses the [[Gentek Telecom]] Network Operations Center, including an operator center, system monitoring displays, a conference room, the Records Department, and the billing data center.
 
* Floor SL (21) is the skylobby, which includes an observation deck, TahdaMart, Club Shinjuku (a full-service restaurant), and two sets of restrooms. The skylobby also has elevator access to the NTBI executive suites floors listed below, which are inaccessible to the public.
 
* Floor 22 is a filler floor.
 
* Floor 23 houses an executive conference room, two offices, a storage room, and a restroom.
 
* Floor 24 has a waiting room with receptionist, the offices of Will Szymborska and Nelson Jenkins, Nelson's private workshop, Will's private restroom (complete with gold toilet), and another restroom. Both offices are equipped with their own private Sei Audio sound systems, which are essentially the same technology used in the Maestro 512, as well as intercoms to the executive receptionist, security, lobby receptionist, and Will's private apartment.
 
* Floor R is the lower roof utility floor, which houses power and control equipment for the [[Gentek Telecom]] microwave antenna arrays on the exterior roof of the building. The actual roof is only accessible by stairs and a ladder, and houses air conditioners, the antenna arrays, aircraft obstruction warning lights, and the spire.
 
  
During construction, several planned rooms and features were removed, including a [[BTN]] TV studio, a much larger secure area for access to the vault, and a secret easter egg room.
+
* <code>GMLS_REQUEST</code>
 +
** Sent by Alignment Tool once linked. Vehicle responds with <code>GMLS_ID</code> if compatible. You can also send this manually once the GMLS script is finished if you need any information from <code>GMLS_ID</code>.
 +
* <code>GMLS_ID</code>
 +
** '''Key''': [gmls_id]|[root scale]|[additional information]
 +
** Sent by vehicle in response to <code>GMLS_REQUEST</code>. Note that [root scale] is not the ''size'' of the root prim of the vehicle, but rather the ratio of the current size of the root to the original size of the root. For example, [root scale] on a vehicle that was upsized to twice its original size would be <2.0, 2.0, 2.0> regardless of its actual size.
 +
* <code>GMLS_SUCCESS</code>
 +
** Sent by Alignment Tool if the GMLS operation completed successfully and it is now safe to perform any configuration changes or whatever else on the newly linked-to vehicle.
 +
* <code>GMLS_FAIL</code>
 +
** Sent by Alignment Tool if the GMLS operation failed either because the object the modification was just linked to is not GMLS-compatible or the vehicle has a gmls_id that the modification was not calibrated for.
 +
* <code>GMLS_CANCEL</code>
 +
** Sent by Alignment Tool if the GMLS operation was cancelled by the user.
  
<gallery>
+
==Vehicle Manufacturer Instructions==
File:40209258972_c920893a3a_k.jpg|During construction
+
Get the Alignment Tool and Calibration Tool from the [https://marketplace.secondlife.com/p/GMLS-Development-Kit-Tools-for-Integrating-the-Global-Mod-Link-System/20803262 GMLS developer kit.]
File:28430510359_11df500b0a_k.jpg|Original lobby
 
File:28430509999_859c0d8891_k.jpg|Peter Nelson Convention Center before December 2019 expansion
 
File:28430634139_17985ed565_k.jpg|Tower Mall on Floor B1 before redesign in June 2019
 
File:41881745225_ce3fc961ce_k.jpg|Underground parking and mall drop-off before December 2019 expansion
 
File:42065048254_3023f22f2b_k.jpg|Club Shinjuku
 
</gallery>
 
  
During its original existence in 2018, Northbridge was also the home to a [[Gentek Telecom]] microwave antenna tower on a hill on the other side of the region, as well as a filler factory, a scenic overlook, and the Hutson River, with a bridge crossing to [[Prototype]]. Passaic County Route 610 also ran through the region, as did the Northbridge Rail Line, which ran a freight train through every three hours from Prototype in the west through [[Glenbrook]] (Augest Isles) in the east. Those in Northbridge could also hear the Tredpro factory steam whistle, which blew twice at 9 AM, 12 PM, and 5 PM on weekdays. All of these features were scripted by [[Nelson Jenkins]].
+
Before continuing, make sure your vehicle's root prim will not be resized before it is distributed. Do not continue until the root prim is finalized.
  
On December 15, 2018, SZYM Tower IX, along with the rest of Northbridge, was demolished to make space for planned new construction that never significantly materialized. The NTBI bot was repurposed as a mall security officer in [[Prototype]].
+
# Place the "NTBI GMLS Vehicle Sample Script" script in the vehicle. If you prefer, you can also integrate this script into another script in the vehicle to save memory.
 +
# Edit the gmls_id string. You can use any string as long as it does not include the pipe ("|") character, but it should be limited to alphanumeric characters, underscores ("_"), and be up to 32 characters. The gmls_id must be unique for every vehicle that has a different layout of potential modification positions. For example, use different IDs for 2DR and 4DR variations of the same vehicle.
 +
# Edit the gmls_default_root_size vector to be the size of the root prim of the vehicle. On most viewers, you can get this value by opening the Edit window, going to the Object tab, and pushing the "C" button next to Size. WARNING: This is not optional. Failure to set this value will cause GMLS modifications to align improperly.
 +
# Save the "NTBI GMLS Vehicle Sample Script" script. If kept separate, you can [http://wiki.secondlife.com/wiki/LlSetMemoryLimit limit the memory used by the script] if you prefer.
  
On March 8, 2019, SZYM Tower IX was re-rezzed with very minor modifications. The rest of the region has been left flat and empty, except for filler trees, to maximize prim usage in the tower. Passaic County Route 610 was restored and the Northbridge Rail Line was reactivated. The NTBI bot, however, remained a mall security officer.
+
Perform this procedure for each vehicle variation. Once finished, it is a good idea to test the GMLS settings by creating a simple object and following the Aftermarket Modification Manufacturer Instructions.
  
On May 11, 2019, SZYM Tower began accepting rental applications for floors 9, 12, and 19 through its [https://szymtower.com/ website].
+
==Changelog==
 
+
Rev. 2
On June 1, 2019, the basement levels were redesigned to accommodate new escalators. These were the first installed escalators in Second Life to be fully animated and fully functional without the use of poseballs, courtesy of Animats. This redesign moved Ramen Man from floor B3 to B1, moved the Party Hall into the area previously used by the Tower Mall's floor B3 (including Ramen Man), and added a theater. A third empty store space was also added in the Tower Mall on floor B1, and the empty store space on floor B2 was eliminated to accommodate the upper area of the Party Hall. Later, on June 20, 2019, [[Nelson Jenkins]] replaced the escalator scripts to add minor details and synchronize with the nightly eco mode lighting.
+
* Added make_temp option.
 
+
* Changed unlinking parts procedure so that unlinked prims are set to temporary if make_temp is enabled.
On November 26, 2019, the tower was moved to the [[NTBI (region)|NTBI region]]. An underground walkway was added to allow access to the [[Prototype|Prototype Gardens Shopping Centre]] and another was added to the showroom floor of the new Peter Nelson Convention Center, which took one of the empty store spaces. An extra set of doors was added on the side facing the entrance to the Prototype Gardens Shopping Centre. The tower was also rotated to face north instead of south. The underground parking area was expanded to include more parking and two loading docks. A theater was finally constructed on floor B3. Finally, a set of bots were created to staff some of the facilities in and around the tower.
+
Rev. 1
 +
* Added GMLS_SUCCESS, GMLS_FAIL, and GMLS_CANCEL link messages.
 +
* Fixed erroring out and refusing to reposition if linked before permissions have been granted.
 +
* Fixed unlinking parts check running before checking if vehicle is compatible in the first place.
 +
* Fixed crosstalk when multiple GMLS modifications are rezzed at once.
 +
* Improved vehicle detection in slow regions by extending identification time from 2 seconds to 5 seconds.
 +
Rev. 0
 +
* Initial public release.

Revision as of 22:50, 20 April 2021

The Global Mod Link System (GMLS) is a free, full-permission script system provided by the NTBI Group. Anyone can implement GMLS into their modifiable vehicle, and anyone can build mods that automatically position themselves when linked to a GMLS-compatible vehicle.

Overview

GMLS is a set of full-permissions scripts. It is intended for use in modifiable vehicles to simplify the installation of prebuilt modifications. For example, the NTBI Factory Lightbar Package uses GMLS to automatically position lightbars when linked to compatible vehicles.

Aftermarket modification manufacturers can set up GMLS by linking a copy of the modification to the desired vehicle and using the Calibration Tool to set up the Alignment Tool. Then, when an end-user links the modification to a compatible vehicle, the modification will reposition itself (and, if necessary, rescale itself) automatically. GMLS can also unlink certain prims from the vehicle for factory prim replacements.

GMLS comes with three scripts:

  • NTBI GMLS Alignment Tool - Inserted into aftermarket modifications and edited by the modification manufacturer to program alignment positions and other options.
  • NTBI GMLS Calibration Tool - Used to calibrate alignment positions; outputs alignment data to be placed in the Alignment Tool.
  • NTBI GMLS Vehicle Sample Script - Inserted into vehicles and edited by the vehicle manufacturer to define vehicle information for use by modifications.

The NTBI Group does not maintain a list of compatible vehicles or modifications. GMLS-compatible products should clearly label themselves as such. The NTBI Group does not provide any warranty for third-party GMLS implementations.

Click here for the GMLS developer kit.

End-User Instructions

Refer to your vehicle's owner's guide for instructions on how to install GMLS-compatible equipment.

If the owner's guide does not provide instructions, the following is a general checklist for installing GMLS-compatible modifications:

  1. Ensure that the vehicle is turned off, including any lighting or other components that may change any attributes while installing the modification.
  2. Take a copy of your vehicle as-is. Modifications may cause damage or unlink prims accidentally. Save a copy now in case this happens!
  3. Rez the modification near your vehicle.
  4. Right click the modification and select "Edit".
  5. With the Edit window open, hold your SHIFT key and left click the vehicle. This should select both objects at once. Make sure you select the vehicle last.
  6. Press your CTRL + L keys, or click the "Link" button in the Edit window.
  7. If prompted, confirm that you want to link the two objects together.
  8. When linked, the modification should automatically position itself to the recommended position and resize if necessary.
  9. If prompted, grant link permissions. This may unlink some prims. Make sure to delete them after.
  10. If desired, you may usually move the equipment once linked.

If a modification does not use GMLS, is not compatible with your vehicle's GMLS system, or returns an error when linking using the above procedure, follow steps 1 through 6, then manually reposition the modification as needed.

Aftermarket Modification Manufacturer Instructions

Get the Alignment Tool and Calibration Tool from the GMLS developer kit.

Before continuing, make sure your mod is finished. Do not continue until you are sure you do not need to make any changes to your object.

  1. Make a two copies of your object. One will be used for calibration. The other will be distributed to your end-users.
  2. Place the "NTBI GMLS Alignment Tool" script in the distribution object (the one you will keep).
  3. Place the "NTBI GMLS Calibration Tool" script in the calibration object (the one you will link, then delete).

For each vehicle you want your object to be compatible with:

  1. Make a new copy of the calibration object. It should have the "NTBI GMLS Calibration Tool" script already in it.
  2. Rez the vehicle. Make sure it is the original size!
  3. Position the calibration object on the vehicle, exactly where you want it to be once installed by the end-user.
  4. Link the calibration object to the vehicle.
  5. Copy the script snippet line sent to local chat.
  6. Open the "NTBI GMLS Alignment Tool" script in the distribution object.
  7. Paste the script snippet line between the two marked lines at the top of the script. NOTE: The first part of each line is the GMLS ID of the vehicle you have calibrated to. If you see a line with the same GMLS ID, you have already calibrated to that vehicle, and only the first instance of that vehicle will be used.
  8. Save the "NTBI GMLS Alignment Tool" script.

Once finished, delete any calibration objects and vehicles.

If you want the root prim of the object to retain its physics type when linked to the vehicle, change root_no_physics to FALSE. (By default, the root prim of this object will be set to physics type "none" and the physics types of child prims will remain the same.)

If you want to have the GMLS script automatically unlink prims, list their names in the remove_prims list. If you do this, you can also change remove_move_dist to change the distance unlinked prims will move up, and you can change remove_recolor to FALSE if you do not want unlinked prims to be recolored bright red for visibility.

If you do not want the object to be set to temporary when unlinking prims in the remove_prims list so that they automatically delete themselves, change make_temp to FALSE.

When finished, make sure you test your modification on each compatible vehicle to make sure it works correctly.

API

The Alignment Tool and vehicle script send the following link messages that can be used to trigger additional scripts in your modification:

  • GMLS_REQUEST
    • Sent by Alignment Tool once linked. Vehicle responds with GMLS_ID if compatible. You can also send this manually once the GMLS script is finished if you need any information from GMLS_ID.
  • GMLS_ID
    • Key: [gmls_id]|[root scale]|[additional information]
    • Sent by vehicle in response to GMLS_REQUEST. Note that [root scale] is not the size of the root prim of the vehicle, but rather the ratio of the current size of the root to the original size of the root. For example, [root scale] on a vehicle that was upsized to twice its original size would be <2.0, 2.0, 2.0> regardless of its actual size.
  • GMLS_SUCCESS
    • Sent by Alignment Tool if the GMLS operation completed successfully and it is now safe to perform any configuration changes or whatever else on the newly linked-to vehicle.
  • GMLS_FAIL
    • Sent by Alignment Tool if the GMLS operation failed either because the object the modification was just linked to is not GMLS-compatible or the vehicle has a gmls_id that the modification was not calibrated for.
  • GMLS_CANCEL
    • Sent by Alignment Tool if the GMLS operation was cancelled by the user.

Vehicle Manufacturer Instructions

Get the Alignment Tool and Calibration Tool from the GMLS developer kit.

Before continuing, make sure your vehicle's root prim will not be resized before it is distributed. Do not continue until the root prim is finalized.

  1. Place the "NTBI GMLS Vehicle Sample Script" script in the vehicle. If you prefer, you can also integrate this script into another script in the vehicle to save memory.
  2. Edit the gmls_id string. You can use any string as long as it does not include the pipe ("|") character, but it should be limited to alphanumeric characters, underscores ("_"), and be up to 32 characters. The gmls_id must be unique for every vehicle that has a different layout of potential modification positions. For example, use different IDs for 2DR and 4DR variations of the same vehicle.
  3. Edit the gmls_default_root_size vector to be the size of the root prim of the vehicle. On most viewers, you can get this value by opening the Edit window, going to the Object tab, and pushing the "C" button next to Size. WARNING: This is not optional. Failure to set this value will cause GMLS modifications to align improperly.
  4. Save the "NTBI GMLS Vehicle Sample Script" script. If kept separate, you can limit the memory used by the script if you prefer.

Perform this procedure for each vehicle variation. Once finished, it is a good idea to test the GMLS settings by creating a simple object and following the Aftermarket Modification Manufacturer Instructions.

Changelog

Rev. 2

  • Added make_temp option.
  • Changed unlinking parts procedure so that unlinked prims are set to temporary if make_temp is enabled.

Rev. 1

  • Added GMLS_SUCCESS, GMLS_FAIL, and GMLS_CANCEL link messages.
  • Fixed erroring out and refusing to reposition if linked before permissions have been granted.
  • Fixed unlinking parts check running before checking if vehicle is compatible in the first place.
  • Fixed crosstalk when multiple GMLS modifications are rezzed at once.
  • Improved vehicle detection in slow regions by extending identification time from 2 seconds to 5 seconds.

Rev. 0

  • Initial public release.