Azumatt-VikingBanners icon

VikingBanners

VikingBanners is a mod that allows you to change the buildable banners texture. You can use URLs to set the banners, or if the server forces the URL it will use that one.

Last updated 8 months ago
Total downloads 5454
Total rating 3 
Categories Mods Tweaks Misc Server-side Client-side Utility Mistlands Update Hildir's Request Update Bog Witch Update
Dependency string Azumatt-VikingBanners-1.0.3
Dependants 36 other packages depend on this package

This mod requires the following mods to function

denikson-BepInExPack_Valheim-5.4.2202 icon
denikson-BepInExPack_Valheim

BepInEx pack for Valheim. Preconfigured and includes unstripped Unity DLLs.

Preferred version: 5.4.2202

README

VikingBanners

Compatible with OdinsBanners!

This mod was requested by SACK 3000#0939 and ALo#8803

VikingBanners is a mod that allows you to change the buildable banners texture. You can use URLs to set the banners, or if the server forces the URL it will use that one.

Version checks with itself. If installed on the server, it will kick clients who do not have it installed.

This mod uses ServerSync, if installed on the server and all clients, it will sync all configs with [Synced with Server] tags to client

This mod uses a file watcher. If the configuration file is not changed with BepInEx Configuration manager, but changed in the file directly on the server, upon file save, it will sync the changes to all clients.

Note: This mod can be installed client only, but will not sync the configuration between clients. Clients can still see other's banners this way. It's only needed on the server if you wish to enforce any of the configuration values that have [Synced with Server] tags.

Textures you can use to make your own banners to upload!

Please use the textures below to make your own banners, share the URL so others can use your designs! I will post them on the wiki page for this mod found here: https://valheim.thunderstore.io/package/Azumatt/VikingBanners/wiki/

The default banners in the game use the texture below:

OdinsBanners uses the texture below:

Configuration Options

General

Configuration File Name: Azumatt.VikingBanners.cfg

Lock Configuration [Synced with Server]

  • If on, the configuration is locked and can be changed by server admins only.
    • Default Value: On

Use Server Banner URL [Synced with Server]

  • A toggle that when turned on, sets all banners to use the Server Banner URL.
    • Default Value: On

Server Banner URL [Synced with Server]

  • Put a valid image URL here, this entry field should contain the URL of the image to use for the banners when the Use Server Banner URL toggle is on.

Edit Key [Not Synced with Server]

  • A keyboard shortcut that allows the player to interact with the banner to change the banner image
    • Default Value: Mouse1

Require Key Press [Synced with Server]

  • A toggle that when turned on, requires the player to hold down the Edit Key in order to interact with the banner to change the banner.
    • Default Value: On

Show URL On Hover [Synced with Server]

  • A toggle that when turned on, will show the URL after the interaction prompt so you might see the URL at quick glance. Note only will show to you if you have access to change the URL

    • Default Value: Off

    To interact with a banner and change its texture, look at the banner's pole and hold down the Edit Key (default: right mouse button). If Require Key Press is turned off, you can simply interact with the ship to change the banners via the prompt URL window. If Require Key Press is turned on, you must hold down the Edit Key and then interact.

    If Use Server Banner URL is turned on, the banners's texture will be updated with the URL set in the Server Banner URL field. If Use Server Banner URL is turned off, you can set the URL for the banners by interacting with the banner pole. This will open a text entry field where you can paste the URL for the image you want to use.

Installation Instructions

Manual Installation

Note: (Manual installation is likely how you have to do this on a server, make sure BepInEx is installed on the server correctly)

  1. Download the latest release of BepInEx.
  2. Extract the contents of the zip file to your game's root folder.
  3. Download the latest release of VikingBanners from Thunderstore.io.
  4. Extract the contents of the zip file to the BepInEx/plugins folder.
  5. Launch the game.

Installation through r2modman or Thunderstore Mod Manager

  1. Install r2modman or Thunderstore Mod Manager.

    For r2modman, you can also install it through the Thunderstore site.

    For Thunderstore Mod Manager, you can also install it through the Overwolf app store

  2. Open the Mod Manager and search for "VikingBanners" under the Online tab. Note: You can also search for "Azumatt" to find all my mods. The image below shows VikingShip as an example, but it was easier to resue the image. Type VikingBanners.

3. Click the Download button to install the mod. 4. Launch the game.

How To Translate This Mod

To add additional localizations to VikingBanners, your users can create a file with the name VikingBanners.Language.yml or VikingBanners.Language.json anywhere inside of the Bepinex folder. For example, to add a French translation to VikingBanners, a user could create a VikingBanners.French.yml file inside of the config folder and add French translations there.

The format of the file is as follows, this is the current English translation file embedded in the mod:

set_url: "Set URL"
banner_url: "Banner URL"
server_banner_url_deny: "Server is in control of the URL, denied"

Feel free to reach out to me on discord if you need manual download assistance.

Author Information

Azumatt

DISCORD: Azumatt#2625

STEAM: https://steamcommunity.com/id/azumatt/

For Questions or Comments, find me in the Odin Plus Team Discord or in mine:

https://i.imgur.com/XXP6HCU.png