index.js 21 KB

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