Waypoints

Custom fast travel stops for ReSkate. Save spots on any map, mark them in the world, travel between them, and share them with friends.

Features

• Stops per map. Save a stop where you stand and it is remembered on that map. Each stop has a name, a spot type, an optional description and a credit.
• Spot types. Ledge, Hubba, Stair Set, Gap, Vert, Manual Pad, Rail or Other (the default). Filter this map's stops by type.
• Markers. A beam and a name with the distance at every nearby stop, with a color for your stops, shared stops and mod stops. Beam height, label size and marker distance are adjustable.
• Prompt. Standing at a stop shows its name, type, credit and description and reminds you of the travel key.
• Fast travel. A list of this map's stops, sorted by distance or name. Travel puts you a little above the saved spot so you do not clip the ground.
• Go back. One key returns you to where you travelled from.
• Bus stop mode. Optionally only allow travel while you stand at a stop, so your stops become a network.
• Other maps. Browse stops saved on other maps, grouped by the map's menu name. You can edit or delete your own there, but travelling needs you to load that map first.
• Sharing. Send this map's stops to everyone in a lobby or only to players you pick, for a set time or until you leave. Receivers can keep a stop permanently.
• Export and import. Save stops as .json files and load them back.
• Mod stops. Any mod can ship stops that show up automatically.
• Rebindable keys. Every action can be rebound or cleared.

Hotkeys

Rebind them under SETTINGS > Controls.

The keys work while you ride, not while a menu, the console or chat is open. Alt+F6 also works without menu focus, which is handy before filming or in replays. The game gives plugins no way to detect a replay, so hiding is manual.

The menu page

Everything lives under PLUGINS > Waypoints.

• STOPS: your stops on this map as a list, a Show dropdown to filter by type, an Add button, and the OTHER MAPS box below.
• SHARE: lobby sharing, export, import and the mod stops count.
• LOOK: markers, beam, names, prompt and colors.
• SETTINGS: bus stop mode, travel options, naming, notifications, Controls and a reset button.

Open a stop's Edit or Details button to rename it, change its type or description, or delete it. Delete asks twice.

Credit

New stops get your lobby name as the creator (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 the credit stays empty. It shows as the Source in a stop's details and travels with shared and exported stops.

Sharing

On the SHARE tab pick how long the stops last (until you leave, or 5, 15, 30 or 60 minutes), then share with everyone or turn off Everyone and tick the players who should get them. Shared stops show in their own color and disappear when they expire or the sender leaves, unless the receiver keeps them. Receivers can turn off "Accept stops from others". Everyone needs the plugin.

Export and import

• Export this map or Export everything writes a file to the plugin data folder as exports/waypoints-<map>-<your name>.json (or all instead of the map). Exporting again overwrites the same file.
• Open exports folder shows the files.
• Import from file reads one back. Duplicates (a stop within a metre of an existing one) are skipped.

Shipping stops in a mod

Put .json files in a waypoints/ folder beside your mod's manifest.json. The plugin picks them up and shows them as mod stops.

{
    "format": "reskate-waypoints",
    "v": 1,
    "points": [
        { "map": "<map id>", "name": "Plaza", "x": 12.5, "y": 3.0, "z": -40.2, "h": 1.57,
          "type": "Ledge", "desc": "Best ledge in town", "by": "siin" }
    ]
}

map is the map id, h is the facing in radians, type is one of the spot types (anything else becomes Other), and desc (up to 120 characters) and by (up to 24) are optional. Stops only show on the map they were saved on.

Why it asks for these permissions

ReSkate shows a plugin's permissions, so here is what each one is for. Nothing is used for anything else.

It does not use the network or the internet, does not read other mods' files beyond their waypoints/ stop files, and cannot change the game or other players.

Good to know

• Folder name. Saved stops and settings belong to the mod's folder name. Keep the folder called Waypoints, or export first if you rename it. Two copies of the folder (for example Waypoints and Waypoints_1) load as two plugins, so delete the extra one.
• Maps that need a start point. ReSkate cannot be told which start point to use, so the plugin does not load maps for you. Load the map from the game's menu first.
• Replays. Not detectable, use Alt+F6.

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.