configmanager.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395
  1. const fs = require('fs')
  2. const mkpath = require('mkdirp')
  3. const os = require('os')
  4. const path = require('path')
  5. const uuidV4 = require('uuid/v4')
  6. const sysRoot = process.env.APPDATA || (process.platform == 'darwin' ? process.env.HOME + '/Library/Application Support' : '/var/local')
  7. const dataPath = path.join(sysRoot, '.westeroscraft')
  8. const firstLaunch = !fs.existsSync(dataPath)
  9. function resolveMaxRAM(){
  10. const mem = os.totalmem()
  11. return mem >= 8000000000 ? '4G' : (mem >= 6000000000 ? '3G' : '2G')
  12. }
  13. /**
  14. * Three types of values:
  15. * Static = Explicitly declared.
  16. * Dynamic = Calculated by a private function.
  17. * Resolved = Resolved externally, defaults to null.
  18. */
  19. const DEFAULT_CONFIG = {
  20. settings: {
  21. java: {
  22. minRAM: '2G',
  23. maxRAM: resolveMaxRAM(), // Dynamic
  24. executable: null,
  25. jvmOptions: [
  26. '-XX:+UseConcMarkSweepGC',
  27. '-XX:+CMSIncrementalMode',
  28. '-XX:-UseAdaptiveSizePolicy',
  29. '-Xmn128M'
  30. ],
  31. },
  32. game: {
  33. directory: path.join(dataPath, 'game'),
  34. resWidth: 1280,
  35. resHeight: 720,
  36. fullscreen: false,
  37. autoConnect: true
  38. },
  39. launcher: {}
  40. },
  41. clientToken: uuidV4().replace(/-/g, ''),
  42. selectedServer: null, // Resolved
  43. selectedAccount: null,
  44. authenticationDatabase: {}
  45. }
  46. let config = null;
  47. // Persistance Utility Functions
  48. /**
  49. * Save the current configuration to a file.
  50. */
  51. exports.save = function(){
  52. const filePath = path.join(dataPath, 'config.json')
  53. fs.writeFileSync(filePath, JSON.stringify(config, null, 4), 'UTF-8')
  54. }
  55. /**
  56. * Load the configuration into memory. If a configuration file exists,
  57. * that will be read and saved. Otherwise, a default configuration will
  58. * be generated. Note that "resolved" values default to null and will
  59. * need to be externally assigned.
  60. */
  61. exports.load = function(){
  62. // Determine the effective configuration.
  63. //const EFFECTIVE_CONFIG = config == null ? DEFAULT_CONFIG : config
  64. const filePath = path.join(dataPath, 'config.json')
  65. if(!fs.existsSync(filePath)){
  66. // Create all parent directories.
  67. mkpath.sync(path.join(filePath, '..'))
  68. config = DEFAULT_CONFIG
  69. exports.save()
  70. } else {
  71. config = JSON.parse(fs.readFileSync(filePath, 'UTF-8'))
  72. }
  73. }
  74. /**
  75. * Retrieve the absolute path of the launcher directory.
  76. *
  77. * @returns {string} The absolute path of the launcher directory.
  78. */
  79. exports.getLauncherDirectory = function(){
  80. return dataPath
  81. }
  82. /**
  83. * Check to see if this is the first time the user has launched the
  84. * application. This is determined by the existance of the data path.
  85. *
  86. * @returns {boolean} True if this is the first launch, otherwise false.
  87. */
  88. exports.isFirstLaunch = function(){
  89. return firstLaunch
  90. }
  91. // System Settings (Unconfigurable on UI)
  92. /**
  93. * Retrieve the launcher's Client Token.
  94. * There is no default client token.
  95. *
  96. * @returns {string} The launcher's Client Token.
  97. */
  98. exports.getClientToken = function(){
  99. return config.clientToken
  100. }
  101. /**
  102. * Set the launcher's Client Token.
  103. *
  104. * @param {string} clientToken The launcher's new Client Token.
  105. */
  106. exports.setClientToken = function(clientToken){
  107. config.clientToken = clientToken
  108. }
  109. /**
  110. * Retrieve the ID of the selected serverpack.
  111. *
  112. * @param {boolean} def Optional. If true, the default value will be returned.
  113. * @returns {string} The ID of the selected serverpack.
  114. */
  115. exports.getSelectedServer = function(def = false){
  116. return !def ? config.selectedServer : DEFAULT_CONFIG.clientToken
  117. }
  118. /**
  119. * Set the ID of the selected serverpack.
  120. *
  121. * @param {string} serverID The ID of the new selected serverpack.
  122. */
  123. exports.setSelectedServer = function(serverID){
  124. config.selectedServer = serverID
  125. }
  126. /**
  127. * Get an array of each account currently authenticated by the launcher.
  128. *
  129. * @returns {Array.<Object>} An array of each stored authenticated account.
  130. */
  131. exports.getAuthAccounts = function(){
  132. return config.authenticationDatabase
  133. }
  134. /**
  135. * Returns the authenticated account with the given uuid. Value may
  136. * be null.
  137. *
  138. * @param {string} uuid The uuid of the authenticated account.
  139. * @returns {Object} The authenticated account with the given uuid.
  140. */
  141. exports.getAuthAccount = function(uuid){
  142. return config.authenticationDatabase[uuid]
  143. }
  144. /**
  145. * Update the access token of an authenticated account.
  146. *
  147. * @param {string} uuid The uuid of the authenticated account.
  148. * @param {string} accessToken The new Access Token.
  149. *
  150. * @returns {Object} The authenticated account object created by this action.
  151. */
  152. exports.updateAuthAccount = function(uuid, accessToken){
  153. config.authenticationDatabase[uuid].accessToken = accessToken
  154. return config.authenticationDatabase[uuid]
  155. }
  156. /**
  157. * Adds an authenticated account to the database to be stored.
  158. *
  159. * @param {string} uuid The uuid of the authenticated account.
  160. * @param {string} accessToken The accessToken of the authenticated account.
  161. * @param {string} username The username (usually email) of the authenticated account.
  162. * @param {string} displayName The in game name of the authenticated account.
  163. *
  164. * @returns {Object} The authenticated account object created by this action.
  165. */
  166. exports.addAuthAccount = function(uuid, accessToken, username, displayName){
  167. config.selectedAccount = uuid
  168. config.authenticationDatabase[uuid] = {
  169. accessToken,
  170. username,
  171. uuid,
  172. displayName
  173. }
  174. return config.authenticationDatabase[uuid]
  175. }
  176. /**
  177. * Get the currently selected authenticated account.
  178. *
  179. * @returns {Object} The selected authenticated account.
  180. */
  181. exports.getSelectedAccount = function(){
  182. return config.authenticationDatabase[config.selectedAccount]
  183. }
  184. // User Configurable Settings
  185. // Java Settings
  186. /**
  187. * Retrieve the minimum amount of memory for JVM initialization. This value
  188. * contains the units of memory. For example, '5G' = 5 GigaBytes, '1024M' =
  189. * 1024 MegaBytes, etc.
  190. *
  191. * @param {boolean} def Optional. If true, the default value will be returned.
  192. * @returns {string} The minimum amount of memory for JVM initialization.
  193. */
  194. exports.getMinRAM = function(def = false){
  195. return !def ? config.settings.java.minRAM : DEFAULT_CONFIG.settings.java.minRAM
  196. }
  197. /**
  198. * Set the minimum amount of memory for JVM initialization. This value should
  199. * contain the units of memory. For example, '5G' = 5 GigaBytes, '1024M' =
  200. * 1024 MegaBytes, etc.
  201. *
  202. * @param {string} minRAM The new minimum amount of memory for JVM initialization.
  203. */
  204. exports.setMinRAM = function(minRAM){
  205. config.settings.java.minRAM = minRAM
  206. }
  207. /**
  208. * Retrieve the maximum amount of memory for JVM initialization. This value
  209. * contains the units of memory. For example, '5G' = 5 GigaBytes, '1024M' =
  210. * 1024 MegaBytes, etc.
  211. *
  212. * @param {boolean} def Optional. If true, the default value will be returned.
  213. * @returns {string} The maximum amount of memory for JVM initialization.
  214. */
  215. exports.getMaxRAM = function(def = false){
  216. return !def ? config.settings.java.maxRAM : resolveMaxRAM()
  217. }
  218. /**
  219. * Set the maximum amount of memory for JVM initialization. This value should
  220. * contain the units of memory. For example, '5G' = 5 GigaBytes, '1024M' =
  221. * 1024 MegaBytes, etc.
  222. *
  223. * @param {string} maxRAM The new maximum amount of memory for JVM initialization.
  224. */
  225. exports.setMaxRAM = function(maxRAM){
  226. config.settings.java.maxRAM = maxRAM
  227. }
  228. /**
  229. * Retrieve the path of the Java Executable.
  230. *
  231. * This is a resolved configuration value and defaults to null until externally assigned.
  232. *
  233. * @returns {string} The path of the Java Executable.
  234. */
  235. exports.getJavaExecutable = function(){
  236. return config.settings.java.executable
  237. }
  238. /**
  239. * Set the path of the Java Executable.
  240. *
  241. * @param {string} executable The new path of the Java Executable.
  242. */
  243. exports.setJavaExecutable = function(executable){
  244. config.settings.java.executable = executable
  245. }
  246. /**
  247. * Retrieve the additional arguments for JVM initialization. Required arguments,
  248. * such as memory allocation, will be dynamically resolved and will not be included
  249. * in this value.
  250. *
  251. * @param {boolean} def Optional. If true, the default value will be returned.
  252. * @returns {Array.<string>} An array of the additional arguments for JVM initialization.
  253. */
  254. exports.getJVMOptions = function(def = false){
  255. return !def ? config.settings.java.jvmOptions : DEFAULT_CONFIG.settings.java.jvmOptions
  256. }
  257. /**
  258. * Set the additional arguments for JVM initialization. Required arguments,
  259. * such as memory allocation, will be dynamically resolved and should not be
  260. * included in this value.
  261. *
  262. * @param {Array.<string>} jvmOptions An array of the new additional arguments for JVM
  263. * initialization.
  264. */
  265. exports.setJVMOptions = function(jvmOptions){
  266. config.settings.java.jvmOptions = jvmOptions
  267. }
  268. // Game Settings
  269. /**
  270. * Retrieve the absolute path of the game directory.
  271. *
  272. * @param {boolean} def Optional. If true, the default value will be returned.
  273. * @returns {string} The absolute path of the game directory.
  274. */
  275. exports.getGameDirectory = function(def = false){
  276. return !def ? config.settings.game.directory : DEFAULT_CONFIG.settings.game.directory
  277. }
  278. /**
  279. * Set the absolute path of the game directory.
  280. *
  281. * @param {string} directory The absolute path of the new game directory.
  282. */
  283. exports.setGameDirectory = function(directory){
  284. config.settings.game.directory = directory
  285. }
  286. /**
  287. * Retrieve the width of the game window.
  288. *
  289. * @param {boolean} def Optional. If true, the default value will be returned.
  290. * @returns {number} The width of the game window.
  291. */
  292. exports.getGameWidth = function(def = false){
  293. return !def ? config.settings.game.resWidth : DEFAULT_CONFIG.settings.game.resWidth
  294. }
  295. /**
  296. * Set the width of the game window.
  297. *
  298. * @param {number} resWidth The new width of the game window.
  299. */
  300. exports.setGameWidth = function(resWidth){
  301. config.settings.game.resWidth = resWidth
  302. }
  303. /**
  304. * Retrieve the height of the game window.
  305. *
  306. * @param {boolean} def Optional. If true, the default value will be returned.
  307. * @returns {number} The height of the game window.
  308. */
  309. exports.getGameHeight = function(def = false){
  310. return !def ? config.settings.game.resHeight : DEFAULT_CONFIG.settings.game.resHeight
  311. }
  312. /**
  313. * Set the height of the game window.
  314. *
  315. * @param {number} resHeight The new height of the game window.
  316. */
  317. exports.setGameHeight = function(resHeight){
  318. config.settings.game.resHeight = resHeight
  319. }
  320. /**
  321. * Check if the game should be launched in fullscreen mode.
  322. *
  323. * @param {boolean} def Optional. If true, the default value will be returned.
  324. * @returns {boolean} Whether or not the game is set to launch in fullscreen mode.
  325. */
  326. exports.isFullscreen = function(def = false){
  327. return !def ? config.settings.game.fullscreen : DEFAULT_CONFIG.settings.game.fullscreen
  328. }
  329. /**
  330. * Change the status of if the game should be launched in fullscreen mode.
  331. *
  332. * @param {boolean} fullscreen Whether or not the game should launch in fullscreen mode.
  333. */
  334. exports.setFullscreen = function(fullscreen){
  335. config.settings.game.fullscreen = fullscreen
  336. }
  337. /**
  338. * Check if the game should auto connect to servers.
  339. *
  340. * @param {boolean} def Optional. If true, the default value will be returned.
  341. * @returns {boolean} Whether or not the game should auto connect to servers.
  342. */
  343. exports.isAutoConnect = function(def = false){
  344. return !def ? config.settings.game.autoConnect : DEFAULT_CONFIG.settings.game.autoConnect
  345. }
  346. /**
  347. * Change the status of whether or not the game should auto connect to servers.
  348. *
  349. * @param {boolean} autoConnect Whether or not the game should auto connect to servers.
  350. */
  351. exports.setAutoConnect = function(autoConnect){
  352. config.settings.game.autoConnect = autoConnect
  353. }