[Release] vMenu v3.3.0-pre

vMenu v3.3.0 (Pre-Release)

Note this is an untested pre-release version, use at your own risk.

Note before updating

SQLite support has been dropped. This caused too many crashes and was completely incompatible with recent (Linux) FXServer artifacts.
The new ban system uses the default server side storage built in to FXServer. To migrate (copy) your old vmenu_bans.db or bans.json file, follow the following steps. If you don't have a vmenu_bans.db file, and only a bans.json file skip to step 2.

• Step 1. Upload your vmenu_bans.db file to here, and place the bans.json file you get here: /resources/vMenu/bans.json
• Step 2. Update to the latest version of vMenu, start the server and type vmenuserver migrate in the server console. This may take some time depending on the amount of bans you have stored. ONLY RUN THIS COMMAND ONCE, OTHERWISE YOUR BANS WILL BE DUPLICATED
• Step 3 Make sure the bans are imported by joining the server and checking the banned players menu. After that, delete the bans.json and vmenu_bans.db files, as you'll no longer need them.

Changes (summary)

• New bans system. The JSON and SQLite implementations have been removed.
• Fix death notifications & restore appearance on re-spawn bugs.
• Some WIP NUI features, not yet available.
• Some deploy config changes for AppVeyor.
• Missing 1868 (and some -not all- 2060) DLC vehicles added.
• Add support for game builds 1868 and 2060 by adding the new vehicle class and vehicle wheel type options.
• Fix vehicle wheel type list bug.
• Rework weather and time options, note that the convars (config options) for these features have been changed!
• Experimental feature: add support for addon weapon components, untested. This is a new section (weapon_components) in the addons.json file.
• Fixed a bug which caused some vehicle modifications to apply incorrectly when spawning a saved vehicle.
• Updated CFX dependencies.
• Update MenuAPI dependency.
• Merge a bugfix PR which adds additional checks before locking personal vehicles using the remote options.
• Merge a bugfix PR which addresses an overhead player names issue.

convar changes (permissions.cfg):

Removed options:

• vmenu_allow_random_blackout This feature has been removed.
• vmenu_smooth_time_transitions This feature has been removed.
• vmenu_bans_database_filepath All SQLite/bans.json options have been removed.
• vmenu_bans_use_database All SQLite/bans.json options have been removed.

Added options:

• vmenu_blackout_enabled This allows you to set the (default) state for blackout mode.
• vmenu_sync_to_machine_time Allows you to sync the time to the server's real system time (the custom in-game hour duration setting will be ignored if this is enabled and you won't be able to change the time manually).
• vmenu_weather_change_duration Allows you to configure how long weather changes take.

Changed/renamed options:

• vmenu_default_time_hour has been renamed to vmenu_current_hour
• vmenu_default_time_min has been renamed to vmenu_current_minute
• vmenu_default_weather has been renamed to vmenu_current_weather

Addons.json changes

A new section has been added for weapon_components in which you can add the names of addon (streamed) weapon components, note that this is untested. They will automatically be matched for compatible weapons and appear as components which you can toggle in the weapon options menu.

[Release] vMenu v3.2.1

vMenu version v3.2.1

Changes

• Added support for Benny's (1) and Benny's (2) vehicle wheel types. Apparently these were missing but luckily someone reported that 🎉
• Added a paint fade/enveff scale feature (which is also saved/re-applied for saved vehicles now)
• Updated MenuAPI version

Some WIP changes

Note, they don't do anything yet.

• Added a button to the misc settings menu which will be used in the future to be able to easily import/export saved data. (hopefully)

[Release] vMenu v3.2.0

vMenu version v3.2.0

Nothing major changed, just updated the dependencies and switched to fxmanifest.lua instead of __resource.lua.

And cleaned up some code.

And removed the feature where your ped would keep it's head gear on while in a vehicle, this apparently caused sync issues for other players whenever you got out of the vehicle.

[Release] vMenu v3.1.3

vMenu v3.1.3 (Small update)

Changes:

• Updated MenuAPI to v3.0.3. MenuAPI is added using NuGet instead of using a locally built version included in the Git repository. Should make updating MenuAPI for anyone that edits vMenu's source code a bit easier.
• Added Casino DLC vehicles.
• Updated the .csproj files to use the updated format, nobody likes ancient shit.
• AppVeyor is setup slightly different now, shouldn't really matter because I'm not planning on having many more builds but 🤷‍♂️
• Removed unused files.

Even though it shouldn't break, this release has not been tested on Linux servers. It has been tested and confirmed to be working fine on the latest artifacts for Windows servers.

[Release] vMenu v3.1.2

Final update vMenu v3.1.2

This will be the last update that I'll make for vMenu. (at least for the foreseeable future).

Changes:

• Removed the update checker.
• Merged 2 pull requests.
• Updated MenuAPI version & CFX API dependency versions.

[Release] vMenu v3.1.0

