index.js 19 KB

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