ColorCycler

ColorCycler

Description

ColorCycler adds colorful cycling effects to your character in the game. From a full rainbow cycle to police sirens, strobes, and more - customize your character with eye-catching color patterns that will make you stand out from the crowd!

Features

• 🌈 Multiple Color Effects:
• Rainbow: Classic cycling through all colors
• Police Siren: Flash between red and blue
• Strobe: Rapid white flashing
• Matrix: Cycle between green shades
• Sunset: Warm orange, red, and yellow tones
• Ocean: Cool blue and purple tones
• Random: Jump between random colors
• Camouflage: Military-style green and brown patterns
• ⚙️ Configurable Settings: Customize the cycling speed and keybindings
• 🔄 Toggle On/Off: Easily enable or disable effects during gameplay
• 🔀 Mode Switching: Cycle through different effects with a keypress
• 🚀 Visual Notifications: Shows on-screen messages when toggling effects
• 📊 Default State Control: Choose your preferred startup settings
• 🧩 Mod Compatibility: Works seamlessly with CustomColors mod

Installation

Requirements

• BepInEx 5.4.x or later

Installation Steps

1. Make sure BepInEx is installed
2. Extract the mod archive into your BepInEx/plugins folder
3. Launch the game and enjoy your colorful character!

Configuration

After running the game once with the mod installed, a configuration file will be created at: BepInEx/config/Maflingus.ColorCycler.cfg

Available Settings:

• EnabledByDefault: Whether color effects are enabled when the game starts (true/false)
• DefaultEffectMode: The color effect mode that loads at startup
• ColorChangeDuration: Time in seconds between color changes (lower = faster effect)
• ToggleEffectKey: Key to toggle the effect on/off (default: R)
• CycleModeKey: Key to cycle through different effect modes (default: M)

Usage

• Press the toggle key (default: R) to turn effects on or off
• While effects are enabled, press the cycle key (default: M) to switch between different color modes
• A message will appear on screen showing the current mode or status
• Adjust the speed of the color cycling in the config file to customize your experience

Compatibility

This mod should be compatible with most other mods that don't directly modify the player's color. It works in both single-player and multiplayer (only affects your own character).

CustomColors Compatibility

ColorCycler now includes integration with the CustomColors mod. If both mods are installed, they will work together without conflicts.

Known Issues

• In rare cases when the game updates, the mod might need to be updated to maintain compatibility
• If you experience any issues, try increasing the ColorChangeDuration value in the config

Credits

• Created by Maflingus
• Thanks to 753 for helping me make this mod compatible with CustomColors
• Thanks to the BepInEx team for their amazing modding framework

Changelog

v1.2.4

• Added compatibility with CustomColors mod
• Fixed issue with chat input detection
• Various performance improvements and bug fixes

v1.2.0

• Added multiple color effect modes (Police Siren, Strobe, Matrix, etc.)
• Added key to cycle between different effects (M by default)
• Improved color selection logic for special effects

v1.1.1

• Added configurable settings for toggle key and cycling speed
• Added option to control whether effect is enabled by default
• Added on-screen notifications when toggling the effect

v1.0.0

• Initial release
• Added basic rainbow color cycling functionality

License

This mod is released under the MIT License. See LICENSE file for details.

Support

If you encounter any issues or have suggestions, please submit bug reports to @Maflingus on Discord.

Enjoy your colorful adventures! 🌈