diff options
| -rw-r--r-- | docs/whirl/configuration.md | 41 | ||||
| -rw-r--r-- | docusaurus.config.js | 4 | ||||
| -rw-r--r-- | package.json | 6 | ||||
| -rw-r--r-- | yarn.lock | 24 |
4 files changed, 50 insertions, 25 deletions
diff --git a/docs/whirl/configuration.md b/docs/whirl/configuration.md index a96ca4b..9764fc0 100644 --- a/docs/whirl/configuration.md +++ b/docs/whirl/configuration.md @@ -8,15 +8,6 @@ The server operator's username. This should NOT be changed under normal circumstances. -### Log Level -The level of logging which the serve should emit. - -By default, **errors**, **warnings**, and **info** (1) logs are emitted, however, you can change -this value to enable **debug** (2) and **trace** (3) logging. - -Under normal circumstances, this value should only be changed when instructed to or if you are -experiencing any undefined/ unexpected behaviours and you would like to try self-debugging. - ### IP **This configuration option may become deprecated in the near: [issue](https://github.com/Whirlsplash/whirl/issues/18).** @@ -27,6 +18,10 @@ When connecting to a local server (client and host both originate from the same `0.0.0.0` or `127.0.0.1` is fine, however, if you are hosting a server publicly as service, this should be changed to the host's IP address. +### API +#### Port +The port on which Whirl's administration and statistics server is listening. + ### Prompt #### Enable Manually enable the Whirl Shell. @@ -35,6 +30,34 @@ Manually enable the Whirl Shell. Similar to a PS1 as seen in *nix-based operating systems, the Prompt String/ Statement One is the prompt string which will appear if you have the Whirl Shell enabled. +### Log +#### Enable +Toggle the logging functionality of Whirl. + +#### Level +The level of logging which the serve should emit. + +By default, **errors**, **warnings**, and **info** (1) logs are emitted, however, you can change +this value to enable **debug** (2) and **trace** (3) logs. + +Under normal circumstances, this value should only be changed when instructed to or if you are +experiencing any undefined/ unexpected behaviours and you would like to try self-debugging. + +#### Everything +Enables logging from **ALL** of Whirl and it's dependencies. + +It it's default state, false, only Whirl's core crates emit logging information, with this +configuration key enabled, **ALL** of Whirl's external dependencies will emit logging information. + +This configuration key is best left disabled. + +#### Test +Emits a single log for each log level, useful for debugging. + +#### File +If enabled, logs will be emitted to a file within a directory relative to the Whirl binary in a +directory named `log`. If disabled, logs will be emitted to standard out. + ## Distributor ### WorldsMaster Greeting The first message or "greeting" which is sent to a user once connected to a WorldServer. diff --git a/docusaurus.config.js b/docusaurus.config.js index 9690adb..5cadd12 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -68,7 +68,9 @@ module.exports = { title: 'Community', items: [ { label: 'Blog', to: 'blog', }, + { label: 'Twitter', href: 'https://twitter.com/Whirlsplash_', }, { label: 'Discord', href: 'https://discord.com/invite/8hn6padWF6', }, + { label: 'Subreddit', href: 'https://www.reddit.com/r/Whirlsplash', }, ], }, { @@ -80,7 +82,7 @@ module.exports = { ], }, ], - copyright: `Copyleft © ${new Date().getFullYear()} The Whirlsplash Collective`, + copyright: `Copyright (C) 2021-${new Date().getFullYear()} The Whirlsplash Collective`, }, colorMode: { diff --git a/package.json b/package.json index bc4ce4c..b6cb70b 100644 --- a/package.json +++ b/package.json @@ -21,7 +21,7 @@ "@docusaurus/theme-live-codeblock": "2.0.0-alpha.74", "@mdx-js/react": "1.6.22", "clsx": "1.1.1", - "dotenv": "8.2.0", + "dotenv": "10.0.0", "react": "17.0.2", "react-dom": "17.0.2" }, @@ -42,12 +42,12 @@ "@commitlint/config-conventional": "12.1.4", "@docusaurus/module-type-aliases": "2.0.0-alpha.72", "@tsconfig/docusaurus": "1.0.2", - "@types/react": "17.0.5", + "@types/react": "17.0.11", "@types/react-helmet": "6.1.1", "@types/react-router-dom": "5.1.7", "commitizen": "4.2.4", "cz-conventional-changelog": "3.3.0", "husky": "6.0.0", - "typescript": "4.2.4" + "typescript": "4.3.4" } } @@ -2167,10 +2167,10 @@ "@types/scheduler" "*" csstype "^3.0.2" -"@types/[email protected]": - version "17.0.5" - resolved "https://registry.yarnpkg.com/@types/react/-/react-17.0.5.tgz#3d887570c4489011f75a3fc8f965bf87d09a1bea" - integrity sha512-bj4biDB9ZJmGAYTWSKJly6bMr4BLUiBrx9ujiJEoP9XIDY9CTaPGxE5QWN/1WjpPLzYF7/jRNnV2nNxNe970sw== +"@types/[email protected]": + version "17.0.11" + resolved "https://registry.yarnpkg.com/@types/react/-/react-17.0.11.tgz#67fcd0ddbf5a0b083a0f94e926c7d63f3b836451" + integrity sha512-yFRQbD+whVonItSk7ZzP/L+gPTJVBkL/7shLEF+i9GC/1cV3JmUxEQz6+9ylhUpWSDuqo1N9qEvqS6vTj4USUA== dependencies: "@types/prop-types" "*" "@types/scheduler" "*" @@ -4573,10 +4573,10 @@ dot-prop@^5.1.0, dot-prop@^5.2.0: dependencies: is-obj "^2.0.0" - version "8.2.0" - resolved "https://registry.yarnpkg.com/dotenv/-/dotenv-8.2.0.tgz#97e619259ada750eea3e4ea3e26bceea5424b16a" - integrity sha512-8sJ78ElpbDJBHNeBzUbUVLsqKdccaa/BXF1uPTw3GrvQTBgrQrtObr2mUrE38vzYd8cEv+m/JBfDLioYcfXoaw== + version "10.0.0" + resolved "https://registry.yarnpkg.com/dotenv/-/dotenv-10.0.0.tgz#3d4227b8fb95f81096cdd2b66653fb2c7085ba81" + integrity sha512-rlBi9d8jpv9Sf1klPjNfFAuWDjKLwTIJJ/VxtoTwIR6hnZxcEOQCZg2oIL3MWBYw5GpUDKOEnND7LXTbIpQ03Q== duplexer3@^0.1.4: version "0.1.4" @@ -10674,10 +10674,10 @@ typedarray@^0.0.6: resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777" integrity sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c= - version "4.2.4" - resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.2.4.tgz#8610b59747de028fda898a8aef0e103f156d0961" - integrity sha512-V+evlYHZnQkaz8TRBuxTA92yZBPotr5H+WhQ7bD3hZUndx5tGOa1fuCgeSjxAzM1RiN5IzvadIXTVefuuwZCRg== + version "4.3.4" + resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.3.4.tgz#3f85b986945bcf31071decdd96cf8bfa65f9dcbc" + integrity sha512-uauPG7XZn9F/mo+7MrsRjyvbxFpzemRjKEZXS4AK83oP2KKOJPvb+9cO/gmnv8arWZvhnjVOXz7B49m1l0e9Ew== ua-parser-js@^0.7.18: version "0.7.27" |