index.js 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482
  1. // FpsUtils revision 1.4 - Hugedong Edition
  2. // FpsUtils revision1.3 - Saegusa
  3. // Check readme for this versions updates, thank. +50 +50 +50 +50
  4. var config = require('./config.json');
  5. const format = require('./format.js');
  6. const fs = require('fs');
  7. module.exports = function FpsUtils(dispatch) {
  8. let DEBUG = config.debug || false;
  9. let player,
  10. cid,
  11. model,
  12. pcid,
  13. clss;
  14. let locx = [];
  15. let locy = [];
  16. let state = 0,
  17. hitsource = 0,
  18. lastState = 0,
  19. hiddenPlayers = {},
  20. hiddenIndividual = {};
  21. let flags = {
  22. hide: {
  23. tanks: false,
  24. healers: false,
  25. dps: false
  26. },
  27. fireworks: false, //these options control the settings, true will enable them upon login, flase disabled. By default all are false except TC.
  28. hit: false,
  29. damage: false,
  30. hitother: 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 "hitme":
  121. flags.hit = !flags.hit;
  122. log('fps-utils toggled users hit effects: ' + flags.hit);
  123. systemMsg(`User hit effects turned off: ${flags.hit}`);
  124. break;
  125. //as above so below
  126. case "hit":
  127. flags.hitother = !flags.hitother;
  128. log('fps-utils toggled hit effects on others: ' + flags.hitother);
  129. systemMsg(`Player hit effects on others turned off: ${flags.hitother}`);
  130. break;
  131. //as above so below
  132. case "damage":
  133. flags.damage = !flags.damage;
  134. log('fps-utils toggled player damage numbers: ' + flags.damage);
  135. systemMsg(`Player damage numbers toggled off: ${flags.damage}`);
  136. break;
  137. //disable guild logos
  138. case "logo":
  139. flags.logo = !flags.logo;
  140. log('fps-utils toggled guild logos: ' + flags.logo);
  141. systemMsg(`toggled guild logos off: ${flags.logo}`);
  142. break;
  143. case "tc":
  144. flags.tc = !flags.tc;
  145. log('fps-utils toggled showing traverse cut: ' + flags.tc);
  146. systemMsg(`toggled toggled showing traverse cut off: ${flags.tc}`);
  147. break;
  148. // Toggle individual classes on and off
  149. case "hide":
  150. if (command.length < 3) {
  151. log('fps-utils missing arguments for command "hide"');
  152. systemMsg(`missing arguments for command "hide" [dps, healers, tanks] or [username]`);
  153. break;
  154. } else {
  155. let arg2 = command[2];
  156. if (state < 3)
  157. switch (arg2.toString()) {
  158. // Hide all dps classes
  159. case "dps":
  160. log('fps-utils hiding dps classes');
  161. systemMsg(`hiding dps classes.`);
  162. flags.hide.dps = true;
  163. for (let pl in hiddenPlayers) {
  164. if ((!hiddenPlayers[pl].block || !hiddenIndividual[hiddenPlayers[pl].cid]) && classes.dps.indexOf(getClass(hiddenPlayers[pl].model)) > -1) {
  165. dispatch.toClient('S_DESPAWN_USER', 2, {
  166. target: hiddenPlayers[pl].cid,
  167. type: 1
  168. });
  169. }
  170. }
  171. break;
  172. // Hide all healer classes
  173. case "healers":
  174. flags.hide.healers = true;
  175. for (let pl in hiddenPlayers) {
  176. if ((!hiddenPlayers[pl].block || !hiddenIndividual[hiddenPlayers[pl].cid]) && classes.healers.indexOf(getClass(hiddenPlayers[pl].model)) > -1) {
  177. dispatch.toClient('S_DESPAWN_USER', 2, {
  178. target: hiddenPlayers[pl].cid,
  179. type: 1
  180. });
  181. }
  182. }
  183. break;
  184. // Hide all tank classes
  185. case "tanks":
  186. flags.hide.tanks = true;
  187. for (let pl in hiddenPlayers) {
  188. if (!hiddenIndividual[hiddenPlayers[pl].cid] && classes.tanks.indexOf(getClass(hiddenPlayers[pl].model)) > -1) {
  189. dispatch.toClient('S_DESPAWN_USER', 2, {
  190. target: hiddenPlayers[pl].cid,
  191. type: 1
  192. });
  193. }
  194. }
  195. break;
  196. // Argument is an individual name or not recognized.
  197. default:
  198. for (let pl in hiddenPlayers) {
  199. if (hiddenPlayers[pl].name.toString().toLowerCase() === arg2.toString().toLowerCase()) {
  200. systemMsg(`player ${hiddenPlayers[pl].name} is added to the hiding list.`);
  201. hiddenIndividual[hiddenPlayers[pl].cid] = hiddenPlayers[pl];
  202. config.hiddenPeople.push(hiddenPlayers[pl].name.toString());
  203. dispatch.toClient('S_DESPAWN_USER', 2, {
  204. target: hiddenPlayers[pl].cid,
  205. type: 1
  206. });
  207. break;
  208. } else {
  209. continue;
  210. }
  211. }
  212. break;
  213. }
  214. }
  215. break;
  216. // Try to respawn all hidden players included in show command.
  217. case "show":
  218. if (command.length < 3) {
  219. log('fps-utils missing arguments for command "show"');
  220. systemMsg(`missing arguments for command "show" [dps, healers, tanks] or [username]`);
  221. break;
  222. } else {
  223. let arg2 = command[2];
  224. if (state < 3) {
  225. switch (arg2.toString()) {
  226. case "dps":
  227. case "healers":
  228. case "tanks":
  229. if (flags.hide[arg2.toString()]) {
  230. flags.hide[arg2.toString()] = false;
  231. log('fps-utils showing: ' + arg2);
  232. systemMsg(`showing ${arg2}`);
  233. for (let pl in hiddenPlayers) {
  234. if (classes[arg2.toString()].indexOf(getClass(hiddenPlayers[pl].model)) > -1) {
  235. if (!hiddenIndividual[hiddenPlayers[pl].cid])
  236. dispatch.toClient('S_SPAWN_USER', 3, hiddenPlayers[pl]);
  237. }
  238. }
  239. }
  240. break;
  241. default:
  242. // Individuals or unkown handler.
  243. for (let pl in hiddenIndividual) {
  244. if (arg2.toString().toLowerCase() === hiddenIndividual[pl].name.toString().toLowerCase()) {
  245. systemMsg(`showing player ${hiddenIndividual[pl].name}.`);
  246. config.hiddenPeople.splice(config.hiddenPeople.indexOf(hiddenPlayers[pl].name), 1);
  247. dispatch.toClient('S_SPAWN_USER', 3, hiddenIndividual[pl]);
  248. delete hiddenIndividual[pl];
  249. }
  250. }
  251. break;
  252. }
  253. }
  254. }
  255. break;
  256. // List the players in individuals list.
  257. case "list":
  258. let hiddenArray = [];
  259. for (let pl in hiddenIndividual) {
  260. hiddenArray.push(hiddenIndividual[pl].name);
  261. }
  262. systemMsg(`Manually hidden players: ${hiddenArray}`);
  263. break;
  264. // Command not recognized
  265. default:
  266. systemMsg('Command not recognized. use [!fps help] for a list of available commands');
  267. break;
  268. }
  269. return false;
  270. } else {
  271. return false;
  272. }
  273. }
  274. function log(msg) {
  275. if (DEBUG) console.log('[fps-utils] ' + msg);
  276. }
  277. function systemMsg(msg) {
  278. dispatch.toClient('S_CHAT', 1, {
  279. channel: 24,
  280. authorID: 0,
  281. unk1: 0,
  282. gm: 0,
  283. unk2: 0,
  284. authorName: '',
  285. message: ' (fps-utils) ' + msg
  286. });
  287. }
  288. function saveConfig() {
  289. fs.writeFile('./config.json', config, 'utf8', (err) => {
  290. if (!err) log("config file overwritten successfully");
  291. });
  292. }
  293. dispatch.hook('S_LOGIN', 2, (event) => {
  294. pcid = event.cid;
  295. ({cid, model} = 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, (event) => {
  337. if (event.source.equals(pcid) || event.owner.equals(pcid)) {
  338. if (flags.damage) {
  339. event.damage = '';
  340. return true;
  341. }
  342. if (flags.hit) {
  343. event.skill = '',
  344. event.type = '',
  345. event.type2 = '';
  346. return true;
  347. }
  348. }
  349. if (flags.hitother) {
  350. if (!event.source.equals(pcid) || (!event.owner.equals(pcid) && event.owner > 0) || !event.target.equals(pcid)) {
  351. event.skill = '',
  352. event.type = '',
  353. event.type2 = '';
  354. return true;
  355. }
  356. }
  357. });
  358. dispatch.hook('S_SPAWN_USER', 5, (event) => {
  359. if (flags.logo) {
  360. event.guildEmblem = '';
  361. return true;
  362. }
  363. });
  364. dispatch.hook('S_GUILD_NAME', 1, (event) => {
  365. if (flags.logo) {
  366. event.guildEmblem = '';
  367. return true;
  368. }
  369. });
  370. dispatch.hook('S_ABNORMALITY_BEGIN', 2, (event) => {
  371. if (flags.tc) {
  372. if (event.id === 101300 || event.id === 101200)
  373. return false;
  374. }
  375. });
  376. dispatch.hook('S_PARTY_MEMBER_ABNORMAL_ADD', 3, (event) => {
  377. if (flags.tc) {
  378. if (event.id === 101300 || event.id === 101200)
  379. return false;
  380. }
  381. });
  382. dispatch.hook('S_USER_LOCATION', 1, (event) => {
  383. // Update locations of every player in case we need to spawn them.
  384. hiddenPlayers[event.target].x = event.x2;
  385. hiddenPlayers[event.target].y = event.y2;
  386. hiddenPlayers[event.target].z = event.z2;
  387. hiddenPlayers[event.target].w = event.w;
  388. if (state > 2 || hiddenIndividual[event.target]) {
  389. return false;
  390. }
  391. });
  392. dispatch.hook('S_ACTION_STAGE', 1, (event) => {
  393. // If state is higher than state1 remove all skill animations.
  394. if (state > 1 && (hiddenPlayers[event.source] || hiddenIndividual[event.source])) {
  395. return false;
  396. }
  397. 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])){
  398. dispatch.toClient('S_USER_LOCATION', 1, {
  399. target: event.source,
  400. x1: locx[event.source],
  401. y1: locy[event.source],
  402. z1: event.z,
  403. w: event.w,
  404. unk2: 0,
  405. speed: 300,
  406. x2: event.x,
  407. y2: event.y,
  408. z2: event.z,
  409. type: 0,
  410. unk: 0
  411. });
  412. locx[event.source] = event.x;
  413. locy[event.source] = event.y;
  414. }
  415. });
  416. dispatch.hook('S_ACTION_END', 1, (event) => {
  417. // If we're removing skill animations we should ignore the end packet too.
  418. if (state > 1 && (hiddenPlayers[event.source] || hiddenIndividual[event.source]))
  419. return false;
  420. });
  421. dispatch.hook('S_START_USER_PROJECTILE', 1, (event) => {
  422. // State 1 and higher ignores particles and projectiles so we're ignoring this.
  423. if (state > 0 && (hiddenPlayers[event.source] || hiddenIndividual[event.source]))
  424. return false;
  425. });
  426. dispatch.hook('S_SPAWN_PROJECTILE', 1, (event) => {
  427. // Ignore the projectile spawn if enabled in state.
  428. if (state > 0 && (hiddenPlayers[event.source] || hiddenIndividual[event.source]))
  429. return false;
  430. });
  431. dispatch.hook('C_CHAT', 1, handleCommands);
  432. };