From a6765f61e04a8ba9605bcf903c6512f16f8c47a8 Mon Sep 17 00:00:00 2001 From: "chris062689@gmail.com" Date: Mon, 1 Oct 2018 21:20:37 -0400 Subject: [PATCH] Added help section. --- site/content/help/_index.md | 7 ++ site/content/help/features/telemetry.md | 45 ++++++++++ site/content/help/reference/error-codes.md | 95 ++++++++++++++++++++++ site/themes/shared-bulma-theme | 2 +- 4 files changed, 148 insertions(+), 1 deletion(-) create mode 100644 site/content/help/_index.md create mode 100644 site/content/help/features/telemetry.md create mode 100644 site/content/help/reference/error-codes.md diff --git a/site/content/help/_index.md b/site/content/help/_index.md new file mode 100644 index 00000000..ac4f37dd --- /dev/null +++ b/site/content/help/_index.md @@ -0,0 +1,7 @@ ++++ +title = "Help" ++++ + +User documentation on how to use yuzu and frequently asked questions can be found here. + +If you would like more information on a subject, please contact our moderation team on Discord. diff --git a/site/content/help/features/telemetry.md b/site/content/help/features/telemetry.md new file mode 100644 index 00000000..0bc8c481 --- /dev/null +++ b/site/content/help/features/telemetry.md @@ -0,0 +1,45 @@ ++++ +title = "Telemetry" +description = "Telemetry features" ++++ + +yuzu has some [issues](https://github.com/yuzu-emu/yuzu/issues), and by its +nature as an open source project, they are visible to everyone and fixable by +anyone. Unfortunately though, most contributions are made by +[a small minority of developers](https://github.com/yuzu-emu/yuzu/graphs/contributors). +These developers have found it difficult to prioritize their efforts, since the +majority of issue reports are written scattered across Discord, Reddit, forums, +IRC, and too many other places to count. + +Because of this, the yuzu team has put together a framework to report data about +how yuzu is used to our server, and use that data to discover what are the most +popular games and hardware configurations, where emulated games crash in yuzu +most often, and more. We had considered including this in last month's progress +report, but we decided that it would be best to publish this on its own, so it +gets the attention it deserves. We're very aware that privacy is important to +many of our users, and so from the earliest planning stage we knew we must be as +transparent and open about this as possible. + +The telemetry framework will collect information such as: + + * Information about the version of yuzu you are using + * Performance data for the games you play + * Your yuzu configuration settings + * Information about your computer hardware (e.g. GPU, CPU, and OS type) + * Emulation errors and crash information + +Not everyone is comfortable sharing information about their system, so we've made it easy to opt-out. + +You may have also noticed the field titled "Telemetry ID" in the screenshots, this +is an identifier generated randomly on install which is used instead of your IP +address. This makes data collection entirely anonymous, unless you choose to log in. +You can also reset your telemetry ID if you'd like by clicking "Regenerate". The +new ID will also be completely random, and so it would be treated as a wholly new +identity. + +Telemetry is an extremely useful developer tool, as they allow the developer to +be more aware of the users' needs and priorities accurately, rather than guessing. +But it is only as useful as the data obtained, which is why we urge users to not +opt-out, so the data can be as accurate and correct as possible. Just as innacurate +measurements can damage a device during calibration, innacurate statistical data +will only cause damage to yuzu. diff --git a/site/content/help/reference/error-codes.md b/site/content/help/reference/error-codes.md new file mode 100644 index 00000000..43aea9be --- /dev/null +++ b/site/content/help/reference/error-codes.md @@ -0,0 +1,95 @@ +--- +title: Error Codes Reference Document +description: "A list of common error codes and how to resolve them." +categories: + - References +--- + +#### To use this list, press Ctrl-F and then type in the error code from yuzu. This should look similar to `XXXX-XXXX` where the Xs represent numbers and letters. + +#### Key Errors +##### Please use the general how-to guide, which includes instructions on dumping the necessary files from your switch to have yuzu derive all of your keys, +##### For all: If you try to run recent games and you haven't done the key derivation process recently, you may need to redump and rerun it as newer games use newer keys only available on newer firmwares. Getting an incorrect key means you might have a bad dump of your switch's files. Try again and if it persists, contact the discord. If you are missing the titlekey or an update won't load, sometimes updates change the titlekey between versions -- either way redump and if that doesn't work contact the discord/devs. +| Error Code | Name | +| ---------- | ---- | +| `0008-000C` | `ErrorMissingProductionKeyFile` | +| `0008-000D` | `ErrorMissingHeaderKey` | +| `0008-000E` | `ErrorIncorrectHeaderKey` | +| `0008-0011` | `ErrorMissingTitlekey` | +| `0008-0012` | `ErrorMissingTitlekek` | +| `0008-0014` | `ErrorMissingKeyAreaKey` | +| `0008-0015` | `ErrorIncorrectKeyAreaKey` | +| `0008-0016` | `ErrorIncorrectTitlekeyOrTitlekek` | +| `0008-0018` | `ErrorNCANotProgram` | + +#### Other Common Errors +| Error Code | Name | +| ---------- | ---- | +| `0008-001C` | `ErrorNullFile`
The file your are trying to use is empty and contains no data. This is a sign of a bad copy or corrupt storage device. | +| `0008-001D` | `ErrorMissingNPDM`
Ensure that your rom directory has a file called `main.npdm`. This is used to determine key info about how to run the game and is required to run. You may need to redump if you deleted this. | +| `0008-001E` | `Error32BitISA`
The game you are trying to run uses the 32-bit ARM architecture, which is not currently supported by yuzu. | +| `0008-0029` | `ErrorNAXInconvertibleToNCA`
The NAX file you are trying to run is not a game but in fact a save file. Double check your files. | +| `0008-002A` | `ErrorBadNAXFilePath`
You can only execute games that are NAX encrypted if they are left in the original directory structure from the SD card (`registered/.nca/00`). The hex digits contain needed data to decrypt the game properly. | +| `0008-0039` | `ErrorMissingBKTRBaseRomFS`
You are trying to run a game update, which isn't possible. To use a game update, instead go to File > Install file to NAND... and select the update from that menu. After it's done, launch the base game and yuzu will apply the update. | + +#### Corruption Errors - All of these errors are indicative of a bad/corrupt dump. If there are no special instructions, try redumping. Should the error persist contact the devs/discord for help. +| Error Code | Name | +| ---------- | ---- | +| `0008-0004` | `ErrorBadNPDMHeader` | +| `0008-0005` | `ErrorBadACIDHeader` | +| `0008-0006` | `ErrorBadACIHeader` | +| `0008-0007` | `ErrorBadFileAccessControl` | +| `0008-0008` | `ErrorBadFileAccessHeader` | +| `0008-0009` | `ErrorBadPFSHeader` | +| `0008-000A` | `ErrorIncorrectPFSFileSize` | +| `0008-0013` | `ErrorInvalidRightsID` | +| `0008-0017` | `ErrorXCIMissingProgramNCA`
In some rare cases, this has been known to appear with missing keys. Try rederiving your keys and if that dosen't work contact the devs. | +| `0008-0019` | `ErrorNoExeFS` | +| `0008-001A` | `ErrorBadXCIHeader` | +| `0008-001B` | `ErrorXCIMissingPartition`
If you trimmed your XCI, it might have been done improperly. Try avoiding trimming. | +| `0008-001F` | `ErrorNoRomFS` | +| `0008-0020` | `ErrorIncorrectELFFileSize` | +| `0008-0021` | `ErrorLoadingNRO` | +| `0008-0022` | `ErrorNoIcon` | +| `0008-0023` | `ErrorNoControl` | +| `0008-0024` | `ErrorBadNAXHeader` | +| `0008-0025` | `ErrorIncorrectNAXFileSize` | +| `0008-0031` | `ErrorNSPMissingProgramNCA` | +| `0008-0032` | `ErrorBadBKTRHeader` | + +#### Less Common General Errors - You should not expect to see these unless you are doing more than just playing games +| Error Code | Name | +| ---------- | ---- | +| `0008-000F` | `ErrorNCA2`
The NCA you are attempting to load is using an older format that is not currently supported. If you would like support to be added, consider filing an issue. | +| `0008-0010` | `ErrorNCA0`
The NCA you are attempting to load is using an older format that is not currently supported. If you would like support to be added, consider filing an issue. | + +#### Less Common Key Errors - Below errors should not be obtained if using the normal key derivation process (which is highly encouraged for newcomers), but if you are not using it these errors will make sense to you. +| Error Code | Name | +| ---------- | ---- | +| `0008-002B` | `ErrorMissingSDSeed` | +| `0008-002C` | `ErrorMissingSDKEKSource` | +| `0008-002D` | `ErrorMissingAESKEKGenerationSource` | +| `0008-002E` | `ErrorMissingAESKeyGenerationSource` | +| `0008-002F` | `ErrorMissingSDSaveKeySource` | +| `0008-0030` | `ErrorMissingSDNCAKeySource` | + +#### Internal Errors - Should never be seen ever. Report to the devs immediately. +| Error Code | Name | +| ---------- | ---- | +| `0008-0000` | `Success` | +| `0008-0001` | `ErrorAlreadyLoaded` | +| `0008-0002` | `ErrorNotImplemented` | +| `0008-0003` | `ErrorNotInitialized` | +| `0008-0026` | `ErrorNAXKeyHMACFailed` | +| `0008-0027` | `ErrorNAXValidationHMACFailed` | +| `0008-0028` | `ErrorNAXKeyDerivationFailed` | +| `0008-0033` | `ErrorBKTRSubsectionNotAfterRelocation` | +| `0008-0034` | `ErrorBKTRSubsectionNotAtEnd` | +| `0008-0035` | `ErrorBadRelocationBlock` | +| `0008-0036` | `ErrorBadSubsectionBlock` | +| `0008-0037` | `ErrorBadRelocationBuckets` | +| `0008-0038` | `ErrorBadSubsectionBuckets` | + + + + diff --git a/site/themes/shared-bulma-theme b/site/themes/shared-bulma-theme index 43b3bce9..d7252947 160000 --- a/site/themes/shared-bulma-theme +++ b/site/themes/shared-bulma-theme @@ -1 +1 @@ -Subproject commit 43b3bce94c72f149564d99dba7082ca348643d4d +Subproject commit d7252947b11d5b66584b05c742f3623e7294631d