index.js 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536
  1. // FpsUtils revision 1.5 - Hugedong Edition
  2. // Credits to Xiphon, Saegusa & Bernkastel for code and ideas
  3. //
  4. // Changes:
  5. // Moved to Command
  6. // Added all classes to fps hide and show
  7. // Made commands more user friendly (imo)
  8. // TC buff has a limited mode that reduces spam while still retaining duration, default is it updating every 7 hits
  9. const Command = require('command');
  10. const fs = require('fs');
  11. var config = require('./config.json');
  12. module.exports = function FpsUtils(dispatch) {
  13. let DEBUG = false;
  14. let player,
  15. cid,
  16. model,
  17. pcid,
  18. clss,
  19. tchits = 7, //change this to fine tune TC spamage
  20. counter = 0,
  21. dur,
  22. locx = [],
  23. locy = [],
  24. state = 0,
  25. lastState = 0,
  26. hiddenPlayers = {},
  27. hiddenIndividual = {};
  28. let flags = {
  29. hide: {
  30. tanks: false,
  31. dps: false,
  32. healers: false,
  33. ranged: false,
  34. warrior: false,
  35. lancer: false,
  36. slayer: false,
  37. berserker: false,
  38. sorcerer: false,
  39. archer: false,
  40. priest: false,
  41. reaper: false,
  42. gunner: false,
  43. ninja: false,
  44. valkyrie: false
  45. },
  46. fireworks: false, //these options control the settings, true will enable them upon login, flase disabled. By default all are false except TC.
  47. hitme: false,
  48. damage: false, //damage numbers
  49. hit: false, //hit
  50. logo: false,
  51. tcremove: false, //
  52. tc: true, // Shows refreshes at a reduced rate (once every 7 hits by default)
  53. tcp: true //party abnormality refresh spam
  54. };
  55. const command = Command(dispatch);
  56. const classes = config.classes;
  57. function getClass(m) {
  58. return (m % 100);
  59. }
  60. command.add('fps', (setting, value) => {
  61. switch (setting) {
  62. // Set state to 0: Disabled.
  63. case "0":
  64. state = 0;
  65. config.state = 0;
  66. log('fps-utils optimization disabled by client.');
  67. command.message('optimization disabled by user. [0]');
  68. if (lastState > 2) {
  69. // Display all hidden players.
  70. for (let pl in hiddenPlayers) {
  71. if (!hiddenIndividual[hiddenPlayers[pl].cid]) {
  72. dispatch.toClient('S_SPAWN_USER', 3, hiddenPlayers[pl]);
  73. }
  74. }
  75. }
  76. break;
  77. // Set state to 1: Only hide projectiles.
  78. case "1":
  79. state = 1;
  80. config.state = 1;
  81. flags.hit = true;
  82. log('fps-utils optimization set to stage 1, disabling skill particles.');
  83. command.message('optimization set to remove skill particles. [1]');
  84. if (lastState > 2) {
  85. // Display all hidden players. EXCEPT HIDDEN INDIVIDUALS
  86. for (let pl in hiddenPlayers) {
  87. if (!hiddenIndividual[hiddenPlayers[pl].cid]) {
  88. dispatch.toClient('S_SPAWN_USER', 3, hiddenPlayers[pl]);
  89. }
  90. }
  91. }
  92. break;
  93. // Set state to 2: Hide all skill animations.
  94. case "2":
  95. state = 2;
  96. flags.hit = true;
  97. config.state = 2;
  98. log('fps-utils optimization set to stage 2, disabling skill animations.');
  99. command.message('optimization set to remove skill animations and hit effects. [2]');
  100. // Spawn all players with disabled animations.
  101. if (lastState > 2) {
  102. for (let pl in hiddenPlayers) {
  103. if (!hiddenIndividual[hiddenPlayers[pl].cid]) {
  104. dispatch.toClient('S_SPAWN_USER', 3, hiddenPlayers[pl]);
  105. }
  106. }
  107. }
  108. break;
  109. // Set state to 3: Hide all other players.
  110. case "3":
  111. state = 3;
  112. flags.hit = true;
  113. config.state = 3;
  114. log('fps-utils optimization set to stage 3, disabling other player models.');
  115. command.message('optimization set to remove other player models [3]');
  116. if (lastState < 3) {
  117. // Hide all players on screen and disable spawn.
  118. for (let pl in hiddenPlayers) {
  119. if (!hiddenIndividual[hiddenPlayers[pl].cid]) {
  120. dispatch.toClient('S_DESPAWN_USER', 2, {
  121. target: hiddenPlayers[pl].cid,
  122. type: 1
  123. });
  124. }
  125. }
  126. }
  127. break;
  128. // Save configuration to file.
  129. case "save":
  130. saveConfig();
  131. break;
  132. // Disable fireworks.
  133. case "fireworks":
  134. flags.fireworks = !flags.fireworks;
  135. log('fps-utils toggled fireworks: ' + flags.fireworks);
  136. command.message(`Fireworks toggled off: ${flags.fireworks}`);
  137. break;
  138. //disable players attack markers
  139. case "hit":
  140. if (value === null || value === undefined || value === "") {
  141. command.message(`Missing command arguments, "fps hit [on, me, damage]"`);
  142. break
  143. } else {
  144. switch (value) {
  145. case "me":
  146. flags.hitme = !flags.hitme;
  147. log('fps-utils toggled users hit effects: ' + flags.hit);
  148. command.message(`User hit effects turned off: ${flags.hit}`);
  149. break;
  150. case "on":
  151. flags.hit = !flags.hit;
  152. log('fps-utils toggled hit effects on others: ' + flags.hit);
  153. command.message(`Player hit effects on others turned off: ${flags.hit}`);
  154. break;
  155. case "damage":
  156. flags.damage = !flags.damage;
  157. log('fps-utils toggled player damage numbers: ' + flags.damage);
  158. command.message(`Player damage numbers toggled off: ${flags.damage}`);
  159. break;
  160. }
  161. }
  162. break;
  163. //disable guild logos
  164. case "logo":
  165. flags.logo = !flags.logo;
  166. log('fps-utils toggled guild logos: ' + flags.logo);
  167. command.message(`toggled guild logos off: ${flags.logo}`);
  168. break;
  169. //Hide TC abnormality spam
  170. case "tc":
  171. if (value === null || value === undefined || value === "") {
  172. command.message(`Missing command arguments, "fps tc [remove,party,on]"`);
  173. break
  174. } else {
  175. switch (value) {
  176. case "remove":
  177. flags.tcremove = !flags.tcremove;
  178. command.message('TC buff will not refresh:' + flags.tcremove);
  179. log('fps-utils toggled showing TC refreshes: ' + flags.tcremove);
  180. break;
  181. case "party":
  182. command.message('TC buff will not be shown on party members:' + flags.tcp);
  183. log('fps-utils toggled showing TC refreshes: ' + flags.tcp);
  184. break;
  185. case "on":
  186. flags.tc = !flags.tc;
  187. log('Smart TC fix enabled ' + flags.tc);
  188. command.message(`toggled toggled smart TC fix: ${flags.tc}`);
  189. break;
  190. }
  191. }
  192. break;
  193. // Toggle individual classes on and off
  194. case "hide":
  195. if (value === null || value === undefined || value === "") {
  196. //console.log('fps-utils missing arguments for command "hide"');
  197. command.message(`missing arguments for command "hide" [dps, healers, tanks], [username] or [class]`);
  198. break;
  199. } else {
  200. if (state < 3)
  201. switch (value) {
  202. case "tanks":
  203. case "dps":
  204. case "healers":
  205. case "ranged":
  206. case "lancer":
  207. case "slayer":
  208. case "berserker":
  209. case "sorcerer":
  210. case "archer":
  211. case "priest":
  212. case "mystic":
  213. case "reaper":
  214. case "gunner":
  215. case "ninja":
  216. case "valkyrie":
  217. flags.hide[value] = true;
  218. command.message(`All ${value}'s hidden`);
  219. for (let pl in hiddenPlayers) {
  220. if (!hiddenIndividual[hiddenPlayers[pl].cid] && (classes[value].indexOf(getClass(hiddenPlayers[pl].model)) > -1)) {
  221. dispatch.toClient('S_DESPAWN_USER', 2, {
  222. target: hiddenPlayers[pl].cid,
  223. type: 1
  224. });
  225. }
  226. }
  227. break
  228. // Argument is an individual name or not recognized.
  229. default:
  230. for (let pl in hiddenPlayers) {
  231. if (hiddenPlayers[pl].name.toString().toLowerCase() === value) {
  232. command.message(`player ${hiddenPlayers[pl].name} is added to the hiding list.`);
  233. hiddenIndividual[hiddenPlayers[pl].cid] = hiddenPlayers[pl];
  234. config.hiddenPeople.push(hiddenPlayers[pl].name.toString());
  235. dispatch.toClient('S_DESPAWN_USER', 2, {
  236. target: hiddenPlayers[pl].cid,
  237. type: 1
  238. });
  239. break;
  240. }
  241. }
  242. break;
  243. }
  244. }
  245. break;
  246. // Try to respawn all hidden players included in show command.
  247. case "show":
  248. if (value === null || value === undefined || value === "") {
  249. log('fps-utils missing arguments for command "show"');
  250. command.message(`missing arguments for command "show" [dps, ranged, healers, tanks] or [username]`);
  251. break;
  252. } else {
  253. if (state < 3) {
  254. switch (value) {
  255. case "dps":
  256. case "healers":
  257. case "tanks":
  258. case "ranged":
  259. case "warrior":
  260. case "lancer":
  261. case "slayer":
  262. case "berserker":
  263. case "sorcerer":
  264. case "archer":
  265. case "priest":
  266. case "mystic":
  267. case "reaper":
  268. case "gunner":
  269. case "ninja":
  270. case "valkyrie":
  271. if (flags.hide[value]) {
  272. flags.hide[value] = false;
  273. log('fps-utils showing: ' + value);
  274. command.message(`showing ${value}`);
  275. for (let pl in hiddenPlayers) {
  276. if (classes[value].indexOf(getClass(hiddenPlayers[pl].model)) > -1) {
  277. if (!hiddenIndividual[hiddenPlayers[pl].cid])
  278. dispatch.toClient('S_SPAWN_USER', 3, hiddenPlayers[pl]);
  279. }
  280. }
  281. }
  282. break;
  283. default:
  284. // Individuals or unkown handler.
  285. for (let pl in hiddenIndividual) {
  286. if (value === hiddenIndividual[pl].name.toString().toLowerCase()) {
  287. command.message(`showing player ${hiddenIndividual[pl].name}.`);
  288. config.hiddenPeople.splice(config.hiddenPeople.indexOf(hiddenPlayers[pl].name), 1);
  289. dispatch.toClient('S_SPAWN_USER', 3, hiddenIndividual[pl]);
  290. delete hiddenIndividual[pl];
  291. }
  292. }
  293. break;
  294. }
  295. }
  296. }
  297. break;
  298. // List the players in individuals list.
  299. case "list":
  300. let hiddenArray = [];
  301. for (let pl in hiddenIndividual) {
  302. hiddenArray.push(hiddenIndividual[pl].name);
  303. }
  304. command.message(`Manually hidden players: ${hiddenArray}`);
  305. break;
  306. // Command not recognized
  307. default:
  308. command.message('Command not recognized. use [!fps help] for a list of available commands');
  309. break;
  310. }
  311. return false;
  312. });
  313. function log(msg) {
  314. if (DEBUG) console.log('[fps-utils] ' + msg);
  315. }
  316. function saveConfig() {
  317. fs.writeFile('./config.json', config, 'utf8', (err) => {
  318. if (!err) log("config file overwritten successfully");
  319. });
  320. }
  321. dispatch.hook('S_LOGIN', 2, (event) => {
  322. pcid = event.cid;
  323. ({
  324. cid,
  325. model
  326. } = event);
  327. player = event.name;
  328. clss = getClass(event.model);
  329. job = (event.model - 10101) % 100;
  330. state = config.state || 0;
  331. });
  332. dispatch.hook('S_LOAD_TOPO', 1, (event) => {
  333. // Refresh the hide list upon teleport or zone change.
  334. hiddenPlayers = {};
  335. });
  336. dispatch.hook('S_SPAWN_USER', 3, (event) => {
  337. // Add players in proximity of user to possible hide list.
  338. hiddenPlayers[event.cid] = event;
  339. // Check the state or if the individual is hidden.
  340. if (state === 3 || hiddenIndividual[event.cid]) {
  341. return false;
  342. }
  343. // Hide dps enabled, remove dps characters;
  344. if (flags.hide.dps && classes.dps.indexOf(getClass(event.model)) > -1) {
  345. return false;
  346. }
  347. //hide ranged enabled, delet ranged characters;
  348. if (flags.hide.ranged && classes.ranged.indexOf(getClass(event.model)) > -1) {
  349. return false;
  350. }
  351. // Hide tanks enabled, remove tank characters;
  352. if (flags.hide.tanks && classes.tanks.indexOf(getClass(event.model)) > -1) {
  353. return false;
  354. }
  355. // Why would you want this on, seriously...
  356. if (flags.hide.healers && classes.healers.indexOf(getClass(event.model)) > -1) {
  357. return false;
  358. }
  359. });
  360. dispatch.hook('S_DESPAWN_USER', 2, (event) => {
  361. delete hiddenPlayers[event.target];
  362. if (state === 3 || hiddenIndividual[event.target]) {
  363. return false;
  364. }
  365. });
  366. dispatch.hook('S_SPAWN_NPC', 3, (event) => {
  367. if (flags.fireworks) {
  368. if (event.huntingZoneId === 1023 && (event.templateId === 60016000 || event.templateId === 80037000))
  369. return false;
  370. }
  371. });
  372. dispatch.hook('S_EACH_SKILL_RESULT', 3, {
  373. order: 999
  374. }, (event) => {
  375. if (event.source.equals(pcid) || event.owner.equals(pcid)) {
  376. if (flags.damage) {
  377. event.damage = '';
  378. return true;
  379. }
  380. if (flags.hitme) {
  381. event.skill = '',
  382. event.type = '',
  383. event.type2 = '';
  384. return true;
  385. }
  386. }
  387. if (flags.hit) {
  388. if (hiddenPlayers[event.source] || hiddenPlayers[event.owner]) {
  389. event.skill = '',
  390. event.type = '',
  391. event.type2 = '';
  392. return true;
  393. }
  394. }
  395. });
  396. dispatch.hook('S_SPAWN_USER', 5, (event) => {
  397. if (flags.logo) {
  398. event.guildEmblem = '';
  399. return true;
  400. }
  401. });
  402. dispatch.hook('S_GUILD_NAME', 1, (event) => {
  403. if (flags.logo) {
  404. event.guildEmblem = '';
  405. return true;
  406. }
  407. });
  408. dispatch.hook('S_ABNORMALITY_BEGIN', 2, {
  409. order: 999
  410. }, (event) => {
  411. if (flags.tc) { //abnormality begin doesn't cause the lag but whatevs
  412. if (event.id === 101300) {
  413. event.duration = 0;
  414. return true;
  415. }
  416. }
  417. });
  418. dispatch.hook('S_PARTY_MEMBER_ABNORMAL_ADD', 3, {
  419. order: 999
  420. }, (event) => {
  421. if (event.id === 101300 && flags.tcp) {
  422. return false;
  423. }
  424. });
  425. dispatch.hook('S_ABNORMALITY_REFRESH', 1, {
  426. order: 999
  427. }, (event) => {
  428. if (event.id === 101300 && flags.tc) {
  429. dur = event.duration;
  430. counter = counter + 1;
  431. if (counter >= tchits) {
  432. counter = 0;
  433. event.duration = dur;
  434. return true;
  435. } else {
  436. return false;
  437. }
  438. }
  439. if (event.id === 101300 && flags.tcremove) {
  440. return false;
  441. }
  442. });
  443. dispatch.hook('S_USER_LOCATION', 1, (event) => {
  444. // Update locations of every player in case we need to spawn them.
  445. hiddenPlayers[event.target].x = event.x2;
  446. hiddenPlayers[event.target].y = event.y2;
  447. hiddenPlayers[event.target].z = event.z2;
  448. hiddenPlayers[event.target].w = event.w;
  449. if (state > 2 || hiddenIndividual[event.target]) {
  450. return false;
  451. }
  452. });
  453. dispatch.hook('S_ACTION_STAGE', 1, (event) => {
  454. // If state is higher than state1 remove all skill animations.
  455. if (state > 1 && (hiddenPlayers[event.source] || hiddenIndividual[event.source])) {
  456. return false;
  457. }
  458. if (state === 2 && (((event.x - locx[event.source]) > 25 || (locx[event.source] - event.x) > 25) || ((event.y - locy[event.source]) > 25 || (locy[event.source] - event.y) > 25)) && (hiddenPlayers[event.source] || hiddenIndividual[event.source])) {
  459. dispatch.toClient('S_USER_LOCATION', 1, {
  460. target: event.source,
  461. x1: locx[event.source],
  462. y1: locy[event.source],
  463. z1: event.z,
  464. w: event.w,
  465. unk2: 0,
  466. speed: 300,
  467. x2: event.x,
  468. y2: event.y,
  469. z2: event.z,
  470. type: 0,
  471. unk: 0
  472. });
  473. locx[event.source] = event.x;
  474. locy[event.source] = event.y;
  475. }
  476. });
  477. dispatch.hook('S_ACTION_END', 1, (event) => {
  478. // If we're removing skill animations we should ignore the end packet too.
  479. if (state > 1 && (hiddenPlayers[event.source] || hiddenIndividual[event.source]))
  480. return false;
  481. });
  482. dispatch.hook('S_START_USER_PROJECTILE', 1, (event) => {
  483. // State 1 and higher ignores particles and projectiles so we're ignoring this.
  484. if (state > 0 && (hiddenPlayers[event.source] || hiddenIndividual[event.source]))
  485. return false;
  486. });
  487. dispatch.hook('S_SPAWN_PROJECTILE', 1, (event) => {
  488. // Ignore the projectile spawn if enabled in state.
  489. if (state > 0 && (hiddenPlayers[event.source] || hiddenIndividual[event.source]))
  490. return false;
  491. });
  492. };