From 196fd1ef11ccf48cc8dcdb5963a9e5a2460db95e Mon Sep 17 00:00:00 2001
From: tecel007 <tecel007@hotmail.com>
Date: Mon, 15 Mar 2021 13:08:27 +1100
Subject: [PATCH] Update README.md

---
 README.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 70 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1008d88..788100a 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,70 @@
-# Salty
\ No newline at end of file
+# Salty
+
+Salty is a protection only menu.  This is a different approach to modding GTAV - all of the protections are in C++.  
+
+## native logging
+
+Logger.cpp readsis a configurable logging system for GTAV natives.  It reads natives.hpp and produces natives_logging.hpp/cpp.   These natives are then hooked and logged at runtime.  It removescan be configured to log namespaces, remove spam/common massages and also ignore some debugging natives which cant be hooke as they crash.  Really useful to see what is happing in the scripts.
+
+## protections
+
+- model crashes... -> can be blocked in the databitbuffer or by scanning the netsyncobject
+- invalid owner
+- invalid object id
+- invaid object type - sending boat sync events to a car and also invalid object types on create
+- invaid acks to wrong player, wrong ower invalid object 
+- removing other players objects or player id's
+- protocol errors - messages depending on player objectss before object is created
+- sync/net event flooding
+- creating multiple objects with the same object id
+- sending sync events to objects you dont own
+- creating multiple objects in the same location
+- flooding "sync create events" with the sync_flag == 4? from memory
+- creating too many objects in your bubble_id
+- sync_buffer_read overflow AND underflow
+- invalid sync time
+- total random garbage in the datbitbuffer
+- exceptioncatch all handling on all hooks
+- bad datbitbuffer crash signatures
+- bad script events
+- flooding / bad net events
+
+## hooks used
+
+- functions::buffer_int_t m_buffer_int{};
+- functions::clone_pack_t m_clone_pack{};
+- functions::clone_create_t m_clone_create{};
+- functions::clone_sync_t m_clone_sync{};
+- functions::clone_remove_t m_clone_remove{};
+- functions::sync_read_t m_sync_read{};
+- functions::sync_can_apply_t m_sync_can_apply{};
+- functions::unregister_object_t m_unregister_object{};
+- functions::clone_create_ack_t m_clone_create_ack{};
+- functions::clone_sync_ack_t m_clone_sync_ack{};
+- functions::clone_remove_ack_t m_clone_remove_ack{};
+- functions::network_event_t m_network_event{};
+- functions::script_event_t m_script_event{};
+- functions::handle_event_t m_handle_event{};
+- functions::game_event_t m_game_event{};
+- functions::node_read_t m_node_read{};
+- functions::get_owner_t m_get_owner{};
+- functions::get_network_object_for_player_t m_get_network_object_for_player{};
+- functions::get_network_object_t m_get_network_object{};  
+- rage::CReplayInterface* m_replay{};
+
+## thanks to
+
+- MIKE#6623/imabignumber (discord)
+- Entrodor Wolfry#3502 (discord)
+- Pocakking (UC)
+- polivilas (UC)
+- Chrizzi (UC)
+- pelecanidae (UC)
+
+## derived from
+
+ - https://github.com/Sainan/GTA-V-Decompiled-Scripts
+ - https://github.com/Pocakking/BigBaseV2
+ - https://github.com/1337Nexo/BigBaseV2
+ - https://bitbucket.org/gir489/bigbasev2-fix/src/master/
+