index.js 22 KB

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