EasyNavigation

v0.3.0·Updated 2024-01-12

Show a trail behind you to easily find your way back or to the exit in a factory!

About this mod Author’s original text

EasyNavigation

This mod was created to help with finding where you left off or where you entered in a factory!

Features

  • Enable or disable the permanent trail.
  • Clear the trail regardless of whether the permanent trail bool is enabled or disabled.
  • Customize how the trail looks and the functionality of it.\

Currently available colors: black, blue, clear, cyan, gray, green, grey, magenta, red, white, yellow (Type in a color in the appropriate field in the config file or LethalConfig. These colors are not case sensitive.)

  • Enable the trail to be used outside.

You can enable the permanent trail so it saves when you enter and exit the factory.

  • Disable the trail entirely.

Controls

These key binds can be changed in the configuration file or through LethalConfig.\

I - Clear the trail regardless of if the permanent trail bool is enabled or disabled.\

O - Enable or disable the permanent trail.\

P - Enable or disable the outside trail.

Planned Features

  • Add a trail with a random color to all the players in a server.

Information

I developed this mod in about 6 hours total. This is my first mod for a game, but I do have a lot of experience developing Unity games. I plan to clean the code up and add more features in the future.

Changelog

Version 0.3.0

  • Added the ability to show the trail outside the factory.
  • Added the ability to disable the trail entirely.

Version 0.2.3

  • Added "Version 0.2.2" to the Changelog section in the README file. (Sorry for the spam!)

Version 0.2.2

  • Added the "CHANGELOG" file back to the zip file.

Version 0.2.1

  • Added a "Changelog" section to the README file.

Version 0.2.0

  • Added a GUI at the top of the player's screen to show when the permanent trail bool is enabled or disabled for a breif moment when they press the key binding for it.
  • The console will no longer be spammed with "Object reference not set to an instance of an object" warnings (When the player leaves a server, there will be warnings that get spammed, though).
  • Added a trail duration, permanent trail and clear trail key bindings, trail width and trail color in a config file that is auto-generated when the game is launched with the mod for the first time or through LethalConfig.

Version 0.1.0

  • Initial upload.
  • Added the base functionality for the trail.
  • Added the ability to set the isPermanentTrail bool to true or false.
  • Added the ability to clear the trail while in the factory.

Install & use Install: BepInEx plugin

  1. The archive from playbuff is the mod itself — usually a BepInEx plugin (a .dll or a plugin folder once unzipped).
  2. Recommended: use a community mod manager (such as r2modman) — pick this game, import the mod, and the manager sets up BepInEx and its dependencies for you.
  3. Manual route: install the BepInEx loader in the game folder, then drop the unzipped .dll or plugin folder into BepInEx/plugins/.
  4. Launch the game — the BepInEx console logs every plugin it loads; seeing this mod in the log means it is installed.

Mods with listed dependencies need those installed too, or they will not load. Options are usually changed in-game or in the plugin's config file.

Dependencies

Install these first, or the mod will not work:

BepInEx-BepInExPack

File & checksum

Filename
EasyNavigation-0.3.0.zip
File size
96.8 KiB