GTFOSpeedrunning-MedalsMod icon

MedalsMod

Makes speedrunning more accessible by giving players times to aim for.

Last updated 3 days ago
Total downloads 20
Total rating 1 
Categories Client Mods
Dependency string GTFOSpeedrunning-MedalsMod-1.0.1
Dependants 0 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack_GTFO-3.2.1 icon
BepInEx-BepInExPack_GTFO

BepInEx pack for GTFO. Preconfigured and includes Unity Base DLLs.

Preferred version: 3.2.1

README

CarryItemMarker

Overview

This mod adds target times for you to beat, with four different Medals to earn depending on your performance!
(Medal times are for Any% - Glitchless)

It does not change the game in any way besides adding UI.
The mod is currently not usable for runs submitted to SRC!

Make sure to check out the GTFO Speedrun.com board.
... and the rules section to precisely see what is needed for a valid submission if you're feeling like competing!
(THIS IS OPTIONAL!)

Medal Times

Medal times were set using the following design principles:

Icon Medal
Bronze Medal Bronze These times are easy to obtain and shouldn't pose much of a challenge, showing off the expected time for a clear without wasting time.
Silver Medal Silver These times require players to pick up the pace and to always be progressing towards the objective. Knowledge of the level is required.
Gold Medal Gold These times are very good, breaching into genuine speedrunning territory. They require a mix of good level knowledge and a higher pace.
Champion Medal Champion These times are an incredible achievement, often being in competition with record runs. They require knowledge of speedrunning, the level and a clean run.

Custom Medals Leaderboard

A custom website to compete in a more casual manner is planned for the future.

[!NOTE]
This is currently still in development and should be ready in the near future.
This will also be completely opt-in, no data is going to be sent by default!

How to set medal times if you have prior runs.

If you know you've completed levels in a set amount of time you can manually add them to the mod by editing a text file which contains your saved times.

The mod saves all your times in a file located at %appdata%\GTFOMedalsMod\medals.json. Beware this file and folder may not be created if you haven't yet completed a run with MedalsMod active which means you have to manually create it.

The file structure is a json and has this structure:

{
    "R1A1": "02:36.497",
    "R1B1": "03:18.145",
    "R1B2": "05:57.407"
}

To add times, simply add another entry with the level name and time as shown. The time is minutes:seconds.milliseconds. If you don't know milliseconds simply put 000 instead.

[!NOTE]
The level "Tutorial"/"Training" is saved as "T" so "T": "04:05.931" is correct

Credits:

Mod coding:

  • Auri
  • Tgb03

Medal times:

  • D4RKEVA
  • Frosty
  • RandomKenny
  • Rayalot
  • Tgb03
  • AngryMaid

Hints:

  • D4RKEVA
  • Frosty

Translations:

  • D4RKEVA: German
  • AngryMaid: Russian

(More/Remaining translations will be added soon™!)