vMenu version v3.1.0.

Changelog:
v3.0.3...v3.1.0

[Release] vMenu v3.0.3

vMenu version v3.0.3

Permission changes

• vMenu.MiscSettings.TeleportToCoord Allows you to teleport to any coordinate you enter. (allowed by default)
• vMenu.MiscSettings.TeleportSaveLocation Allows you to save a new location to the "Teleport Locations" menu, which will also get saved to the locations.json file. (not allowed by default if you use the new permissions.cfg in this update, otherwise EVERYONE may be able to use this so be careful!)

Convar changes

• setr vmenu_default_ban_message_information "Please contact the staff team by going (support url) if you want to appeal this ban": This message gets added at the end of all ban messages, use this to show users where they can contact the server staff team in case they want to appeal it or if they have any questions.

Changelog

• Updated MenuAPI version.
• Fix invalid weapon name labels and add weapon description data (the latter is not used atm, but will be in the future)
• Add option to teleport to coordinates in the teleport options menu.
• Add option to save new teleport locations in-game.
• SQLite / banmanager fixes.
• Add option to disable the controller menu toggle key (in misc settings menu)
• Fix KVP cleanup.
• Add timecycle modifier saved settings. (Last used timecycle modifier settings will now be saved on reboot)
• Add default ban message + convar to change it.
• Add weather changed (client side) event that gets triggered when the weather changes.
• Add model name to saved vehicles spawn button.
• PR #165 by imckl: Use localized mod type names for the mod options in Vehicle Options mod menu.
• Add (currently unused) internal function to get a list of all vehicles.
• Fix potential text issue for tempbanning players (discussion about this issue can be found here)
• Try/Catch all SQLite code, to try and prevent fatal server crashes that randomly occur.
• Add finger pointing when pressing B or quickly double tapping the point control on controller (which is the right analog stick/look backwards key)
• Add body blemishes to the mp ped creator, apparently these were missing, nobody (afaik) reported this to me or if they did then they didn't reminded me about this.
• No longer toggle the mini-map radar size when the control for it is disabled (by another resource or mod).

[Release] vMenu v3.0.2

vMenu version v3.0.2.

Update to fix SQLite causing a fatal server crash on Linux servers.

There are no other changes in this version.

[Release] vMenu v3.0.1

vMenu v3.0.1 (pre-release)

Small update to address the missing "Save Ped" button in the player appearance menu.
This update also adds a feature that has been requested many times, which is database support for bans. However, don't get your "hopes" up, because of the following:

• This is implemented using SQLite, not your normal MySQL database used for many frameworks.
• This is not 100% tested, use at your own risk right now.
• You can only use the SQL DB, OR the bans.json at a time, you can not use both.

The SQLite database file will be automatically created if it doesn't exist. By default, this is in the same folder where your server.cfg file is located. You can change this using convars.

If you currently already have a list of banned players, make sure to switch the convar option to use the JSON file, then boot the server, and use the vmenuserver migrate command from the server console. After that switch the convar to use the SQLite db file and restart the server.

IMPORTANT

If you're running a linux server, update to the latest artifacts and then (temporarily) take the following files from this zip: CitizenFX.Core.Server.zip and place those in the following folder:

/alpine/opt/cfx-server/citizen/clr2/lib/mono/4.5/

If they're already there, then don't replace them, this is just if the latest version is missing those files.

New convars in this update

• vmenu_bans_database_filepath default: "" the file path for the database file. If you enter a custom filepath, then the filepath MUST end with a trailing /, for example:

  setr vmenu_bans_database_filepath "resources/vMenu/"

• vmenu_bans_use_database default: true enables or disables the SQLite database for storing banned players.

SQLite was not stress-tested, use at your own risk.

[Release] vMenu v3.0.0

vMenu v3.0.0 Changes

Notes before updating ⚠

• This update changes some file names and project dependencies, including:
  • MenuAPI.net.dll is now named MenuAPI.dll, please remove the old MenuAPI.net.dll file from your vMenu folder.
  • vMenuShared.net.dll is no longer used, you can remove this from the vMenu folder.
• Make sure to update to the new __resource.lua file when installing this update!

vMenu v3.0.0 changelog

Permission changes

