CustomPosters

Replaces the vanilla posters in the ship with custom posters added by user.

Features

• Overrides the vanilla posters in the ship with your own images.
• Supports multiple poster pack mods at once.
• Supports multiple poster packs in a single mod.
• Supports most of the image formats and .mp4 video format.
• Ability to enable/disable packs and posters, change chances of the packs and posters, toggleable networking, change volume, max distance and aspect ratio of .mp4 posters via config file.
• Compatible with ShipWindows, 2 sToRy ShIp, BiggerShip, and WiderShipMod.
• Posters and video playback is synchronized with clients.
• PosterCropperTool allows to crop posters that are made for LethalPosters so they can be compatible with CustomPosters.
  • Sizes of the posters will be slightly incorrect after cropping!

Adding Custom Posters

Supported formats

• .png, .jpg, .jpeg, .bmp, .mp4.

Steps

1. Create a folder structure for your custom poster pack in the BepInEx/plugins directory as shown below.
2. Place your poster images in the posters and tips folders, ensuring filenames match exactly - Poster1.png, Poster2.mp4, Poster3.bmp, Poster4.jpeg, Poster5.png and CustomTips.jpg.

Single Pack Folder Structure:

Poster image names must match the structure below.

   BepInEx/
    ├── plugins/
    │   └──── YourPosterModName/
    │          └── CustomPosters/
    │                ├── posters/
    │                │    └── Poster1.png, Poster2.png, Poster3.png, Poster4.png, Poster5.png
    │                └── tips/
    │                     └── CustomTips.png
    └── ...

Mutliple Pack Folder Structure:

Poster image names must match the structure below.

   BepInEx/
    ├── plugins/
    │   └──── YourPosterModName/
    │          ├── PosterPack1/
    │          │     ├── posters/
    │          │     │    └── Poster1.png, Poster2.png, Poster3.png, Poster4.png, Poster5.png
    │          │     └── tips/
    │          │          └── CustomTips.png
    │          │
    │          └── PosterPack2/
    │                ├── posters/
    │                │    └── Poster1.png, Poster2.png, Poster3.png, Poster4.png, Poster5.png
    │                └── tips/
    │                     └── CustomTips.png
    └── ...

Recommended Poster Sizes [ In pixels ]

• Poster1 - 639 Width, 488 Height
• Poster2 - 730 Width, 490 Height
• Poster3 - 749 Width, 1054 Height
• Poster4 - 729 Width, 999 Height
• Poster5 - 552 Width, 769 Height
• CustomTips - 860 Width, 1219 Height

Configuration Options

• Enable Networking:
  • If true (default), posters are synced with all players. If false, the mod is client-side only, allowing to play vanilla lobby.
• Randomier mode:
  • PerPack (default): Selects one pack randomly for all posters.
  • PerPoster: Randomizes textures for each poster from all enabled packs.
• Keep Pack For:
  • Lobby (default): Randomized posters only when the lobby reloads.
  • Session: Randomized posters only when restarting the game.
  • SaveSlot: Randomized posters only when creating a new save slot.
• Vanilla model:
  • Both (default): Uses both Poster5 and Tips vanilla meshes.
  • Poster5: Uses only Poster5 vanilla mesh.
  • Tips: Uses only Tips vanilla mesh.
  • None: Uses none of the vanilla meshes and uses quads.
• Toggle Packs and Posters:
  • Each poster pack has an Enabled setting for poster pack and posters. Set to false to disable a pack or a poster.
• Global Chance:
  • Assign a Global Chance value (0–100) for each pack. If any pack has a Global Chance > 0, weighted random selection is used.
  • A Chance = 0 excludes the pack from selection, reverting to equal probability among enabled packs with non-zero chances.
• Per-Poster Chance:
  • For each poster in a pack, set a probability (0–100). If any poster has a Chance > 0, weighted selection applies.
  • Having 2 and more poster packs and one of the poster pack has (e.g. Poster2) Chance = 70 and second poster pack with same poster has Chance = 0 means that second poster pack poster is excluded from selection within that pack.
• Volume:
  • Configure volume of .mp4 posters.
• Max distance:
  • Configure maximum audio distance of .mp4 posters.
• Aspect ratio:
  • Choose aspect ratio of .mp4 posters [ Stretch 'X', FitInside, FitOutside, NoScaling ].
• TextureCaching:
  • Enabled: Stores textures in memory for faster access, reducing disk reads.
  • Disabled (Default): Loads textures from disk each time, which may slightly increase load times (based on image size).

FAQ

Q: Can I use multiple poster packs at the same time?

Yes! The mod supports multiple poster packs. You can configure poster packs in the config.

Q: Is this mod compatible with other ship mods?

Yes, the mod is compatible with ShipWindows, 2 sToRy ShIp, BiggerShip, and WiderShipMod. Poster positions are automatically adjusted based on the installed mods and configs.

Q: Can I use custom sizes for posters?

Yes, but for best results, use the recommended sizes listed in the Adding Custom Posters section.

Q: What happens if a poster fails to load?

If a specific poster file (like a .png or .mp4) can't be loaded, the mod will log an error in the game's console and that poster simply won't appear. In PerPack mode, if a file from the chosen pack fails, its spot will be empty. In PerPoster mode, the mod will just pick another working poster from the available pool.

