You are viewing a potentially older version of this package. View all versions.
siin-Waypoints-1.0.0 icon

Waypoints

Custom fast travel stops for ReSkate, saved per map. Markers, a fast travel screen, rebindable keys, lobby sharing, JSON export and import, and stops shipped in other mods.

By siin
Date uploaded a day ago
Version 1.0.0
Download link siin-Waypoints-1.0.0.zip
Downloads 225
Dependency string siin-Waypoints-1.0.0

README

Waypoints

Custom fast travel stops for ReSkate, saved per map.

Requires ReSkate 2.1.2 with plugins enabled.

Hotkeys (rebind under Controls on the SETTINGS tab)

  • F6: open the fast travel screen (a list of stops on this map)
  • Shift+F6: save a stop where you stand
  • Ctrl+F6: go back to where you travelled from
  • Alt+F6: hide or show all markers and labels (handy before filming or in replays, the game gives plugins no way to detect a replay)

Keys work while you are riding, not while a menu, the console or chat is open.

The menu page

Everything lives in PLUGINS > Waypoints. Tabs: STOPS (your stops as a list, details, add, and stops on other maps), SHARE, LOOK, SETTINGS.

Settings

  • LOOK: marker beam, names, distance, prompt, beam height, label size and colours per source
  • SETTINGS: bus stop mode, arrival height, list sorting, default stop name, notifications, and Controls (press-a-key rebinding for each action, with reset and clear)
  • STOPS has an OTHER MAPS box below your stops: pick a map to see its stops. You can edit or delete your own stops there, but not travel to them (load the map first)

Sharing

  • Export your stops from PLUGINS > Waypoints > SHARE. Files land in the plugin data folder as exports/waypoints-<map>-<your name>.json (or all instead of the map), "Open exports folder" shows them.
  • Import a file with "Import from file".
  • In a lobby, "Share with the lobby" sends this map's stops to everyone running the plugin.
  • Ship stops inside any mod: put .json files in a waypoints/ folder beside the mod's manifest.json.

File format

{
    "format": "reskate-waypoints",
    "v": 1,
    "points": [
        { "map": "<map id>", "name": "Plaza", "x": 12.5, "y": 3.0, "z": -40.2, "h": 1.57 }
    ]
}

map is the map id (the maps are shown by their menu names in the plugin). h is the facing in radians. Stops only show on the map they were saved on.

Note on the folder name

Saved stops and settings belong to the mod folder name. Keep the folder called Waypoints to keep your data, or export first if you rename it.

Sharing for a while or with some players

On the SHARE tab pick how long the stops stay (until the sender leaves, or 5 minutes to 1 hour), then either share with everyone or turn off Everyone and tick the players who should get them. Stops you keep are permanent.

Description and credit

On the STOPS tab, your own stops have Edit description (up to 120 characters). The credit (your lobby name) is filled in automatically and shown as the Source. Both show on screen while you stand at the stop, travel along when you share or export, and mod packs can include them as desc and by in the JSON.

Credit

New stops get your lobby name as Made by (SETTINGS > NAMING, "Credit me on new stops"). The game only tells plugins your name while you are in a session, so the plugin remembers it from the last lobby you joined. Until then Made by stays empty.

Spot types

Every stop has a type: Ledge, Hubba, Stair Set, Gap, Vert, Manual Pad, Rail or Other (the default). Set it in a stop's details (Type dropdown). The STOPS tab has a Show dropdown (All by default) to filter this map's stops by type. The type appears in the list, on screen at the stop (unless it is Other), and travels with shared and exported stops ("type": "Ledge" in the file). Mods can ship it in their stop files the same way; anything unknown becomes Other.

CHANGELOG

Changelog

1.0.1

  • Rewrote the README: full feature list, hotkeys, menu tabs, sharing and export details, and a section explaining why each permission is needed.
  • Added this changelog.
  • New icon.

1.0.0

First release.

  • Save stops per map with a name, a spot type, a description and an automatic creator credit.
  • Spot types: Ledge, Hubba, Stair Set, Gap, Vert, Manual Pad, Rail, Other. Filter this map's stops by type.
  • Beam and name markers at nearby stops, with colors per source and adjustable beam height, label size and distance.
  • On-screen prompt when standing at a stop.
  • Fast travel list for the current map, sorted by distance or name, plus a go back key.
  • Bus stop mode: only travel while standing at a stop.
  • Other maps box on the STOPS tab, using the map names from the game menu. Edit or delete your own stops there.
  • Share stops with a whole lobby or chosen players, for a set time or until you leave.
  • Export and import stops as .json files, named by map and your name.
  • Mods can ship stops in a waypoints/ folder.
  • Rebindable hotkeys: F6 travel, Shift+F6 save, Ctrl+F6 go back, Alt+F6 hide markers.
  • Everything on the standard ReSkate menu page: STOPS, SHARE, LOOK, SETTINGS.