index.js 15 KB

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