Spyglass

Description

Adds a craftable and functional spyglass that doubles as a weapon. Use it to bash your enemies or to see their cowardly faces up close... but from a safe distance! The spyglass has 3 zoom levels that you can cycle through. Uses custom mesh, textures, and logic. Configurable and includes gamepad support.

The spyglass can be crafted and upgraded at a workbench.
Recipe is: 2x Obsidian, 2x Bronze, 1x Crystal.

Alternatively, you can spawn the item with the console command spawn AdvizeSpyglass.

Default Keybinds

Keyboard and Mouse:

Right Mouse Click will increase zoom level by 1.
Left Shift + Right Mouse Click will decrease zoom level by 1.
An optional keybind may be set to fully zoom out.

Gamepad:

Left Trigger/L2 will increase zoom level by 1.
Left Bumper/L1 + Left Trigger/L2 will decrease zoom level by 1.
When not zoomed, holding left bumper/L1 before pressing left trigger/L2 will allow you to block with the spyglass.

All configurable keybinds support keyboard combinations (e.g. Left Ctrl + F8).

Installing

Manual Install

Extract the Advize_Spyglass.dll file into your BepinEx/plugins folder. Directory structure should look like this:

BepInEx ->
    plugins ->
        Advize_Spyglass.dll

In multiplayer environments:

This mod uses a version handshake to ensure all other connected clients have the mod. Install the mod on the server (if dedicated) as well as on all connected clients.

Contact Author

You can reach me on NexusMods to provide bug reports or feedback https://www.nexusmods.com/valheim/mods/2620

For further mod or mod dev support, I can be found at the following Discord server:

Config and Other Info:

The mod is configurable. A config file will be generated after first loading the mod and can be found in BepInEx/config/advize.Spyglass.cfg

The config can be edited out of game with a text editor, or modified in game using the Configuration Manager mod.

Note: In multiplayer environments, configuration settings will sync between connected clients using ServerSync. Install the mod on the server (if dedicated) to ensure its configuration file remains authoritative.

Localization Support: A file named Advize_Spyglass.json will be generated in the config\Spyglass directory after the game is first launched while [General]EnableLocalization is set to true. In it you will find the ability to change the item name and description text. I will be improving upon this later.

Config

Default Config File:

Please see Nexus mod page for the default configuration.

Source

Github Repo: Advize_ValheimMods

Screenshots

Spyglass 3D Model

Spyglass Item Tooltip & Recipe

Zoom Level Comparison With Vignette Postprocessing Effect

Zoom Level Comparison Without Vignette Postprocessing Effect

No Zoom

1st Zoom Level

2nd Zoom Level

3rd Zoom Level

Config Options

3.1.0

• Added toggleable and configurable vignette post processing effect when zooming with the spyglass.
  • Includes 7 new related config options.

3.0.1

• Fixed bug preventing spyglass from zooming in multiplayer.

3.0.0

• Split Spyglass and Cartography Skill into two separate mods.
• Modernized code base.
• Improved mesh, textures, and logic of spyglass.
• Updated ServerSync to v1.17.
• Compiled against Valheim 0.217.31 & BepInEx 5.4.2202.

2.1.2

• Updated ServerSync to v1.13 for Valheim 0.211.11.

2.1.1

• Updated ServerSync to v1.11 for Valheim 0.211.7 crossplay support.
• Added localization support for skill name and skill description.
  • To see new strings in localization file, delete Advize_CartographySkill.json and allow it to regenerate.

2.1.0

• Adopted ServerSync in place of Authoritative Config.
• Changed [Controls] in config to be of type KeyboardShortcut instead of string.
  • It's recommended you delete and regenerate your config file.
• Compiled against BepInEx 5.4.17 and Valheim 0.206.5.

2.0.3

• Added more null reference error prevention.

2.0.2

• Corrected cartography skill icon.

2.0.1

• Added extra null reference error prevention.

2.0.0

• Updated for Hearth and Home.
• Removed SkillInjector dependency.
• Both cartography skill and spyglass item can now be enabled/disabled individually.
• Localization support added for spyglass name and description.

1.5.0

• Dropped MCE support in favor of AuthoritativeConfig.
• Embedded assets within .dll file.

1.4.0

• Changed skill hover description in skill window.
• Added MCE support for server admins.

1.3.7

• Consolidated Nexus and Thunderstore branches.

1.3.6

• Fixed README.

1.3.5

• Minor code cleanup.
• Added debug message.
• Packaged for Thunderstore.io release.

1.3.4

• Updated spyglass icon to match 3D model.
• Added fix for error when generating a fresh world.
• Changed debug messages to accommodate new code flow. Code refactoring.

1.3.3

• Fixed conflict with Valheim+ and potential conflicts with all other mods who adjust field of view.
  • From this day forward, when you are zooming in with the spyglass, YOU ZOOM IN WITH THE SPYGLASS.

1.3.2

• No more Better Archery conflicts, all spyglass zoom levels now work!
• Spyglass can be spawned via console using prefab name advize_item_spyglass.
• Fixed a fov calculation error.
• Added Nexus mod ID for update checks.
• Added debug messages for when debug messages are enabled.
• Console command 'cartxpsync' added for Map Sync Mod users.
• Other fixes.

1.3.1

• Correctly bumped mod version number.

1.3.0

• Replaced Spyglass model.
• Spyglass will no longer zoom in or out while the inventory is open.

1.2.0

• Added spyglass control options to mod config.
• Spyglass now renders during character select screen.

1.1.1

• Added spyglass related config settings.
  • Zoom distance and field of view reduction are now configurable.
  • Spyglass item can be disabled entirely.

1.1.0

• Added craftable Spyglass item with custom mesh, textures, and unique logic.

1.0.3

• Minor update. Final code cleanup before new (if any) features are added. No need to update if you have 1.0.2.

1.0.2

• Disabled debug messages by default, but added config setting to toggle.
  • This improves performance when traveling quickly or entering "exploremap" into the console.

1.0.1

• New icon.
• View radius will now decrease if skill level is lowered without having to reload world.
• Fortified logic to prevent unexpected behaviour.

1.0.0

• Created Mod.