index.js 19 KB

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