index.js 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529
  1. // FpsUtils revision 1.4.2 - Hugedong Edition
  2. // Credits to Xiphon, Saegusa & Bernkastel for code snippets and ideas
  3. //
  4. // Changes:
  5. // TC shows the buff (does not cause lag I hope)
  6. // All FPS modes now toggle !fps hit automatically
  7. var config = require('./config.json');
  8. const format = require('./format.js');
  9. const fs = require('fs');
  10. module.exports = function FpsUtils(dispatch) {
  11. let DEBUG = config.debug || false;
  12. let player,
  13. cid,
  14. model,
  15. pcid,
  16. clss;
  17. let locx = [];
  18. let locy = [];
  19. let state = 0,
  20. lastState = 0,
  21. hiddenPlayers = {},
  22. hiddenIndividual = {};
  23. let flags = {
  24. hide: {
  25. tanks: false,
  26. dps: false,
  27. healers: false,
  28. ranged: false
  29. },
  30. fireworks: false, //these options control the settings, true will enable them upon login, flase disabled. By default all are false except TC.
  31. hit: false,
  32. damage: false,
  33. hitother: false,
  34. logo: false,
  35. tc: true,
  36. tcwarrior: true
  37. };
  38. const classes = config.classes;
  39. function getClass(m) {
  40. return (m % 100);
  41. }
  42. function handleCommands(event) {
  43. let command = format.stripTags(event.message).split(' ');
  44. if (command[0] !== '!fps')
  45. return;
  46. lastState = state;
  47. if (command.length > 1) {
  48. let arg = command[1];
  49. switch (arg.toString()) {
  50. // Set state to 0: Disabled.
  51. case "0":
  52. state = 0;
  53. config.state = 0;
  54. log('fps-utils optimization disabled by client.');
  55. systemMsg('optimization disabled by user. [0]');
  56. if (lastState > 2) {
  57. // Display all hidden players.
  58. for (let pl in hiddenPlayers) {
  59. if (!hiddenIndividual[hiddenPlayers[pl].cid]) {
  60. dispatch.toClient('S_SPAWN_USER', 3, hiddenPlayers[pl]);
  61. }
  62. }
  63. }
  64. break;
  65. // Set state to 1: Only hide projectiles.
  66. case "1":
  67. state = 1;
  68. config.state = 1;
  69. flags.hitother = true;
  70. log('fps-utils optimization set to stage 1, disabling skill particles.');
  71. systemMsg('optimization set to remove skill particles. [1]');
  72. if (lastState > 2) {
  73. // Display all hidden players. EXCEPT HIDDEN INDIVIDUALS
  74. for (let pl in hiddenPlayers) {
  75. if (!hiddenIndividual[hiddenPlayers[pl].cid]) {
  76. dispatch.toClient('S_SPAWN_USER', 3, hiddenPlayers[pl]);
  77. }
  78. }
  79. }
  80. break;
  81. // Set state to 2: Hide all skill animations.
  82. case "2":
  83. state = 2;
  84. flags.hitother = true;
  85. config.state = 2;
  86. log('fps-utils optimization set to stage 2, disabling skill animations.');
  87. systemMsg('optimization set to remove skill animations and hit effects. [2]');
  88. // Spawn all players with disabled animations.
  89. if (lastState > 2) {
  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. // Set state to 3: Hide all other players.
  98. case "3":
  99. state = 3;
  100. flags.hitother = true;
  101. config.state = 3;
  102. log('fps-utils optimization set to stage 3, disabling other player models.');
  103. systemMsg('optimization set to remove other player models [3]');
  104. if (lastState < 3) {
  105. // Hide all players on screen and disable spawn.
  106. for (let pl in hiddenPlayers) {
  107. if (!hiddenIndividual[hiddenPlayers[pl].cid]) {
  108. dispatch.toClient('S_DESPAWN_USER', 2, {
  109. target: hiddenPlayers[pl].cid,
  110. type: 1
  111. });
  112. }
  113. }
  114. }
  115. break;
  116. // Save configuration to file.
  117. case "save":
  118. saveConfig();
  119. break;
  120. // Disable fireworks.
  121. case "fireworks":
  122. flags.fireworks = !flags.fireworks;
  123. log('fps-utils toggled fireworks: ' + flags.fireworks);
  124. systemMsg(`Fireworks toggled off: ${flags.fireworks}`);
  125. break;
  126. //disable players attack markers
  127. case "hitme":
  128. flags.hit = !flags.hit;
  129. log('fps-utils toggled users hit effects: ' + flags.hit);
  130. systemMsg(`User hit effects turned off: ${flags.hit}`);
  131. break;
  132. //as above so below
  133. case "hit":
  134. flags.hitother = !flags.hitother;
  135. log('fps-utils toggled hit effects on others: ' + flags.hitother);
  136. systemMsg(`Player hit effects on others turned off: ${flags.hitother}`);
  137. break;
  138. //as above so below
  139. case "damage":
  140. flags.damage = !flags.damage;
  141. log('fps-utils toggled player damage numbers: ' + flags.damage);
  142. systemMsg(`Player damage numbers toggled off: ${flags.damage}`);
  143. break;
  144. //disable guild logos
  145. case "logo":
  146. flags.logo = !flags.logo;
  147. log('fps-utils toggled guild logos: ' + flags.logo);
  148. systemMsg(`toggled guild logos off: ${flags.logo}`);
  149. break;
  150. //Hide TC abnormality spam
  151. case "tc":
  152. flags.tc = !flags.tc;
  153. log('fps-utils toggled showing traverse cut: ' + flags.tc);
  154. systemMsg(`toggled toggled showing traverse cut off: ${flags.tc}`);
  155. break;
  156. case "tcwarrior":
  157. flags.tcwarrior = !flags.tcwarrior;
  158. log('fps-utils toggled traverse cut warrior mode: ' + flags.tc);
  159. systemMsg(`toggled toggled traverse cut warrior mode: ${flags.tc}`);
  160. break;
  161. // Toggle individual classes on and off
  162. case "hide":
  163. if (command.length < 3) {
  164. log('fps-utils missing arguments for command "hide"');
  165. systemMsg(`missing arguments for command "hide" [dps, healers, tanks] or [username]`);
  166. break;
  167. } else {
  168. let arg2 = command[2];
  169. if (state < 3)
  170. switch (arg2.toString()) {
  171. // Hide all dps classes
  172. case "dps":
  173. log('fps-utils hiding dps classes');
  174. systemMsg(`hiding dps classes.`);
  175. flags.hide.dps = true;
  176. for (let pl in hiddenPlayers) {
  177. if ((!hiddenPlayers[pl].block || !hiddenIndividual[hiddenPlayers[pl].cid]) && classes.dps.indexOf(getClass(hiddenPlayers[pl].model)) > -1) {
  178. dispatch.toClient('S_DESPAWN_USER', 2, {
  179. target: hiddenPlayers[pl].cid,
  180. type: 1
  181. });
  182. }
  183. }
  184. break;
  185. // Hide all dps classes
  186. case "ranged":
  187. log('fps-utils hiding ranged classes');
  188. systemMsg(`hiding ranged classes.`);
  189. flags.hide.ranged = true;
  190. for (let pl in hiddenPlayers) {
  191. if ((!hiddenPlayers[pl].block || !hiddenIndividual[hiddenPlayers[pl].cid]) && classes.ranged.indexOf(getClass(hiddenPlayers[pl].model)) > -1) {
  192. dispatch.toClient('S_DESPAWN_USER', 2, {
  193. target: hiddenPlayers[pl].cid,
  194. type: 1
  195. });
  196. }
  197. }
  198. break;
  199. // Hide all healer classes
  200. case "healers":
  201. flags.hide.healers = true;
  202. for (let pl in hiddenPlayers) {
  203. if ((!hiddenPlayers[pl].block || !hiddenIndividual[hiddenPlayers[pl].cid]) && classes.healers.indexOf(getClass(hiddenPlayers[pl].model)) > -1) {
  204. dispatch.toClient('S_DESPAWN_USER', 2, {
  205. target: hiddenPlayers[pl].cid,
  206. type: 1
  207. });
  208. }
  209. }
  210. break;
  211. // Hide all tank classes
  212. case "tanks":
  213. flags.hide.tanks = true;
  214. for (let pl in hiddenPlayers) {
  215. if (!hiddenIndividual[hiddenPlayers[pl].cid] && classes.tanks.indexOf(getClass(hiddenPlayers[pl].model)) > -1) {
  216. dispatch.toClient('S_DESPAWN_USER', 2, {
  217. target: hiddenPlayers[pl].cid,
  218. type: 1
  219. });
  220. }
  221. }
  222. break;
  223. // Argument is an individual name or not recognized.
  224. default:
  225. for (let pl in hiddenPlayers) {
  226. if (hiddenPlayers[pl].name.toString().toLowerCase() === arg2.toString().toLowerCase()) {
  227. systemMsg(`player ${hiddenPlayers[pl].name} is added to the hiding list.`);
  228. hiddenIndividual[hiddenPlayers[pl].cid] = hiddenPlayers[pl];
  229. config.hiddenPeople.push(hiddenPlayers[pl].name.toString());
  230. dispatch.toClient('S_DESPAWN_USER', 2, {
  231. target: hiddenPlayers[pl].cid,
  232. type: 1
  233. });
  234. break;
  235. } else {
  236. continue;
  237. }
  238. }
  239. break;
  240. }
  241. }
  242. break;
  243. // Try to respawn all hidden players included in show command.
  244. case "show":
  245. if (command.length < 3) {
  246. log('fps-utils missing arguments for command "show"');
  247. systemMsg(`missing arguments for command "show" [dps, ranged, healers, tanks] or [username]`);
  248. break;
  249. } else {
  250. let arg2 = command[2];
  251. if (state < 3) {
  252. switch (arg2.toString()) {
  253. case "dps":
  254. case "healers":
  255. case "tanks":
  256. case "ranged":
  257. if (flags.hide[arg2.toString()]) {
  258. flags.hide[arg2.toString()] = false;
  259. log('fps-utils showing: ' + arg2);
  260. systemMsg(`showing ${arg2}`);
  261. for (let pl in hiddenPlayers) {
  262. if (classes[arg2.toString()].indexOf(getClass(hiddenPlayers[pl].model)) > -1) {
  263. if (!hiddenIndividual[hiddenPlayers[pl].cid])
  264. dispatch.toClient('S_SPAWN_USER', 3, hiddenPlayers[pl]);
  265. }
  266. }
  267. }
  268. break;
  269. default:
  270. // Individuals or unkown handler.
  271. for (let pl in hiddenIndividual) {
  272. if (arg2.toString().toLowerCase() === hiddenIndividual[pl].name.toString().toLowerCase()) {
  273. systemMsg(`showing player ${hiddenIndividual[pl].name}.`);
  274. config.hiddenPeople.splice(config.hiddenPeople.indexOf(hiddenPlayers[pl].name), 1);
  275. dispatch.toClient('S_SPAWN_USER', 3, hiddenIndividual[pl]);
  276. delete hiddenIndividual[pl];
  277. }
  278. }
  279. break;
  280. }
  281. }
  282. }
  283. break;
  284. // List the players in individuals list.
  285. case "list":
  286. let hiddenArray = [];
  287. for (let pl in hiddenIndividual) {
  288. hiddenArray.push(hiddenIndividual[pl].name);
  289. }
  290. systemMsg(`Manually hidden players: ${hiddenArray}`);
  291. break;
  292. // Command not recognized
  293. default:
  294. systemMsg('Command not recognized. use [!fps help] for a list of available commands');
  295. break;
  296. }
  297. return false;
  298. } else {
  299. return false;
  300. }
  301. }
  302. function log(msg) {
  303. if (DEBUG) console.log('[fps-utils] ' + msg);
  304. }
  305. function systemMsg(msg) {
  306. dispatch.toClient('S_CHAT', 1, {
  307. channel: 24,
  308. authorID: 0,
  309. unk1: 0,
  310. gm: 0,
  311. unk2: 0,
  312. authorName: '',
  313. message: ' (fps-utils) ' + msg
  314. });
  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, (event) => {
  373. if (event.source.equals(pcid) || event.owner.equals(pcid)) {
  374. if (flags.damage) {
  375. event.damage = '';
  376. return true;
  377. }
  378. if (flags.hit) {
  379. event.skill = '',
  380. event.type = '',
  381. event.type2 = '';
  382. return true;
  383. }
  384. }
  385. if (flags.hitother) {
  386. if (hiddenPlayers[event.source] || hiddenPlayers[event.owner]) {
  387. event.skill = '',
  388. event.type = '',
  389. event.type2 = '';
  390. return true;
  391. }
  392. }
  393. });
  394. dispatch.hook('S_SPAWN_USER', 5, (event) => {
  395. if (flags.logo) {
  396. event.guildEmblem = '';
  397. return true;
  398. }
  399. });
  400. dispatch.hook('S_GUILD_NAME', 1, (event) => {
  401. if (flags.logo) {
  402. event.guildEmblem = '';
  403. return true;
  404. }
  405. });
  406. dispatch.hook('S_ABNORMALITY_BEGIN', 2, (event) => {
  407. if (flags.tc) { //abnormality begin doesn't cause the lag I don't think so this might be safe to remove
  408. if (event.id === 101300 || event.id === 101200) {
  409. event.duration = 0;
  410. return true; // set to false if it does cause lag
  411. }
  412. }
  413. });
  414. dispatch.hook('S_PARTY_MEMBER_ABNORMAL_ADD', 3, (event) => {
  415. if ((event.id === 101300 || event.id === 101200) && flags.tc) { //this probably will cause lag so leave return false
  416. return false;
  417. }
  418. });
  419. dispatch.hook('S_ABNORMALITY_REFRESH', 1, (event) => {
  420. if (flags.tc) {
  421. if (event.id === 101300 || event.id === 101200) {
  422. return false;
  423. }
  424. }
  425. });
  426. dispatch.hook('S_USER_LOCATION', 1, (event) => {
  427. // Update locations of every player in case we need to spawn them.
  428. hiddenPlayers[event.target].x = event.x2;
  429. hiddenPlayers[event.target].y = event.y2;
  430. hiddenPlayers[event.target].z = event.z2;
  431. hiddenPlayers[event.target].w = event.w;
  432. if (state > 2 || hiddenIndividual[event.target]) {
  433. return false;
  434. }
  435. });
  436. dispatch.hook('S_ACTION_STAGE', 1, (event) => {
  437. // If state is higher than state1 remove all skill animations.
  438. if (state > 1 && (hiddenPlayers[event.source] || hiddenIndividual[event.source])) {
  439. return false;
  440. }
  441. 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])) {
  442. dispatch.toClient('S_USER_LOCATION', 1, {
  443. target: event.source,
  444. x1: locx[event.source],
  445. y1: locy[event.source],
  446. z1: event.z,
  447. w: event.w,
  448. unk2: 0,
  449. speed: 300,
  450. x2: event.x,
  451. y2: event.y,
  452. z2: event.z,
  453. type: 0,
  454. unk: 0
  455. });
  456. locx[event.source] = event.x;
  457. locy[event.source] = event.y;
  458. }
  459. });
  460. dispatch.hook('S_ACTION_END', 1, (event) => {
  461. // If we're removing skill animations we should ignore the end packet too.
  462. if (state > 1 && (hiddenPlayers[event.source] || hiddenIndividual[event.source]))
  463. return false;
  464. });
  465. dispatch.hook('S_START_USER_PROJECTILE', 1, (event) => {
  466. // State 1 and higher ignores particles and projectiles so we're ignoring this.
  467. if (state > 0 && (hiddenPlayers[event.source] || hiddenIndividual[event.source]))
  468. return false;
  469. });
  470. dispatch.hook('S_SPAWN_PROJECTILE', 1, (event) => {
  471. // Ignore the projectile spawn if enabled in state.
  472. if (state > 0 && (hiddenPlayers[event.source] || hiddenIndividual[event.source]))
  473. return false;
  474. });
  475. dispatch.hook('C_CHAT', 1, handleCommands);
  476. };