Subscribe to download
Local Flags

Subscribing to this WILL not give you the mod. Instead you will get a mutator that does ♥♥♥♥♥♥♥♥♥. Please read the description in its entirety before requesting help on this mod. However, it would be appreciated if you subscribed AS that does boost popularity!

Imagine installing the Custom Flags Framework to add in your favorite flags only to find that nobody has created a flag pack that has your favorite flags! What to do? Well, usually you'd follow a guide to create your own flag pack, however that may seem daunting to non-modders as that requires learning the Unity Editor and learning how to use Ravenfield modding tools. Thus, here comes Local Flags!

Local Flags is a BepInEx mod on GitHub for Ravenfield that interacts with the Custom Flags Framework to allow users to add their own flags locally without needing to make their own flag packs with the Unity Editor. As such this removes the need for downloading or learning external tools like the Ravenfield modding tools or the Unity Editor.

• A proper release cannot be provided on the workshop because this is a BepInEx mod that would otherwise not exist due to the limitations of RS. Follow the below instructions to install this.

• Removes the need for learning the Unity Editor or Ravenfield modding tools. No modding experience needed!
  
• A much simpler process than creating your own flag packs. Adding custom flags is much faster with this.

• There is a longer load time depending on how many flags you have BUT it does not add as much load time assuming everything has been cached and is optimized. Loading times can be heavily improved if you optimize the flags with instructions in the FAQ. ~30 second load time with 1000+ flags at resolutions 1250x750 or lower.
  
• These cannot be published to the Steam workshop! You need to create a flag pack mutator with Ravenfield modding tools in order to publish your packs.

Before you begin installing this mod, I recommend optimizing your flags beforehand so that they are not the best quality in the world. You will not be seeing these textures up close and personal enough to warrant the extra quality. Especially do not have images with resolutions greater than 1500x1500! They will take a long time to load and generate colors for!

1. Install BepInEx 5[github.com] into Ravenfield.
   
2. Download the latest release for Local Flags[github.com].
   
3. Extract zip into "Ravenfield\BepInEx\plugins"
   
4. Open the newly extracted folder, open "Local" and drag any flag textures (jpg and png only) you want into the "CustomFlags" folder. If your images are not JPG/PNG, or they are not optimized, drop them in the "OptimizeFlags" folder instead. They will get optimized, converted to JPG and moved to "CustomFlags" automatically upon mod start.
   
5. Launch Ravenfield and enjoy your new flags! The first startup may take some additional time to load as colors have to be generated for your images which can take long if they are not optimized!

(Optional Steps)

1. If you want, you can add a cover inside of the "Local" folder. This will replace the default cover. Make sure your file is named "cover" and is a jpg or png file.
   
2. If you want to, you can create multiple local packs. Duplicate the "Local" folder and rename it. This name will be the name of the pack in game. You now have another pack that you can separate flags into and put a different cover for!

• If you already have a "LocalFlags" folder in your plugins folder, all you need to do is replace the dlls within the "LocalFlags" folder with the dlls from the new release. This effectively updates the mod.

• If you have a lot of flags this may happen. The mod freezes the game intentionally to let all the flags load first. The game will unfreeze once the flags have all loaded. If you want to confirm that the mod is loading the flags, open "Ravenfield\BepInEx\config\BepInEx.cfg" and enable the console at the category "Logging.Console". When you next load Ravenfield, a command prompt window will open that shows a bunch of text. After a few seconds or so, Local Flags will start logging progress of loading flags.
  
• If you just optimized your flag textures or had the mod generate colors for you, the game will for some reason freeze for a while depending on how much was done. This does not happen upon next game load. Don't ask me why it happens, I don't know.

• Try throwing your flags into the "OptimizeFlags" folder. The mod will compress your flags for you and downsize if your flags are terribly big. After it optimizes them, it automatically places them in "CustomFlags" (Make sure you have copies! This will remove the images within the folder as they are optimized). Optimizing will take some time depending on the resolution of the flag.
  
• If colors are not already provided for the flags in CustomFlagToTeamColors, the mod has to generate them which can take some time depending on the resolution of your flags. If this is taking forever, you should consider optimizing your flag textures as instructed in the above line!
  
• If you want to see the progress of the mod loading/generating the flags/colors, turn on the console as instructed in the FAQ question "My game is frozen upon load".

• If this mod is crashing your game or computer, chances are you are running out of memory. Check your Task Manager to confirm as Ravenfield is loading. Consider optimizing your flags or removing some. If you want the best memory efficiency, you should consider learning the Unity Editor and creating your flag packs with the official method

• No idea. I've attempted to keep compatibility with what I have used so they should work, but I have no way to test.

• amir16yp[github.com] for the Unity request texture downloader used to load flag textures