index.js 22 KB

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