index.js 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382
  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.
  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. clss;
  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
  29. };
  30. const classes = config.classes;
  31. function getClass(m) {
  32. return (m % 100);
  33. }
  34. function handleCommands(event) {
  35. let command = format.stripTags(event.message).split(' ');
  36. if(command[0] !== '!fps')
  37. return;
  38. lastState = state;
  39. if(command.length > 1) {
  40. let arg = command[1];
  41. switch(arg.toString()) {
  42. // Set state to 0: Disabled.
  43. case "0":
  44. state = 0;
  45. config.state = 0;
  46. log('fps-utils optimization disabled by client.');
  47. systemMsg('optimization disabled by user. [0]');
  48. if(lastState > 2) {
  49. // Display all hidden players.
  50. for(let pl in hiddenPlayers) {
  51. if(!hiddenIndividual[hiddenPlayers[pl].cid]) {
  52. dispatch.toClient('S_SPAWN_USER', 3, hiddenPlayers[pl]);
  53. }
  54. }
  55. }
  56. break;
  57. // Set state to 1: Only hide projectiles.
  58. case "1":
  59. state = 1;
  60. config.state = 1;
  61. log('fps-utils optimization set to stage 1, disabling skill particles.');
  62. systemMsg('optimization set to remove skill particles. [1]');
  63. if(lastState > 2) {
  64. // Display all hidden players. EXCEPT HIDDEN INDIVIDUALS
  65. for(let pl in hiddenPlayers) {
  66. if(!hiddenIndividual[hiddenPlayers[pl].cid]) {
  67. dispatch.toClient('S_SPAWN_USER', 3, hiddenPlayers[pl]);
  68. }
  69. }
  70. }
  71. break;
  72. // Set state to 2: Hide all skill animations.
  73. case "2":
  74. state = 2;
  75. config.state = 2;
  76. log('fps-utils optimization set to stage 2, disabling skill animations.');
  77. systemMsg('optimization set to remove skill animations. [2]');
  78. // Spawn all players with disabled animations.
  79. if(lastState > 2) {
  80. for(let pl in hiddenPlayers) {
  81. if(!hiddenIndividual[hiddenPlayers[pl].cid]) {
  82. dispatch.toClient('S_SPAWN_USER', 3, hiddenPlayers[pl]);
  83. }
  84. }
  85. }
  86. break;
  87. // Set state to 3: Hide all other players.
  88. case "3":
  89. state = 3;
  90. config.state = 3;
  91. log('fps-utils optimization set to stage 3, disabling other player models.');
  92. systemMsg('optimization set to remove other player models [3]');
  93. if(lastState < 3) {
  94. // Hide all players on screen and disable spawn.
  95. for(let pl in hiddenPlayers) {
  96. if(!hiddenIndividual[hiddenPlayers[pl].cid]) {
  97. dispatch.toClient('S_DESPAWN_USER', 2, {
  98. target: hiddenPlayers[pl].cid,
  99. type: 1
  100. });
  101. }
  102. }
  103. }
  104. break;
  105. // Save configuration to file.
  106. case "save":
  107. saveConfig();
  108. break;
  109. // Disable fireworks.
  110. case "fireworks":
  111. flags.fireworks = !flags.fireworks;
  112. log('fps-utils toggled fireworks: ' + flags.fireworks);
  113. systemMsg(`toggled fireworks: ${flags.fireworks}`);
  114. break;
  115. // Toggle individual classes on and off
  116. case "hide":
  117. if(command.length < 3) {
  118. log('fps-utils missing arguments for command "hide"');
  119. systemMsg(`missing arguments for command "hide" [dps, healers, tanks] or [username]`);
  120. break;
  121. } else {
  122. let arg2 = command[2];
  123. if(state < 3)
  124. switch(arg2.toString()) {
  125. // Hide all dps classes
  126. case "dps":
  127. log('fps-utils hiding dps classes');
  128. systemMsg(`hiding dps classes.`);
  129. flags.hide.dps = true;
  130. for (let pl in hiddenPlayers) {
  131. if((!hiddenPlayers[pl].block || !hiddenIndividual[hiddenPlayers[pl].cid]) && classes.dps.indexOf(getClass(hiddenPlayers[pl].model)) > -1) {
  132. dispatch.toClient('S_DESPAWN_USER', 2, {
  133. target: hiddenPlayers[pl].cid,
  134. type: 1
  135. });
  136. }
  137. }
  138. break;
  139. // Hide all healer classes
  140. case "healers":
  141. flags.hide.healers = true;
  142. for (let pl in hiddenPlayers) {
  143. if((!hiddenPlayers[pl].block || !hiddenIndividual[hiddenPlayers[pl].cid]) && classes.healers.indexOf(getClass(hiddenPlayers[pl].model)) > -1) {
  144. dispatch.toClient('S_DESPAWN_USER', 2, {
  145. target: hiddenPlayers[pl].cid,
  146. type: 1
  147. });
  148. }
  149. }
  150. break;
  151. // Hide all tank classes
  152. case "tanks":
  153. flags.hide.tanks = true;
  154. for (let pl in hiddenPlayers) {
  155. if(!hiddenIndividual[hiddenPlayers[pl].cid] && classes.tanks.indexOf(getClass(hiddenPlayers[pl].model)) > -1) {
  156. dispatch.toClient('S_DESPAWN_USER', 2, {
  157. target: hiddenPlayers[pl].cid,
  158. type: 1
  159. });
  160. }
  161. }
  162. break;
  163. // Argument is an individual name or not recognized.
  164. default:
  165. for(let pl in hiddenPlayers) {
  166. if(hiddenPlayers[pl].name.toString().toLowerCase() === arg2.toString().toLowerCase()) {
  167. systemMsg(`player ${hiddenPlayers[pl].name} is added to the hiding list.`)
  168. hiddenIndividual[hiddenPlayers[pl].cid] = hiddenPlayers[pl];
  169. config.hiddenPeople.push(hiddenPlayers[pl].name.toString());
  170. dispatch.toClient('S_DESPAWN_USER', 2, {
  171. target: hiddenPlayers[pl].cid,
  172. type: 1
  173. });
  174. break;
  175. } else {
  176. continue;
  177. }
  178. }
  179. break;
  180. }
  181. }
  182. break;
  183. // Try to respawn all hidden players included in show command.
  184. case "show":
  185. if(command.length < 3) {
  186. log('fps-utils missing arguments for command "show"');
  187. systemMsg(`missing arguments for command "show" [dps, healers, tanks] or [username]`);
  188. break;
  189. } else {
  190. let arg2 = command[2];
  191. if(state < 3) {
  192. switch(arg2.toString()) {
  193. case "dps":
  194. case "healers":
  195. case "tanks":
  196. if(flags.hide[arg2.toString()]) {
  197. flags.hide[arg2.toString()] = false;
  198. log('fps-utils showing: ' + arg2);
  199. systemMsg(`showing ${arg2}`);
  200. for(let pl in hiddenPlayers) {
  201. if(classes[arg2.toString()].indexOf(getClass(hiddenPlayers[pl].model)) > -1) {
  202. if(!hiddenIndividual[hiddenPlayers[pl].cid])
  203. dispatch.toClient('S_SPAWN_USER', 3, hiddenPlayers[pl]);
  204. }
  205. }
  206. }
  207. break;
  208. default:
  209. // Individuals or unkown handler.
  210. for(let pl in hiddenIndividual) {
  211. if(arg2.toString().toLowerCase() === hiddenIndividual[pl].name.toString().toLowerCase()) {
  212. systemMsg(`showing player ${hiddenIndividual[pl].name}.`);
  213. config.hiddenPeople.splice(config.hiddenPeople.indexOf(hiddenPlayers[pl].name), 1);
  214. dispatch.toClient('S_SPAWN_USER', 3, hiddenIndividual[pl]);
  215. delete hiddenIndividual[pl];
  216. }
  217. }
  218. break;
  219. }
  220. }
  221. }
  222. break;
  223. // List the players in individuals list.
  224. case "list":
  225. let hiddenArray = [];
  226. for(let pl in hiddenIndividual) {
  227. hiddenArray.push(hiddenIndividual[pl].name);
  228. }
  229. systemMsg(`Manually hidden players: ${hiddenArray}`);
  230. break;
  231. // Command not recognized
  232. default:
  233. systemMsg('Command not recognized. use [!fps help] for a list of available commands');
  234. break;
  235. }
  236. return false;
  237. } else {
  238. return false;
  239. }
  240. }
  241. function log(msg) {
  242. if(DEBUG) console.log('[fps-utils] ' + msg);
  243. }
  244. function systemMsg(msg) {
  245. dispatch.toClient('S_CHAT', 1, {
  246. channel: 24,
  247. authorID: 0,
  248. unk1: 0,
  249. gm: 0,
  250. unk2: 0,
  251. authorName: '',
  252. message: ' (fps-utils) ' + msg
  253. });
  254. }
  255. function saveConfig() {
  256. fs.writeFile('./config.json', config, 'utf8', (err) => { if(!err) log("config file overwritten successfully"); });
  257. }
  258. dispatch.hook('S_LOGIN', 2, (event) => {
  259. ({cid, model} = event);
  260. player = event.name;
  261. clss = getClass(event.model);
  262. state = config.state || 0;
  263. });
  264. dispatch.hook('S_LOAD_TOPO', 1, (event) => {
  265. // Refresh the hide list upon teleport or zone change.
  266. hiddenPlayers = {};
  267. });
  268. dispatch.hook('S_SPAWN_USER', 3, (event) => {
  269. // Add players in proximity of user to possible hide list.
  270. hiddenPlayers[event.cid] = event;
  271. // Check the state or if the individual is hidden.
  272. if(state === 3 || hiddenIndividual[event.cid]) {
  273. return false;
  274. }
  275. // Hide dps enabled, remove dps characters;
  276. if(flags.hide.dps && classes.dps.indexOf(getClass(event.model)) > -1) {
  277. return false;
  278. }
  279. // Hide tanks enabled, remove tank characters;
  280. if(flags.hide.tanks && classes.tanks.indexOf(getClass(event.model)) > -1) {
  281. return false;
  282. }
  283. // Why would you want this on, seriously...
  284. if(flags.hide.healers && classes.healers.indexOf(getClass(event.model)) > -1) {
  285. return false;
  286. }
  287. });
  288. dispatch.hook('S_DESPAWN_USER', 2, (event) => {
  289. delete hiddenPlayers[event.target];
  290. if(state === 3 || hiddenIndividual[event.target]) {
  291. return false;
  292. }
  293. });
  294. dispatch.hook('S_SPAWN_NPC', 3, (event) => {
  295. if(!flags.fireworks) {
  296. if(event.huntingZoneId === 1023 && (event.templateId === 60016000 || event.templateId === 80037000))
  297. return false;
  298. }
  299. });
  300. dispatch.hook('S_USER_LOCATION', 1, (event) => {
  301. // Update locations of every player in case we need to spawn them.
  302. hiddenPlayers[event.target].x = event.x2;
  303. hiddenPlayers[event.target].y = event.y2;
  304. hiddenPlayers[event.target].z = event.z2;
  305. hiddenPlayers[event.target].w = event.w;
  306. if(state > 2 || hiddenIndividual[event.target]) {
  307. return false;
  308. }
  309. });
  310. dispatch.hook('S_ACTION_STAGE', 1, (event) => {
  311. // If state is higher than state1 remove all skill animations.
  312. if(state > 1 && (hiddenPlayers[event.source] || hiddenIndividual[event.source]))
  313. return false;
  314. });
  315. dispatch.hook('S_ACTION_END', 1, (event) => {
  316. // If we're removing skill animations we should ignore the end packet too.
  317. if(state > 1 && (hiddenPlayers[event.source] || hiddenIndividual[event.source]))
  318. return false;
  319. });
  320. dispatch.hook('S_START_USER_PROJECTILE', 1, (event) => {
  321. // State 1 and higher ignores particles and projectiles so we're ignoring this.
  322. if(state > 0 && (hiddenPlayers[event.source] || hiddenIndividual[event.source]))
  323. return false;
  324. });
  325. dispatch.hook('S_SPAWN_PROJECTILE', 1, (event) => {
  326. // Ignore the projectile spawn if enabled in state.
  327. if(state > 0 && (hiddenPlayers[event.source] || hiddenIndividual[event.source]))
  328. return false;
  329. });
  330. dispatch.hook('C_CHAT', 1, handleCommands);
  331. }