• vMenu.OnlinePlayers.SeePrivateMessages This is not allowed for anyone by default, but if you really want it enabled then I suggest you only enable this for the server owner/head of your staff team. It allows you to see all PM's from everyone on the server. You can send a PM using the new option in the online players menu, and disable PM's (for yourself, so nobody can PM you and you can't PM anyone else) in the Misc Settings menu. Sending messages is allowed for everyone.
• vMenu.MiscSettings.OverheadNames Allows you to enable overhead playernames. Note this feature causes issues with other resources that manage this, so don't give this permission to users if you already have some other resource managing this.

Convar changes

• vmenu_smooth_time_transitions (default: true) Enables 'smooth' time transitions. If you advance time then the time will transition 'smoothly' up to the new time. If you reverse time by less than 2 hours difference, the time will jump straight to that past time. If you reverse time with MORE than 2 hours time difference then that will cause a smooth transition to the next day.
• vmenu_enable_animals_spawn_menu (default: false) Enables the Animals spawn options in the Player Appearance menu.
• vmenu_pvp_mode (default: 0) Sets the PVP mode, 0 = do nothing, 1 = enable pvp (friendly fire) for everyone, 2 = disable pvp (friendly fire) for everyone.
• vmenu_disable_server_info_convars (default: false) Disables the "vMenu Version" and "vMenu UUID" on the serverlist display.
• vmenu_player_names_distance (default: 500.0) Distance for playerblips to showup. This is using "game units" as measurement. It's unknown what this is in relation to meters or something similar, but 500.0 seems fine in most cases.
• vmenu_disable_entity_outlines_tool (default: false) Disables the entity model outlines, model hashes, entity handles development tools section.

All changes

• MenuAPI.net.dll has been renamed to MenuAPI.dll. This is now no longer in the client_scripts section of the __resource.lua, but instead in the files section.
• Add 'smooth' camera transitions in the MP Characters creation/editor menu. (See here for a 🎥 preview!: https://streamable.com/6hten)
• Add a config option to allow server owners to set a preferred distance for the player overhead names to be visible, min range is 100.0, default is 500.0
• Add a cooldown progress indicator to the weather options menu whenever the weather is currently changing.
• Add a PVP configuration option for server owners to 'do nothing, enable or disable' pvp.
• Add a rejoin session button to the connection options menu. If you leave the session, you can rejoin it using that button.
• Add expanded radar keybind options, enable this in the keybind options menu (misc settings) and press Z (input_multiplayer_info) or dpad_down to toggle the expanded minimap. This will automatically return to the normal map after 8 seconds, or press the toggle key again to collapse the radar manually.
• Add option to disable server info convars.
• Add overhead playernames option (in the Misc Settings menu).
• Add ped/vehicle/prop model dimensions drawing options.
• Add ped/vehicle/prop model entity handle drawing options.
• Add ped/vehicle/prop model hash drawing options.
• Add ped/vehicle/prop model outline 'global disabled' convar option to allow server owners to disable this if they feel it is not suited for their server.
• Add private message block/disable option to the Misc Settings menu.
• Add private message option to the Online Players menu.
• Add recording hotkeys to the keybinds menu options.
• Add smooth time transitions.
• Add timecycle modifiers options into the Misc Settings menu.
• Added 'tattoo' clothing badges/overlays option to the MP Character 'tattoos' section. (There's more than 700 of these overlays...)
• CFX: Because of the update to the nuget packages, the vMenuShared project is no longer used. Instead a new folder containing 2 classes is a shared folder for both the client and server project. This This means that the vMenuShared.net.dll is no longer used, you can remove this from the vMenu folder.
• Change the method used to disconnect yourself using the connection options menu, no longer requiring the player to be kicked from the server side.
• Completely rebuild the Player Appearance menu. Including: animals, male/female ped submenus, online player ped submenu, ability to filter/search for a specific ped, the "fake" names everyone wanted are finally 'added' 😒 and more.
• Completely refactor internal handling of tattoos data.
• Disable first person camera when currently using any animal ped, because that causes crashes (both game crashes and birds "crashing" into the ground because you can't fly when in first person).
• Disable the MP Character editor while inside a vehicle.
• Disable the vehicle headlights button when using a controller and toggling the helmet/visor (ped prop, using DPAD_RIGHT).
• Don't show the IP of a player in the "show player identifiers" (Online Players menu) option.
• Fix and improve internal functions related to helmet visor/gadget toggling, possible because of a new FiveM PR.
• Fix issue #152.
• Fix issue #154.
• Fix vehicle submenu not updating the first time it is opened after moving it to the new submenu section.
• Improve bans.json performance by disabling 'pretty/indented formatting' for when there's more than 100 players banned.
• Keep the menu open (and disable all controls) when the input field is active instead of hiding the menu.
• Main Menu: Moved (organized) a lot of options into new sub-sections, resulting in a much smaller, and easier to use main menu.
• Merged pull request #158 by attributeerror, this adds the key fob animations used in GTA:O's personal vehicle menu to the Personal Vehicle submenu in vMenu.
• Prevent quitting the session when you are the host. This would kick all other players and prevent any new players from joining.
• Removed unused internal functions, and cleaned up massively in general.
• Set vehicle model (spawn) names as the right side label for all vehicles in the vehicle spawner menu.
• Try/Catch decorator natives to fix crashes caused by some buggy client mods.
• Update client and server CFX API dependencies to the new official NuGet packages.
• Update MAPI version.
• Update the about vMenu section.
• Update the README.md file.
• Made sure to make the Menu snailsome :mascot: again, like I used to do in the early changelogs.