A gather.town teleporter extension which gives the possibility to users to use special commands in the console.
Some features may be deprecated with Gather town updates. c.f. https://gathertown.canny.io/changelog

Warning Note: With Chrome blocking the use of extensions using Manifest V2, the instructions below will not work. To still use the benefits of this extension use the instructions under the Install Errors section

Copy or clone the repo, then open chrome and go to chrome://extensions/ which will bring you to the extension manager page. Set your extensions as Developer mode, which can be enabled in the upper right corner. On the extension manager, go to the upper left corner to Load Unpacked, click on it, then select the repo on your local system. Toggle the extension on and you are ready to go.

If you encounter errors when installing, this may be due to Chromes migration away from Manifest V2. We currently have an issue open to migrate this extension to Manifest V3 (#24) but until then, please use the following workaround:

1. Copy the contents from teleport.js
2. On your Gathertown tab, open the dev-tools (F12)
3. Go to the console tool, in your browser's dev-tools
4. Paste the content you copied into the console tool and press Enter
5. You're good to go!

In the console the following functions are available to you:

Updates the video URL and the starting sync time for an object with the name "jukebox". If no URL is provided, then jukebox video URL will not be updated. If no playStartHours, playStartMinutes or playStartSeconds, then starting sync time will be updated to now.

/*
 * update jukebox song
 * requires object with jukebox (case-sensitive) as a name
 */
 changeSong(songURL, playStartHours, playStartMinutes, playStartSeconds)

Activates ghost mode until 'g' is pressed.

/**
 * activates ghost mode
 */
ghost()

/**
 * gives you a list of map that contains a certain object name
 * @param itemName: string: item name
 */
getMapsWithItemName("toilet")

/**
 * teleports n time around the map
 * @param n: number : number of time to teleport around the map
 * @param delay: number: (optional) number of ms between each teleport (defaults to 690)
 */
breakAnkles(n, delay)

Teleport to your desks position Note: must have set your desk's position beforehand using the setDesk() function.

/**
 * teleport to your desk's position
 */
desk()

/**
 * returns the current map id
 */
getMap()

/**
 * returns all the maps and their x and y dimensions
 */
 getMaps()

returns:

{
  "<mapId>": {
    id: "<mapId>",
    sizeX: <sizeX>,
    sizeY: <sizeY>,
  }
}

/**
 * Returns information about the current player
 */
getPlayer()

Returns:

{
  id: <player id>
  name: <player name>
  map: <player current map name>
  emojiStatus: <player's emojiStatus if applicable>
  x: <position X>
  y: <position Y>
}

/**
 * returns an array of players online
 */
 getPlayers()

returns:

[
  {
    id: <player id>
    name: <player name>
    map: <player current map name>
    emojiStatus: <player's emojiStatus if applicable>
    x: <position X>
    y: <position Y>
  }
]

/**
 * Make some one come to you.
 * Still needs to cancel the move of the player that is calling joinMe.
 * @param name: string: user's name
 */
 function joinMe(name)

Lists all the maps and their dimensions to the console

/**
 * Lists all the maps and their dimensions to the console
 */
getMaps()

Lists online players to the console

/**
 * Lists online players to the console
 */
listPlayers()

Get the current position

/**
 * Get the current poisition and map Id
 */
position()

Set your current position as your desks position. Note: you only need to set it once as it persists on local storage

/**
 * Set your current position as your desks position
 */
setDesk()

Displays a prompt showing you the available maps with a bathroom/toilet.

Displays another prompt asking you which toilet seat you will like to sit on.

Note: Bars must include custom object toilets with the name Toilet (case-sensitive). Available toilets must not have a player sitting on it.

/**
 * teleports you to a toilet of your choice
 */
shit()

Teleports you to a coordinate x,y on a map of your choice.

/**
 * teleports you to anywhere in gather
 * @param x {int}         : x position to teleport to on the space
 * @param y {int}         : y position to teleport to on the space
 * @param space {string}  : (optional) space to teleport to,
 *                          if omitted teleport to the desired coordinates in the current space
 */
teleport(x, y, space)

Note: You can only teleport yourself

Teleports you on top of a player of your choice.

/**
 * teleports you to an online player
 * @param name {string}         : the name or the id of the player you want to teleport to
 */
teleportToPlayer(name)

Note: The player must be online

Teleports you to the first spawn location on a map of your choice.

/**
 * teleports you to a map's spawn location
 * @param mapId {string}         : the id of the map you want to teleport to
 */
teleportToSpawn(mapId)

Note: The map ID must be valid

Displays a prompt showing you the available maps with a bar.

Displays another prompt asking you which seat at that bar you will like to sit on.

Note: Bars must include custom object seats with the name bar-stool (case-sensitive). Available bar seats must not have a player sitting on it.

/**
 * teleports you to the big bar at an available bar seat of your choice
 */
shot()

Teleports you to a random available do-not-disturb tile in the same room and activates ghost mode.

Note: Do not disturb zones must include custom objects with the name dnd-tile (case-sensitive). Available tiles must not have a player on it.

/**
 * teleports you to a random dnd tile.
 */
dnd()

Will find a specific player by name or id.

/**
 * Find a specific user
 */
findPlayer(filter)

Ring a user by its name.

/**
 * Ring a user
 */
ring(name)