Troubleshooting

My Posters Aren't Showing Up

1. Ensure your images are named correctly (e.g., Poster1.png, CustomTips.png).
2. Check the BepInEx/LogOutput.log file for errors related to texture loading.
3. Make sure the posters and tips folders are in the correct location as shown in Adding Custom Posters section.
4. Confirm images are in supported formats (.png, .jpg, .jpeg, .bmp, .mp4) and not corrupted.

Default Poster (Plane.001) is Still Visible

• This happens if the mod fails to load any custom poster pack. Check the config and make sure you have at least 1 poster pack enabled.

Not being able to join vanilla lobbies

• Mod uses networking that conflicts with vanilla lobbies. To join vanilla lobbies, disable the "Enable Networking" option in the configs.

Video poster .mp4 didn't load

• Mod doesn't support .mp4 videos that are 60 fps.

Credits

• Developed by seeya.
• Was inspired by LethalPosters mod.

License

Distributed under the GPL v3 License.

💖 Support

If you enjoy my work, consider supporting me. Donations are optional but greatly appreciated.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[4.0.2] - 2025-11-04 - "Bluh"

Added

• Added compatibility with 2StoryShip Legacy ship layout.

Changed

• Slightly improved Poster5 rotation when using 2StoryShip.

[4.0.1] - 2025-10-25 - "Bluh"

Fixed

• Fixed clients not having host selected posters (maybe?).

[4.0.0] - 2025-10-24 - "yuh"

Added

• Added vanilla meshes of Poster5 and Tips.
  • There's an option in the Settings section to use both of them, one of them or neither of them.
• Added keeping packs or posters per save slot in a new setting KeepPackFor.
• Added support for multiple poster packs within a single mod.
  • So, basically create multiple folders in your mod folder and place posters in them as shown in the README and they will count as poster packs.

Changed

• Replaced PerSession toggle option with KeepPackFor dropdown option to choose between Lobby, Session and SaveSlot.
• Poster positions and rotation of ShipWindows, TwoStoryShip, and WiderShipMod were improved to be closer to the vanilla.
• Reduced default volume of .mp4 posters from 20 to 10.
• Reduced default max distance of .mp4 posters from 4 to 3.5.

Fixed

• Fixed posters not randomizing with PerPoster mode.
• Fixed transparent image backgrounds being black.

[3.2.0] - 2025-10-15 - "Synchronization"

Added

• Added video playback synchronization. Hosts video playback time is synced with all clients.
• Added posters synchronization. Host now selects the active poster pack and syncs it across all clients.
• Added toggleable Networking option to config.
• Added LethalNetworkAPI as dependency.

[3.1.0] - 2025-10-12 - "Compatibility"

Added

• Added BiggerShip compatibility.

Fixed

• Fixed posters not being affected by games shaders.

[3.0.0] - 2025-10-11 - "The Overhaul"

Added

• Added .mp4 support.
  • Added a config option to enable or disable the audio of the poster mp4 [ default is false ]
  • Added a config option for each .mp4 poster to change the max volume distance of the video [ default is 4 ]
  • Added a config option for each .mp4 poster to change the aspect ratio of the video [ default is Stretch ]
  • Added a config option for each .mp4 poster to change the volume of the video [ default is false ]

Changed

• Replaced creating posters via code with AssetBundle.
• Config overhaul.
• Refactored and reorganized the entire codebase.

Fixed

• Fixed poster positions with 2StoryShipMod.
• Fixed poster packs disabled in a mod manager still showing up in the config.

[2.0.0] - 2025-06-09 - "Major update"

Added

• Added a setting to all posters in poster pack to disabled/enable them individually.
• Added a setting PerSession, which allows user to choose between randomizing posters on every lobby reload or on every game restart.
• Added Chance config options for PerPack and PerPosters randomization modes.
  • PerPack: if any pack has a Chance > 0, use weighted selection.
  • PerPoster: if poster has a Chance > 0, use weighted selection.
  • 0% chance means equal probability [ standard behavior ].
• Added support for .jpg, .jpeg, and .bmp.
• Added texture caching
  • Stores loaded textures in memory, reloading only when packs change. Clear cache on mod reload or game exit.

Changed

• Little more texture loading optimization.
• Improved configs.
• Improved and removed some logs.

Removed

• Removed ShipWindowsBeta compatibility as it was merged into the main ShipWindows mod.

Fixed

• Fixed vanilla posters not re-enabling if there were custom posters loaded.

[1.4.0] - 2025-05-13 - "Improvements"

Changed

• Improved compatibility with other mods.
• Changed recommended sizes in README.

[1.3.5] - 2025-02-18 - "Minor update"

Removed

• Removed 1 second delay before creating custom posters, as it was not fixing the intended issue.

[1.3.4] - 2025-02-18 "Compatibility"

Added

• Temporarily added ShipWindowsBeta compatibility.

[1.3.3] - 2025-02-15 "Optimization"

Changed

• Optimized custom poster creation, the game no longer freezes when loading posters.
• Removed unused code.

Fixed

• Fixed a texture memory leak.
• Added error handling for more robustness.

[1.3.2] - 2025- "Release"

Added

• Initial release!
• ShipWindows compatibility!
• WiderShipMod compatibility!
• 2 Story Ship compatibility!