diff --git a/docs/docs/api/auth.md b/docs/docs/api/auth.md index 2bc048a2e..c18c29077 100644 --- a/docs/docs/api/auth.md +++ b/docs/docs/api/auth.md @@ -17,7 +17,7 @@ To use authentication with a request, you should set a HTTP header of: Authorization: Bearer API_KEY ``` -Where API_KEY is the api key you wish to use. +Where API_KEY is the API key you wish to use. ### Self-Key Authentication diff --git a/docs/docs/api/index.md b/docs/docs/api/index.md index 456af0c67..f67f8a1dd 100644 --- a/docs/docs/api/index.md +++ b/docs/docs/api/index.md @@ -3,7 +3,7 @@ Tachi exposes a public API which allows programs to interact with Tachi. This means you could make your own applications that work off of Tachi's -datasets. +datasets. !!! warning This documentation assumes some basic programming knowledge, such as how to make @@ -38,7 +38,7 @@ send an email to `zk@tachi.ac` and let me know what you're up to. Otherwise, I m To quote GitHub: -!!! quote +!!! quote Permissions of this strongest copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights. When a modified version is used to provide a service over a network, the complete source code of the modified version must be made available. This is not legal advice. diff --git a/docs/docs/api/webhooks/main.md b/docs/docs/api/webhooks/main.md index 6e55c9aad..897b2ebbf 100644 --- a/docs/docs/api/webhooks/main.md +++ b/docs/docs/api/webhooks/main.md @@ -5,7 +5,7 @@ Tachi supports webhooks. You can set a `webhookUri` as part of your ## Usage and Security -When a given event happens on Tachi, your webhookUri will recieve a POST +When a given event happens on Tachi, your webhookUri will receive a POST request with some content and the type of event. You **MUST** validate that this request was from Tachi! Otherwise, anyone diff --git a/docs/docs/codebase/batch-manual/direct-manual.md b/docs/docs/codebase/batch-manual/direct-manual.md index cf13399a2..9e79a8183 100644 --- a/docs/docs/codebase/batch-manual/direct-manual.md +++ b/docs/docs/codebase/batch-manual/direct-manual.md @@ -19,4 +19,4 @@ being automated in the background). ## That's it! -Seriously -- that's it. \ No newline at end of file +Seriously -- that's it. diff --git a/docs/docs/codebase/batch-manual/index.md b/docs/docs/codebase/batch-manual/index.md index 0e672f7c3..ca66e541c 100644 --- a/docs/docs/codebase/batch-manual/index.md +++ b/docs/docs/codebase/batch-manual/index.md @@ -143,7 +143,7 @@ can only be used for USC. - inGameID This uses the in-game-ID for this **SONG**. You, therefore, -**MUST** specify the difficulty for this chart aswell. +**MUST** specify the difficulty for this chart as well. This is supported for the following games: @@ -158,7 +158,7 @@ This is supported for the following games: - sdvxInGameID This uses the in-game-ID for this SDVX song. You must specify -the difficulty for this chart aswell. +the difficulty for this chart as well. The reason SDVX gets its own special `matchType` is because this matchType supports `difficulty: "ANY_INF"`. This special difficulty diff --git a/docs/docs/codebase/implementation-details/details.md b/docs/docs/codebase/implementation-details/details.md index f150a41b9..c2d94058f 100644 --- a/docs/docs/codebase/implementation-details/details.md +++ b/docs/docs/codebase/implementation-details/details.md @@ -5,4 +5,3 @@ codebase reference is technically about implementation details, this part is for miscellaneous implementation details that wouldn't fit anywhere else. ***** - diff --git a/docs/docs/codebase/implementation-details/goal-id.md b/docs/docs/codebase/implementation-details/goal-id.md index 2b235ec30..43c774794 100644 --- a/docs/docs/codebase/implementation-details/goal-id.md +++ b/docs/docs/codebase/implementation-details/goal-id.md @@ -10,7 +10,7 @@ representing the same thing. ## Hashing -To create the Goal ID, we perform a [json stable hash](https://github.com/zkrising/fast-json-stable-hash) on the +To create the Goal ID, we perform a [JSON stable hash](https://github.com/zkrising/fast-json-stable-hash) on the `game`, `playtype`, `charts` and `criteria` of this field. This enforces that goals are unique on those fields. diff --git a/docs/docs/codebase/implementation-details/score-id.md b/docs/docs/codebase/implementation-details/score-id.md index d741d864b..b3bca918a 100644 --- a/docs/docs/codebase/implementation-details/score-id.md +++ b/docs/docs/codebase/implementation-details/score-id.md @@ -40,4 +40,3 @@ pieces of info (i.e. no judgements), then trying to import that same score with judgements later will not work, as the scoreID sees it as a duplicate. See [Clobbering](todo). - diff --git a/docs/docs/codebase/import/conv-failures.md b/docs/docs/codebase/import/conv-failures.md index d9c7f7ade..61c6ad85f 100644 --- a/docs/docs/codebase/import/conv-failures.md +++ b/docs/docs/codebase/import/conv-failures.md @@ -43,7 +43,7 @@ An example of this would be an IIDX score with -1 EX Score. ## Internal Failure This is an internal failure, and thrown when something bad -has occured on our end. +has occurred on our end. The most common case for throwing this is the "Song-Chart" desync. This occurs when a chart has no parent song (and @@ -57,4 +57,4 @@ a chart must have a parent song.) If any exception is thrown from a converter that is **NOT** an `instanceof` ConverterFailure, it is treated as an -InternalFailure. \ No newline at end of file +InternalFailure. diff --git a/docs/docs/codebase/import/import-doc-time.md b/docs/docs/codebase/import/import-doc-time.md index ddce2f7ed..debcccdce 100644 --- a/docs/docs/codebase/import/import-doc-time.md +++ b/docs/docs/codebase/import/import-doc-time.md @@ -19,7 +19,7 @@ Else, the import is logged as debug. An internal document - Import Timings - is created by storing the time each step of the import process took -in miliseconds. +in milliseconds. This is analysed regularly to check for performance degradation and look for potential optimisations. diff --git a/docs/docs/codebase/import/importing.md b/docs/docs/codebase/import/importing.md index df81a1378..d51b06206 100644 --- a/docs/docs/codebase/import/importing.md +++ b/docs/docs/codebase/import/importing.md @@ -17,7 +17,7 @@ fledged Tachi score, and then goes over how it is imported. ## Return Format -The `ImportIterableDatapoint` returns +The `ImportIterableDatapoint` returns `ImportProcessingInfo` or `null`. The format for the former can be found in `tachi-common`, and **should be read** before following this document! diff --git a/docs/docs/codebase/import/main.md b/docs/docs/codebase/import/main.md index e17dce474..c44ba3084 100644 --- a/docs/docs/codebase/import/main.md +++ b/docs/docs/codebase/import/main.md @@ -147,10 +147,9 @@ value of this function. ### Import Timings -Every step in this process is timed in miliseconds. +Every step in this process is timed in milliseconds. The time each step took is saved alongside the ImportID. This is used for internal debugging and degraded performance checks. - diff --git a/docs/docs/codebase/import/orphans.md b/docs/docs/codebase/import/orphans.md index f59dc1ec7..895b4238c 100644 --- a/docs/docs/codebase/import/orphans.md +++ b/docs/docs/codebase/import/orphans.md @@ -30,4 +30,4 @@ If it results in a success, we have a new DryScore we can import. !!! note This is why Converter Functions are completely static, so we can safely call the same Converter - Function with this data to unorphan scores. \ No newline at end of file + Function with this data to unorphan scores. diff --git a/docs/docs/codebase/import/parse-conv.md b/docs/docs/codebase/import/parse-conv.md index 9fbfa72a8..5b5453e39 100644 --- a/docs/docs/codebase/import/parse-conv.md +++ b/docs/docs/codebase/import/parse-conv.md @@ -276,6 +276,7 @@ that means that they cannot be dynamically constructed with closures or similar. ### Arguments + Converters are called with these four arguments: | Property | Type | Description | diff --git a/docs/docs/codebase/import/parse-ipi.md b/docs/docs/codebase/import/parse-ipi.md index 309e315cc..469a82f4f 100644 --- a/docs/docs/codebase/import/parse-ipi.md +++ b/docs/docs/codebase/import/parse-ipi.md @@ -29,4 +29,4 @@ in successive score import steps. Some imports may import scores from multiple Playtypes. We frequently want to only refer to the set of scores modified under a given playtype (For importing a users game:playtype stats, as an example) -so this is a very useful data structure to have. \ No newline at end of file +so this is a very useful data structure to have. diff --git a/docs/docs/codebase/import/quests.md b/docs/docs/codebase/import/quests.md index 914673423..f441f77f8 100644 --- a/docs/docs/codebase/import/quests.md +++ b/docs/docs/codebase/import/quests.md @@ -17,4 +17,4 @@ is emitted, which could be hooked into by our Discord Bot. If the progress has changed at all, the data is pushed to an array which is then returned. This is -attached onto the Import Document. \ No newline at end of file +attached onto the Import Document. diff --git a/docs/docs/codebase/infrastructure/api-clients.md b/docs/docs/codebase/infrastructure/api-clients.md index 830782e6a..92ba5868f 100644 --- a/docs/docs/codebase/infrastructure/api-clients.md +++ b/docs/docs/codebase/infrastructure/api-clients.md @@ -12,4 +12,4 @@ Tachi fully supports OAuth2. When you create a Tachi API Client, you can set a ` ## Client File Flow -Alternatively, if you're just looking for a nice UI for users to create an API Key with the right permissions, check out the [Client File Flow](./file-flow.md). \ No newline at end of file +Alternatively, if you're just looking for a nice UI for users to create an API Key with the right permissions, check out the [Client File Flow](./file-flow.md). diff --git a/docs/docs/codebase/infrastructure/logging.md b/docs/docs/codebase/infrastructure/logging.md index c9bebe134..f94bdfba6 100644 --- a/docs/docs/codebase/infrastructure/logging.md +++ b/docs/docs/codebase/infrastructure/logging.md @@ -37,7 +37,7 @@ logger.severe("foo"); `severe` is the second most severe log level in tachi. -Calling this means an error has occured, and that error implies +Calling this means an error has occurred, and that error implies it will apply to multiple parts of the codebase. This log level is used with things like a Song-Chart @@ -54,7 +54,7 @@ logger.error("foo"); `error` is the third most severe log level in tachi. -Calling this means an error has occured, but the impact of +Calling this means an error has occurred, but the impact of it is limited to the function or general area it was called in. Errors may be recovered from or ignored by the code, but generally that should be reserved for `warn`. diff --git a/docs/docs/codebase/setup/config.md b/docs/docs/codebase/setup/config.md index 4b07fc1d7..d910c0bb4 100644 --- a/docs/docs/codebase/setup/config.md +++ b/docs/docs/codebase/setup/config.md @@ -179,7 +179,6 @@ If present, and a string, this points to the local dev server for a react app. H option set results in CORS being enabled for *that* specific URL. This is useful for local development, but should not be used in production. - ### RATE_LIMIT - Type: Positive Integer @@ -242,7 +241,6 @@ Where *this* server is hosted. This is used to provide callback URLs inside emails. You may stub it out if emails are unsupported. - ### EMAIL_CONFIG - Type: EMAIL_CONFIG | undefined. diff --git a/docs/docs/codebase/structure/filesystem.md b/docs/docs/codebase/structure/filesystem.md index 8d1faa834..fe859d483 100644 --- a/docs/docs/codebase/structure/filesystem.md +++ b/docs/docs/codebase/structure/filesystem.md @@ -130,7 +130,7 @@ https://boku.tachi.ac/api/v1/foo/bar The only files allowed to declare endpoints are `router.ts` files. -This allows us to seperate functionality from API structure +This allows us to separate functionality from API structure in cases where an API call needs to do a lot of things. ## Test Files diff --git a/docs/docs/contributing/components.md b/docs/docs/contributing/components.md index e37a1a455..a47bbb17b 100644 --- a/docs/docs/contributing/components.md +++ b/docs/docs/contributing/components.md @@ -33,7 +33,7 @@ are **thoroughly** appreciated, as `zk` prioritises maintaining the core of work If you're interested in this, check out the [Documentation Contribution Guide](./components/documentation.md). -j### Database Seeds +### Database Seeds We use an interesting system for parts of our database. We actually store a game's songs and charts *in* our GitHub repository! That means you can: diff --git a/docs/docs/contributing/components/core.md b/docs/docs/contributing/components/core.md index 4af1387b4..0f2842573 100644 --- a/docs/docs/contributing/components/core.md +++ b/docs/docs/contributing/components/core.md @@ -40,4 +40,4 @@ Use `just load-kamai-dataset` or `just load-boku-dataset` to load a *real* datas You'll then need to edit `server/conf.json5` and change `MONGO_DATABASE_NAME` to `"anon-kamai"` or `"anon-boku"`. -Everyone's passwords are set to `password`, so feel free to log in as anyone, and see real data! \ No newline at end of file +Everyone's passwords are set to `password`, so feel free to log in as anyone, and see real data! diff --git a/docs/docs/contributing/components/documentation.md b/docs/docs/contributing/components/documentation.md index 57e1b96ea..4742f9b0b 100644 --- a/docs/docs/contributing/components/documentation.md +++ b/docs/docs/contributing/components/documentation.md @@ -42,4 +42,4 @@ It also manages the order of pages on the site. **You need to edit this if you'r It's just documentation. Make the changes and commit them up, ideally with `docs:` as the commit prefix. -That is to say: your commit messages should look like `docs: fixed typo in API route`. \ No newline at end of file +That is to say: your commit messages should look like `docs: fixed typo in API route`. diff --git a/docs/docs/contributing/components/issues.md b/docs/docs/contributing/components/issues.md index 9c71e168b..a7c72eb49 100644 --- a/docs/docs/contributing/components/issues.md +++ b/docs/docs/contributing/components/issues.md @@ -28,4 +28,3 @@ Search for existing issues before opening a new one. There might already be one ## That's it! Don't fret too much about writing perfect issues, but put some effort into them. The development team look at everything that comes through, and will tidy up bits of your issue for you if you make a mistake. - diff --git a/docs/docs/contributing/cookbook/sdvx-mdb.md b/docs/docs/contributing/cookbook/sdvx-mdb.md index 1fa9db4c9..b4bc1edda 100644 --- a/docs/docs/contributing/cookbook/sdvx-mdb.md +++ b/docs/docs/contributing/cookbook/sdvx-mdb.md @@ -18,4 +18,3 @@ The file you're looking to run is `merge-mdb.ts`, but it needs two arguments: - `--version`, what version of the game this music db is from. For a list of versions, see the [SDVX Config](../../game-support/games/sdvx-Single.md#versions). You can run this script by typing `ts-node merge-mdb.ts --input YOUR_INPUT_HERE --version YOUR_VERSION_HERE` in the terminal. - diff --git a/docs/docs/contributing/index.md b/docs/docs/contributing/index.md index 213e9e0f5..1631f61ed 100644 --- a/docs/docs/contributing/index.md +++ b/docs/docs/contributing/index.md @@ -24,4 +24,4 @@ and Tachi's support for your favourite game even better! ## Sounds good. -Awesome! Start with the [Setup](./setup.md) guide. This will get Tachi running on your local PC, so you can test all your changes. \ No newline at end of file +Awesome! Start with the [Setup](./setup.md) guide. This will get Tachi running on your local PC, so you can test all your changes. diff --git a/docs/docs/contributing/setup.md b/docs/docs/contributing/setup.md index 4497caab1..70fce9ecf 100644 --- a/docs/docs/contributing/setup.md +++ b/docs/docs/contributing/setup.md @@ -85,7 +85,7 @@ To set everything else up for local development, we'll use [Docker](https://dock ## 2. Fork and pull the repo. -Since you can't just commit straight to someone elses codebase (that would be a massive security issue), you need to make a fork of Tachi - One owned by you! +Since you can't just commit straight to someone else's codebase (that would be a massive security issue), you need to make a fork of Tachi - One owned by you! Go to [the Tachi repository](https://github.com/zkrising/Tachi) and click the Fork button in the top right (Make sure you're signed in). diff --git a/docs/docs/game-support/client-impl.md b/docs/docs/game-support/client-impl.md index f37d78ebd..70e4b5390 100644 --- a/docs/docs/game-support/client-impl.md +++ b/docs/docs/game-support/client-impl.md @@ -162,4 +162,4 @@ This is a function that takes in the aforementioned `sc` and `chart`, alongside ## That's it! -Congrats! If you've done this, the [Server Implementation](./server-impl.md) and the [Common Configuration](./common-config/index.md), you've just added full support for a game to Tachi! Nice job! \ No newline at end of file +Congrats! If you've done this, the [Server Implementation](./server-impl.md) and the [Common Configuration](./common-config/index.md), you've just added full support for a game to Tachi! Nice job! diff --git a/docs/docs/game-support/common-config/metric-groups.md b/docs/docs/game-support/common-config/metric-groups.md index f37214c3a..a903b9b14 100644 --- a/docs/docs/game-support/common-config/metric-groups.md +++ b/docs/docs/game-support/common-config/metric-groups.md @@ -100,4 +100,3 @@ These metrics are defined like any other, but are all allowed to be not-provided doesn't necessarily have to be enabled by the user - but if it does exist, we want to track it properly. That is to say, if the user raises their `exScore` but nothing else, we should still count that as a new score - despite `exScore` being optional! - diff --git a/docs/docs/game-support/common-config/metrics.md b/docs/docs/game-support/common-config/metrics.md index 4fffc8403..a933077ed 100644 --- a/docs/docs/game-support/common-config/metrics.md +++ b/docs/docs/game-support/common-config/metrics.md @@ -96,7 +96,7 @@ This metric is an array of numbers or null. Metrics of type `ENUM` are special in many ways. Most importantly, they don't require any sort of validation - the input is either a member of `values` or it isn't. -An ENUM metric looks like this: +An ENUM metric looks like this: ```ts { type: "ENUM", @@ -173,7 +173,7 @@ We will have to write the validator later in the server implementation. ### Formatting We also want to format these metrics into a string. For example, a `percent` metric may want to stringify into `92.45%` instead of `92.49938222293842`. -More subtle formatting rules can be defined here too, such as how in jubeat, scores are +More subtle formatting rules can be defined here too, such as how in Jubeat, scores are easier to read written like `903,283` instead of `903283`. ## Graph Metrics @@ -199,4 +199,4 @@ the array too. You can use this to enforce a certain array size (such as exactly This is how metrics work, but there's more detail in how they're defined in each game's config. -For example, some metrics (like `grade` for a lot of games) are merely functions of other metrics. Making every import method handle this themselves seems silly. How do we tackle this? This, and more, is answered in [Metric Groups](./metric-groups.md)! \ No newline at end of file +For example, some metrics (like `grade` for a lot of games) are merely functions of other metrics. Making every import method handle this themselves seems silly. How do we tackle this? This, and more, is answered in [Metric Groups](./metric-groups.md)! diff --git a/docs/docs/game-support/common-config/versions.md b/docs/docs/game-support/common-config/versions.md index b9e449835..08ed8cf0f 100644 --- a/docs/docs/game-support/common-config/versions.md +++ b/docs/docs/game-support/common-config/versions.md @@ -29,4 +29,4 @@ in, it **MAY** pass what version the score was attained on. This allows us to immediately disambiguate the previous case. If a version is **not** passed in, we assume that the score is for the chart marked as -`isPrimary: true`. Furthermore, seeds tests **enforce** that duplicates on certain IDs expected-to-be-unique cannot be true unless all-but-one-of-them is marked as `isPrimary: false`. \ No newline at end of file +`isPrimary: true`. Furthermore, seeds tests **enforce** that duplicates on certain IDs expected-to-be-unique cannot be true unless all-but-one-of-them is marked as `isPrimary: false`. diff --git a/docs/docs/game-support/games/arcaea-Touch.md b/docs/docs/game-support/games/arcaea-Touch.md index a0f76ae5d..3e7654c4b 100644 --- a/docs/docs/game-support/games/arcaea-Touch.md +++ b/docs/docs/game-support/games/arcaea-Touch.md @@ -32,7 +32,7 @@ For more information on what metrics are and how they work, see [TODO]! ## Judgements -The folowing judgements are defined: +The following judgements are defined: - `pure` - `far` @@ -83,4 +83,4 @@ The folowing judgements are defined: - `inGameStrID` - `songTitle` -- `tachiSongID` \ No newline at end of file +- `tachiSongID` diff --git a/docs/docs/game-support/games/bms-14K.md b/docs/docs/game-support/games/bms-14K.md index b4a0c7944..bfb2226d7 100644 --- a/docs/docs/game-support/games/bms-14K.md +++ b/docs/docs/game-support/games/bms-14K.md @@ -92,4 +92,4 @@ This game has no versions, and presumably doesn't need to disambiguate its IDs. ## Supported Match Types - `bmsChartHash` -- `tachiSongID` \ No newline at end of file +- `tachiSongID` diff --git a/docs/docs/game-support/games/bms-7K.md b/docs/docs/game-support/games/bms-7K.md index 06d03348a..90bfbee0b 100644 --- a/docs/docs/game-support/games/bms-7K.md +++ b/docs/docs/game-support/games/bms-7K.md @@ -46,7 +46,7 @@ For more information on what metrics are and how they work, see [TODO]! ## Judgements -The folowing judgements are defined: +The following judgements are defined: - `pgreat` - `great` @@ -95,4 +95,4 @@ This game has no versions, and presumably doesn't need to disambiguate its IDs. ## Supported Match Types - `bmsChartHash` -- `tachiSongID` \ No newline at end of file +- `tachiSongID` diff --git a/docs/docs/game-support/games/chunithm-Single.md b/docs/docs/game-support/games/chunithm-Single.md index 286510e9b..3317ae71e 100644 --- a/docs/docs/game-support/games/chunithm-Single.md +++ b/docs/docs/game-support/games/chunithm-Single.md @@ -32,7 +32,7 @@ For more information on what metrics are and how they work, see [TODO]! ## Judgements -The folowing judgements are defined: +The following judgements are defined: - `jcrit` - `justice` @@ -94,4 +94,4 @@ The folowing judgements are defined: - `inGameID` - `songTitle` -- `tachiSongID` \ No newline at end of file +- `tachiSongID` diff --git a/docs/docs/game-support/games/ddr-DP.md b/docs/docs/game-support/games/ddr-DP.md index f140f8281..6ac4c8836 100644 --- a/docs/docs/game-support/games/ddr-DP.md +++ b/docs/docs/game-support/games/ddr-DP.md @@ -30,7 +30,7 @@ For more information on what metrics are and how they work, see [TODO]! ## Judgements -The folowing judgements are defined: +The following judgements are defined: - `MARVELOUS` - `PERFECT` diff --git a/docs/docs/game-support/games/ddr-SP.md b/docs/docs/game-support/games/ddr-SP.md index 4ebb3fa79..c3b4dbb37 100644 --- a/docs/docs/game-support/games/ddr-SP.md +++ b/docs/docs/game-support/games/ddr-SP.md @@ -30,7 +30,7 @@ For more information on what metrics are and how they work, see [TODO]! ## Judgements -The folowing judgements are defined: +The following judgements are defined: - `MARVELOUS` - `PERFECT` diff --git a/docs/docs/game-support/games/gitadora-Dora.md b/docs/docs/game-support/games/gitadora-Dora.md index b43afbff5..b06b6a565 100644 --- a/docs/docs/game-support/games/gitadora-Dora.md +++ b/docs/docs/game-support/games/gitadora-Dora.md @@ -32,7 +32,7 @@ For more information on what metrics are and how they work, see [TODO]! ## Judgements -The folowing judgements are defined: +The following judgements are defined: - `perfect` - `great` @@ -83,4 +83,4 @@ The folowing judgements are defined: - `inGameID` - `songTitle` -- `tachiSongID` \ No newline at end of file +- `tachiSongID` diff --git a/docs/docs/game-support/games/gitadora-Gita.md b/docs/docs/game-support/games/gitadora-Gita.md index d78dc6a08..78411987f 100644 --- a/docs/docs/game-support/games/gitadora-Gita.md +++ b/docs/docs/game-support/games/gitadora-Gita.md @@ -32,7 +32,7 @@ For more information on what metrics are and how they work, see [TODO]! ## Judgements -The folowing judgements are defined: +The following judgements are defined: - `perfect` - `great` @@ -87,4 +87,4 @@ The folowing judgements are defined: - `inGameID` - `songTitle` -- `tachiSongID` \ No newline at end of file +- `tachiSongID` diff --git a/docs/docs/game-support/games/iidx-DP.md b/docs/docs/game-support/games/iidx-DP.md index 548e68580..f16b02605 100644 --- a/docs/docs/game-support/games/iidx-DP.md +++ b/docs/docs/game-support/games/iidx-DP.md @@ -42,7 +42,7 @@ For more information on what metrics are and how they work, see [TODO]! ## Judgements -The folowing judgements are defined: +The following judgements are defined: - `pgreat` - `great` @@ -148,4 +148,4 @@ The default rating algorithm is `ktLampRating`. - `inGameID` - `tachiSongID` -- `songTitle` \ No newline at end of file +- `songTitle` diff --git a/docs/docs/game-support/games/iidx-SP.md b/docs/docs/game-support/games/iidx-SP.md index 862538287..decac968d 100644 --- a/docs/docs/game-support/games/iidx-SP.md +++ b/docs/docs/game-support/games/iidx-SP.md @@ -42,7 +42,7 @@ For more information on what metrics are and how they work, see [TODO]! ## Judgements -The folowing judgements are defined: +The following judgements are defined: - `pgreat` - `great` @@ -148,4 +148,4 @@ The default rating algorithm is `ktLampRating`. - `inGameID` - `tachiSongID` -- `songTitle` \ No newline at end of file +- `songTitle` diff --git a/docs/docs/game-support/games/itg-Stamina.md b/docs/docs/game-support/games/itg-Stamina.md index e1fd3e0a5..6e96ed2fb 100644 --- a/docs/docs/game-support/games/itg-Stamina.md +++ b/docs/docs/game-support/games/itg-Stamina.md @@ -32,7 +32,7 @@ For more information on what metrics are and how they work, see [TODO]! ## Judgements -The folowing judgements are defined: +The following judgements are defined: - `fantastic+` - `fantastic` @@ -83,4 +83,4 @@ This game has no versions, and presumably doesn't need to disambiguate its IDs. ## Supported Match Types -- `itgChartHash` \ No newline at end of file +- `itgChartHash` diff --git a/docs/docs/game-support/games/jubeat-Single.md b/docs/docs/game-support/games/jubeat-Single.md index 31c1cdd1b..c1283f3ca 100644 --- a/docs/docs/game-support/games/jubeat-Single.md +++ b/docs/docs/game-support/games/jubeat-Single.md @@ -34,7 +34,7 @@ For more information on what metrics are and how they work, see [TODO]! ## Judgements -The folowing judgements are defined: +The following judgements are defined: - `perfect` - `great` @@ -99,4 +99,4 @@ The default rating algorithm is `jubility`. ## Supported Match Types - `inGameID` -- `tachiSongID` \ No newline at end of file +- `tachiSongID` diff --git a/docs/docs/game-support/games/maimai-Single.md b/docs/docs/game-support/games/maimai-Single.md index 35e2df8be..0955ad033 100644 --- a/docs/docs/game-support/games/maimai-Single.md +++ b/docs/docs/game-support/games/maimai-Single.md @@ -32,7 +32,7 @@ For more information on what metrics are and how they work, see [TODO]! ## Judgements -The folowing judgements are defined: +The following judgements are defined: - `perfect` - `great` @@ -86,4 +86,4 @@ The folowing judgements are defined: - `songTitle` - `tachiSongID` - `inGameID` -- `inGameStrID` \ No newline at end of file +- `inGameStrID` diff --git a/docs/docs/game-support/games/maimaidx-Single.md b/docs/docs/game-support/games/maimaidx-Single.md index bb08d9e3a..20d2a6b24 100644 --- a/docs/docs/game-support/games/maimaidx-Single.md +++ b/docs/docs/game-support/games/maimaidx-Single.md @@ -32,7 +32,7 @@ For more information on what metrics are and how they work, see [TODO]! ## Judgements -The folowing judgements are defined: +The following judgements are defined: - `pcrit` - `perfect` @@ -93,4 +93,4 @@ The folowing judgements are defined: ## Supported Match Types - `songTitle` -- `tachiSongID` \ No newline at end of file +- `tachiSongID` diff --git a/docs/docs/game-support/games/museca-Single.md b/docs/docs/game-support/games/museca-Single.md index d91a41d5a..53aaf81a2 100644 --- a/docs/docs/game-support/games/museca-Single.md +++ b/docs/docs/game-support/games/museca-Single.md @@ -32,7 +32,7 @@ For more information on what metrics are and how they work, see [TODO]! ## Judgements -The folowing judgements are defined: +The following judgements are defined: - `critical` - `near` @@ -80,4 +80,4 @@ The folowing judgements are defined: - `songTitle` - `tachiSongID` -- `inGameID` \ No newline at end of file +- `inGameID` diff --git a/docs/docs/game-support/games/ongeki-Single.md b/docs/docs/game-support/games/ongeki-Single.md index f96833a84..3ae89bcf2 100644 --- a/docs/docs/game-support/games/ongeki-Single.md +++ b/docs/docs/game-support/games/ongeki-Single.md @@ -37,7 +37,7 @@ For more information on what metrics are and how they work, see [TODO]! ## Judgements -The folowing judgements are defined: +The following judgements are defined: - `cbreak` - `break` @@ -91,8 +91,8 @@ The folowing judgements are defined: - `tachiSongID` - `inGameID` -### Song Title matching +### Song Title Matching There are numerous songs with non-unique names (e.g. Singularity, Singularity and Singularity), but this can be resolved by providing the `artist` field. The only exception is Perfect Shining, which uniquely has two LUNATIC charts and has to be matched by `inGameID`: - LUNATIC 0 (Loctest chart) `inGameID: 8003` -- LUNATIC 13+ (Re:Master) `inGameID: 8091` \ No newline at end of file +- LUNATIC 13+ (Re:Master) `inGameID: 8091` diff --git a/docs/docs/game-support/games/pms-Controller.md b/docs/docs/game-support/games/pms-Controller.md index 0d90fbee3..2ede26fbe 100644 --- a/docs/docs/game-support/games/pms-Controller.md +++ b/docs/docs/game-support/games/pms-Controller.md @@ -46,7 +46,7 @@ For more information on what metrics are and how they work, see [TODO]! ## Judgements -The folowing judgements are defined: +The following judgements are defined: - `cool` - `great` @@ -91,4 +91,4 @@ This game has no versions, and presumably doesn't need to disambiguate its IDs. ## Supported Match Types - `bmsChartHash` -- `tachiSongID` \ No newline at end of file +- `tachiSongID` diff --git a/docs/docs/game-support/games/pms-Keyboard.md b/docs/docs/game-support/games/pms-Keyboard.md index 5c93b4c85..b4052466f 100644 --- a/docs/docs/game-support/games/pms-Keyboard.md +++ b/docs/docs/game-support/games/pms-Keyboard.md @@ -46,7 +46,7 @@ For more information on what metrics are and how they work, see [TODO]! ## Judgements -The folowing judgements are defined: +The following judgements are defined: - `cool` - `great` @@ -91,4 +91,4 @@ This game has no versions, and presumably doesn't need to disambiguate its IDs. ## Supported Match Types - `bmsChartHash` -- `tachiSongID` \ No newline at end of file +- `tachiSongID` diff --git a/docs/docs/game-support/games/popn-9B.md b/docs/docs/game-support/games/popn-9B.md index 58298c27c..66d6bea80 100644 --- a/docs/docs/game-support/games/popn-9B.md +++ b/docs/docs/game-support/games/popn-9B.md @@ -34,7 +34,7 @@ For more information on what metrics are and how they work, see [TODO]! ## Judgements -The folowing judgements are defined: +The following judgements are defined: - `cool` - `great` @@ -85,4 +85,4 @@ The folowing judgements are defined: - `inGameID` - `tachiSongID` -- `popnChartHash` \ No newline at end of file +- `popnChartHash` diff --git a/docs/docs/game-support/games/sdvx-Single.md b/docs/docs/game-support/games/sdvx-Single.md index 00904b347..154bb6f59 100644 --- a/docs/docs/game-support/games/sdvx-Single.md +++ b/docs/docs/game-support/games/sdvx-Single.md @@ -34,7 +34,7 @@ For more information on what metrics are and how they work, see [TODO]! ## Judgements -The folowing judgements are defined: +The following judgements are defined: - `critical` - `near` @@ -95,4 +95,4 @@ The folowing judgements are defined: - `sdvxInGameID` - `songTitle` -- `tachiSongID` \ No newline at end of file +- `tachiSongID` diff --git a/docs/docs/game-support/games/usc-Controller.md b/docs/docs/game-support/games/usc-Controller.md index d297b0124..f7d2b0d41 100644 --- a/docs/docs/game-support/games/usc-Controller.md +++ b/docs/docs/game-support/games/usc-Controller.md @@ -33,7 +33,7 @@ For more information on what metrics are and how they work, see [TODO]! ## Judgements -The folowing judgements are defined: +The following judgements are defined: - `critical` - `near` @@ -79,4 +79,4 @@ This game has no versions, and presumably doesn't need to disambiguate its IDs. ## Supported Match Types - `uscChartHash` -- `tachiSongID` \ No newline at end of file +- `tachiSongID` diff --git a/docs/docs/game-support/games/usc-Keyboard.md b/docs/docs/game-support/games/usc-Keyboard.md index de5a7a7d1..dab5c609f 100644 --- a/docs/docs/game-support/games/usc-Keyboard.md +++ b/docs/docs/game-support/games/usc-Keyboard.md @@ -33,7 +33,7 @@ For more information on what metrics are and how they work, see [TODO]! ## Judgements -The folowing judgements are defined: +The following judgements are defined: - `critical` - `near` @@ -79,4 +79,4 @@ This game has no versions, and presumably doesn't need to disambiguate its IDs. ## Supported Match Types - `uscChartHash` -- `tachiSongID` \ No newline at end of file +- `tachiSongID` diff --git a/docs/docs/game-support/games/wacca-Single.md b/docs/docs/game-support/games/wacca-Single.md index 0375e6d91..69927ab37 100644 --- a/docs/docs/game-support/games/wacca-Single.md +++ b/docs/docs/game-support/games/wacca-Single.md @@ -82,4 +82,4 @@ The folowing judgements are defined: ## Supported Match Types - `songTitle` -- `tachiSongID` \ No newline at end of file +- `tachiSongID` diff --git a/docs/docs/game-support/seeds.md b/docs/docs/game-support/seeds.md index 0901270d2..7f9557f3a 100644 --- a/docs/docs/game-support/seeds.md +++ b/docs/docs/game-support/seeds.md @@ -87,7 +87,7 @@ A chart in Tachi looks like this: ## Tables and Folders -You'll probably want to create atleast one table and some folders for your game. +You'll probably want to create at least one table and some folders for your game. There are various utilities for this, like `scripts/rerunners/add-level-version-folders.js` for creating a traditional "Level 1, Level 2, Level 3" kind of table. @@ -95,4 +95,4 @@ There are various utilities for this, like `scripts/rerunners/add-level-version- Once you've modified the database seeds, test them with `pnpm test` inside the `seeds/scripts` folder. This will check a bunch of properties about the songs and charts you just made. -If they fail, read why and make appropriate changes. If they pass, move to the root of the Tachi repository and run `pnpm sync-database-local`. This will load the changes into your MongoDB instance. \ No newline at end of file +If they fail, read why and make appropriate changes. If they pass, move to the root of the Tachi repository and run `pnpm sync-database-local`. This will load the changes into your MongoDB instance. diff --git a/docs/docs/game-support/server-impl.md b/docs/docs/game-support/server-impl.md index 40707157e..20587f606 100644 --- a/docs/docs/game-support/server-impl.md +++ b/docs/docs/game-support/server-impl.md @@ -139,7 +139,7 @@ However, this is often not the case, and there are certain things you expect to between the metrics of a score. For example, you shouldn't be able to submit a `PERFECT ULTIMATE CHAIN` if your score -isn't 10 million - the two imply eachother! +isn't 10 million - the two imply each other! In this part of the server implementation, you may specify as many validation functions as you like. These assert relations between the fields on a score, and allow you @@ -149,4 +149,4 @@ Like real life, passing judgements subjects you to more scrutiny -- getting a `F ## That's it! -The only thing left is to define the [Client Implementation](./client-impl.md)! \ No newline at end of file +The only thing left is to define the [Client Implementation](./client-impl.md)! diff --git a/docs/docs/index.md b/docs/docs/index.md index 812d4f346..04a29c2f2 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -66,6 +66,6 @@ View it [here](./codebase). ## Acknowledgements -This documentation is built ontop of the beautiful [Material MKDocs](https://squidfunk.github.io/mkdocs-material) theme. +This documentation is built on top of the beautiful [Material MKDocs](https://squidfunk.github.io/mkdocs-material) theme. ---8<-- "includes/abbreviations.md" \ No newline at end of file +--8<-- "includes/abbreviations.md" diff --git a/docs/docs/wiki/filter-directives.md b/docs/docs/wiki/filter-directives.md index f6f10bf79..e7c0f7af7 100644 --- a/docs/docs/wiki/filter-directives.md +++ b/docs/docs/wiki/filter-directives.md @@ -91,4 +91,3 @@ space inside a value, you should quote it, like this: `artist="A Tribe Called \"Quest\"" percent>50` However, it is likely you will never need to use this. - diff --git a/docs/docs/wiki/games.md b/docs/docs/wiki/games.md index febfe9abe..c62277bf4 100644 --- a/docs/docs/wiki/games.md +++ b/docs/docs/wiki/games.md @@ -63,7 +63,5 @@ The following games are supported on [Bokutachi](https://boku.tachi.ac). | PMS | `pms` | `Controller`, `Keyboard`[^2] | | unnamed_sdvx_clone | `usc` | `Controller` `Keyboard`[^2] | - - [^1]: Pop'n *had* some other playtypes, namely a 5-Button mode, but it seems to be removed now. 9B is used instead of single here for futureproofing. [^2]: This use of playtypes is a small hack to make separate leaderboards for keyboard and controller players. The split is necessary because the two input mechanisms are *very* different at high levels, but there are still a lot of keyboard players. It's a compromise! \ No newline at end of file diff --git a/docs/docs/wiki/index.md b/docs/docs/wiki/index.md index b74f9c10a..4f8dd2c23 100644 --- a/docs/docs/wiki/index.md +++ b/docs/docs/wiki/index.md @@ -65,4 +65,4 @@ The rules can be found [here](./rules.md). Please reach out on discord or [GitHub Issues](https://github.com/zkrising/Tachi)! ---8<-- "includes/abbreviations.md" \ No newline at end of file +--8<-- "includes/abbreviations.md" diff --git a/docs/docs/wiki/rules.md b/docs/docs/wiki/rules.md index 162fe599c..101b375e4 100644 --- a/docs/docs/wiki/rules.md +++ b/docs/docs/wiki/rules.md @@ -84,7 +84,7 @@ Similarly, try and keep session names and about me's and whatnot appropriate. In general, just don't be an ass. -## R4: Use Common Sense. +## R5: Use Common Sense. This list of rules isn't exhaustive, and staff reserve the right to ban you at any time for any reason. You should use diff --git a/docs/docs/wiki/score-oddities.md b/docs/docs/wiki/score-oddities.md index 424007a84..b392a36ca 100644 --- a/docs/docs/wiki/score-oddities.md +++ b/docs/docs/wiki/score-oddities.md @@ -87,4 +87,4 @@ You can't check the score timestamp. Games like LR2 do not store timestamps, gam Similarly, scores are sometimes duplicated across services -- someone might import their FLO scores to EAG using their integration. Those timestamps also get clobbered. -It is safer to be right all the time on deduplication and sacrifice this case. \ No newline at end of file +It is safer to be right all the time on deduplication and sacrifice this case.