Customisable reticles framework

Version v1.3.4

Changelog

v1.3.4
- seperated temporarily into two mod files
- reworked ui for hcog2/redline_sight/holo_r2
- added support for mozambique/wingman/wingman_elite/RE45
- added uv clamp to wingman/mastiff reticles to avoid it going oob
v1.3.3
- cleaned up rpaks due to issues with installation
v1.3.2
- fixed hcog_r1 windage [didn't source global_scalar properly]
- updated proto_viewmodel_test sight selection
- Improved hcog_r5 vmt file [general tidying up]
- added hcog_r5 to latest .blend build of `r201_full_compile.blend`
- added vmt templates for custom color ammo counters
- added Hcog x1 classic from R5 to the rpak list

Update info for mdlshitters:
new assets for ui added to emulate rpak assets, consider updating your models but it isn't necessary

Update for users:
This update shouldn't create any issues other than visual bugs for current models using crf :)

📲Contact info:

Discord id: Creamy#5877
NS Discord Server:
 For Crashes - Please refer #modding_chat and @ me, before creating a ticket for the support team
 For Skins   - Please refer to #skin_chat and make sure to @ me

ℹ️Info

This mod adds vmts/vtfs for customisable reticles as well as convars for modsettings to use.

All transformations to reticles can be done via console, all convars start with 'CRM.'

This mod reqiures a modder to implement vmts into their model, this mod does not work on vanilla weapons.

Avaible Reticle Styles

Avaible Windage Styles

In order to use presets you need to input ie 'exec crf_fov96', if your fov is not on a list fear not, just play around with one of the scopes and create your own custom scalar based on theese values then simply save the your .cfg file in [ns mod folder]/CustomReticlesFramework/mod/cfg

Table for all FOV/cl_fovscale values

Example cfg used for fov_scale "1.7"

CRM.hcog2_offset_scalar 0.875
CRM.acgs_offset_scalar 0.875 
CRM.aog_r1_offset_scalar 0.875 
CRM.aog_r2_offset_scalar 0.875
CRM.cro_offset_scalar 0.875
CRM.r201_front_offset_scalar  0.875
CRM.vinson_front_offset_scalar 0.875

How to check all offset presets using proto_viewmodel_test

To test all of the avaible sights you need to launch private match whith sv_cheats 1 enabled.

After you load into your map type in console give proto_viewmodel_test - this will show all avaible mods that can be equipped. Lastly equip the sight you'd like to preview.

list of avaible scopes:

give proto_viewmodel_test hcog
give proto_viewmodel_test redline_sight
give proto_viewmodel_test threat_scope
give proto_viewmodel_test holosight
give proto_viewmodel_test aog
give proto_viewmodel_test aog_r1
give proto_viewmodel_test cqh
give proto_viewmodel_test hcog_r1
give proto_viewmodel_test hcog_r5

To use this framework in your custom models download the .blend containing r201 with all base scopes or individual smd files from github link

⚠️Warning

Unfortunetely settings such as cl_fov_scale;viewmodel_fov;zoom_fov (or any other settings that modify your fov), will 100% break the default scaling, in order to adjust it use [...]offset_scalar convar to fit your preference or use one of the presets mentioned above :p

Some .qc files need additionall $attachments like aog_r1 which you can copy from here:

$attachment "AOG_R1_FRONT" "def_c_scope_aog_r1" 0 1.685 -1.55 rotate -90 -90 0
$attachment "AOG_R1_REAR" "def_c_scope_aog_r1" 0 1.685 -1.56 rotate -90 -90 0

This is just a preview that was set up for 1.6 fov_scale, which is slightly [fov_scale 1 = 70fov; fov_scale 1.55 = 110fov]

📑Features

8 styles of front reticles to choose from

ability to scale reticle

customisable base colour

reticle will be in sync with the crosshair/ center of the screen

RGB mode [can be assigned to toggle]

support for default colourblind modes [enabled by default]

⏬Installation

Install via thundersore/VTOL is preffered, but if you are installing this mod manually, install this skin as a MOD !!

📷 Gallery [all available types]

IRON SIGHTS

HCOG R2

ACGS SIGHT

HOLOSIGHT

THREAT SCOPE

AOG

AOG R1

CQH SIGHT

HCOG R1

Have fun <3

Deprecated changelogs

v0.0.2
- added proper aog_r1 correction
- changed acgs_sight windage to accomodate for sway correction
v1.0.1
- minor fixes
v1.0.0
- added global killswitch for reticle offset
- added option to prioritize custom color over colorblind setting
- changed how Holo_scale works - now it'll adjust offset_scalar automatically
- added presets for most common fov values [enable by typing ie 'exec crf_fov96']
v1.1.0
- readme.md updates
- added proto_viewmodel_test replacement for testing offsets
- added ui for r201/hemlok iron sights
- added cqh sight support
- added hcog_r1 support [titanfall 1 version]
v1.2.0
- fixed ammo_counter_meter (broke when put on multiple bodygroups)
- added aog_r1 to proto_viewmodel_test selection
- adjusted default color/style values for most of the scopes
- proto_viewmodel_test now supports all reticles/ammo_counters/field_emitters
- updated gallery
v1.3.1
- fixed typo in r97 reticle vmt
v1.3.0
- reorganised majority of materials
- Added option to customise windage [rear reticle] style
- Added option to resize windage [rear reticle] (by default size will be kept the same as reticle)
- Moved from individual scalars to a singular global one (First menu)
  [Automatic scaling will come soon™ w/ v1.4.0]
- added various options for ammo counters

V1.3.81

• CHANGELOG/README fixes

V1.3.8

• rpak materials update

V1.3.7

• fixed "test" crash

V1.3.6

• updated dependencies

V1.3.5

• updated to the current modsetting format (I did it as soon as it launched but I forgor... sry )

V1.3.4

• seperated temporarily into two mod files
• reworked ui for hcog2/redline_sight/holo_r2
• added support for mozambique/wingman/wingman_elite/RE45
• added uv clamp to wingman/mastiff reticles to avoid it going oob

V1.3.3

• cleaned up rpaks due to issues with installation

V1.3.2

• fixed hcog_r1 windage [didn't source global_scalar properly]
• updated proto_viewmodel_test sight selection
• Improved hcog_r5 vmt file [general tidying up]
• added hcog_r5 to latest .blend build of r201_full_compile.blend
• added vmt templates for custom color ammo counters
• added Hcog x1 classic from R5 to the rpak list

V1.3.1

• fixed typo in r97 reticle vmt

V1.3.0

• reorganised majority of materials
• Added option to customise windage [rear reticle] style
• Added option to resize windage [rear reticle] (by default size will be kept the same as reticle)
• Moved from individual scalars to a singular global one (First menu) [Automatic scaling will come soon™ w/ ### V1.4.0]
• added various options for ammo counters Update info for mdlshitters: temp update (file/name/scripting reorganization +more on the way), contact me if you plan on making new models ;)

V1.2.0

• fixed ammo_counter_meter (broke when put on multiple bodygroups)
• added aog_r1 to proto_viewmodel_test selection
• adjusted default color/style values for most of the scopes
• proto_viewmodel_test now supports all reticles/ammo_counters/field_emitters
• updated gallery

V1.1.0

• readme.md updates
• added proto_viewmodel_test replacement for testing offsets
• added ui for r201/hemlok iron sights
• added cqh sight support
• added hcog_r1 support [titanfall 1 version]

V1.0.1

• minor fixes

V1.0.0

• added global killswitch for reticle offset
• added option to prioritize custom color over colorblind setting
• changed how Holo_scale works - now it'll adjust offset_scalar automatically
• added presets for most common fov values [enable by typing ie 'exec crf_fov96']

v0.0.2

• added proper aog_r1 correction
• changed acgs_sight windage to accomodate for sway correction

TODO for ### V1.4

- Add support for NegativBuilt
- Add an option to force ptpov camera and force ads when option is highlighted(+user has the specific scope equipped)
- Add wrappers to minimize ammount of space in modsettings
- Add global color setting +colorblind options
- Replace 3 convar setup for colors to 2 convar (vector3 + multiplier)
- Replace 2 convar setup for scaling/offset scalar to vector2' and push values through vscript
- Add support for colorpickers
- Add automatic calibration based on lagrange' interpolation (no support for viewmodel_fov/zoom_fov_viewmodel) w/ a multiplier based on sway attachment
- Add Proper setup for sniper rifles (same setup as regular but reticle atlas will be x256 and windage x1024 to keep resolution krisp "enough")
- Update acgs sight to accomodate for new scanlines setup
- Replace current per weapon .blend setup with a global setup bound to 'ja_ads_attachment' bone
- Fix 'Oracle sight' lack of front vertices
- Add proper 2 texture setup for sniper rifles
- Update the base reticle atlas to feature ~20 reticles as opposed to 11
- Update/Reorganize atlases and mod.json to keep vanilla reticles in beginning of the .vtf
- Add new material proxies to recreate 'uiX_draw_cloaked' option used for rui