Browse Source

some updates

SaltyMonkey 6 years ago
parent
commit
f2e13ebf4e
5 changed files with 84 additions and 6 deletions
  1. 6 0
      README.md
  2. 2 2
      data/migrationData.js
  3. 73 0
      docs/presets.md
  4. 1 2
      docs/settings.md
  5. 2 2
      settings/settings.json

+ 6 - 0
README.md

@@ -75,5 +75,11 @@ Manual installation:
 Automatic installation:
 Automatic installation:
 - Open Tera Toolbox, open `Get More Mods` tab and install it as simple mod.
 - Open Tera Toolbox, open `Get More Mods` tab and install it as simple mod.
 
 
+## Usage
+
+By default FPS Manager contains presets 0/1/2 (smth similar with fps utils)
+
+For advanced usage look into `/docs` folder in mod folder
+
 ## Contributing
 ## Contributing
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

+ 2 - 2
data/migrationData.js

@@ -1,13 +1,13 @@
 "use strict";
 "use strict";
 
 
 const DefaultSettings = {
 const DefaultSettings = {
+	"interactive": false,
 	"registerCommands": true,
 	"registerCommands": true,
 	"customCommandsTag": "",
 	"customCommandsTag": "",
 	"registerUI": false,
 	"registerUI": false,
 	"registerFastAccessUI": false,
 	"registerFastAccessUI": false,
-	"interactive": false,
 	"debugMode": false,
 	"debugMode": false,
-	"classBasedPresets": false,
+	"classBasedPresets": true,
 	"enableEvents": false,
 	"enableEvents": false,
 	"trackPresetsChanges": false
 	"trackPresetsChanges": false
 };
 };

+ 73 - 0
docs/presets.md

@@ -99,3 +99,76 @@ Simplified example below: (WARNING: you can't place comments as below in real fi
 	...
 	...
 }
 }
 ```
 ```
+
+## mode structure
+
+Every `mode` `object` in `preset` contains options for fps manager.
+
+Detailed explanation for every option below:
+
+```JS
+{
+			"throttleSomePackets": false, //blocks some packets if server spams them and they all same
+			"blockCustomAppearanceChanges": false, //blocks custom appearance changes (as example marrow brooch)
+			"blockUselessPackets": false, //block some unused packets which still gets send to client
+			"blockAnnoyingScreenMessages": false, //block some spammy messages (as example guild quests)
+			"blockNpcsDeathAnimations": false, //block animated death 
+			"blockAchievementsInCombat": false, //block achievement packets while you in combat
+			"blockInventoryInCombat": false, //block inventory packets while you in combat
+			"blockShakeEffects": false, //block ALL shake effects 
+			"blockGatherNode": false, //block useless gather nodes 
+			"blockPetBaloons": false, //block pet messages 
+			"blockHits": {
+				"area": false, //block hits in area except you
+				"me": false //block own hits effects but keep them from another players
+			},
+			"blockBuffs": {
+				"area": false, //block all player buffs packets except your
+				"huntRewards": false, //block exp/gold buffs
+				"shapeChange": false, //block shape change buffs
+				"effects": false //block on screen effects 
+			},
+			"blockNumbersPopups": {
+				"hp": false, //block your hp change numbers
+				"mp": false, //block your mp numbers 
+				"damage": false //block damage numbers
+			},
+			"blockAdditionalSkillEffects": {
+				"own": false, //block your skills additional effects when possible
+				"players": false //block skills additional effects when possible from players near
+			},
+			"blockProjectiles": {
+				"players": false //block players projectiles effects
+			},
+			"blockDropItems": {
+				"all": false, //block ALL drop 
+				"templateId": [] //block desired drop by templateId
+			},
+			"blockServants": {
+				"area": false, //block servants from another players
+				"me": false //block own servants
+			},
+			"blockSummons": {
+				"me": false, //block own summons
+				"area": false //block  not your summons
+			},
+			"blockSkills": {
+				"class": [], //block skills based on class
+				"rawId": [], //block all skills with desired id
+				"extended": { 
+
+				}
+			},
+			"blockNpcs": {
+				"templateId": [], //block npc by template Is
+				"huntingZoneId": [] //block npc by hunting zone
+			},
+			"blockPlayers": {
+				"all": false, //block all players near
+				"keepParty": true, //keep party members from block
+				"class": [], //block by class
+				"name": [] //block by name
+			}
+		},
+		
+```

+ 1 - 2
docs/settings.md

@@ -10,5 +10,4 @@ Settings file path: `<modfolder>/settings/settings.json`. Can be opened with any
 | customCommandsTag  | String  | If not empty string adds additional custom tag for ingame commands   |
 | customCommandsTag  | String  | If not empty string adds additional custom tag for ingame commands   |
 | interactive        | Boolean | Enable/Disable additional ingame messages from mod   |
 | interactive        | Boolean | Enable/Disable additional ingame messages from mod   |
 | classBasedPresets  | Boolean | Enable/Disable per-class `presets` usage   |
 | classBasedPresets  | Boolean | Enable/Disable per-class `presets` usage   |
-| enableEvents       | Boolean | Enable/Disable ingame commands   |
-| enableEvents       | Boolean | Enable/Disable realtime class presets changes monitoring and reloading  |
+| enableEvents       | Boolean | Enable/Disable ingame commands   |

+ 2 - 2
settings/settings.json

@@ -1,11 +1,11 @@
 {
 {
+	"interactive": false,
 	"registerCommands": true,
 	"registerCommands": true,
 	"customCommandsTag": "",
 	"customCommandsTag": "",
 	"registerUI": false,
 	"registerUI": false,
 	"registerFastAccessUI": false,
 	"registerFastAccessUI": false,
-	"interactive": false,
 	"debugMode": false,
 	"debugMode": false,
-	"classBasedPresets": false,
+	"classBasedPresets": true,
 	"enableEvents": false,
 	"enableEvents": false,
 	"trackPresetsChanges": false
 	"trackPresetsChanges": false
 }
 }