diff --git a/site/content/help/_index.md b/site/content/help/_index.md new file mode 100644 index 0000000..6f9ea79 --- /dev/null +++ b/site/content/help/_index.md @@ -0,0 +1,7 @@ ++++ +title = "Help" ++++ + +User documentation on how to use Citra 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/feature/custom-textures/index.md b/site/content/help/feature/custom-textures/index.md new file mode 100644 index 0000000..c4bdf3d --- /dev/null +++ b/site/content/help/feature/custom-textures/index.md @@ -0,0 +1,23 @@ ++++ +title = "Custom Textures" +description = "Custom texture features for displaying custom graphics packs." ++++ + +**Note: This feature is currently still WIP (Work-in-progress)!** + +Texture dumping and replacement have been implemented for Citra, by [**Khang06**](https://github.com/khang06).
+For more details, see [**PR #4868**](https://github.com/citra-emu/citra/pull/4868). + +## Instructions for dumping textures + +* Open `Emulation > Configure...` in Citra's menu and go to `Graphics > Enhancements`. +* Enable **`Dump textures`** and click **`OK`**. +* Now open a game of your choice, and start playing. As you keep playing, the textures used by the game will be dumped as **`.PNG`** files. + - Right-click on your game in the games list and select **`Open Texture Dump Location`** to open the dump folder. + +## Instructions for replacing textures + +* Right-click on your game in the games list and select **`Open Custom Texture Location`** to open the folder where custom textures will be loaded from. +* Place your custom texture **`.PNG`** files in the folder. +* In `Emulation > Configure... > Graphics > Enhancements`, enable **`Use Custom Textures`** and click **`OK`**. + - Additionally, if you want your custom textures to be pre-loaded to RAM, enable **`Preload Custom Textures`** as well. This will help improve the performance but will also increase memory usage. diff --git a/site/content/help/feature/telemetry.md b/site/content/help/feature/telemetry.md new file mode 100644 index 0000000..4ba0a61 --- /dev/null +++ b/site/content/help/feature/telemetry.md @@ -0,0 +1,45 @@ ++++ +title = "Telemetry" +description = "Telemetry features" ++++ + +Citra has some [issues](https://github.com/citra-emu/citra/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/citra-emu/citra/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 Citra team has put together a framework to report data about +how Citra 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 Citra +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 Citra you are using + * Performance data for the games you play + * Your Citra 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 Citra. diff --git a/site/content/help/reference/asking.md b/site/content/help/reference/asking.md new file mode 100644 index 0000000..fe10347 --- /dev/null +++ b/site/content/help/reference/asking.md @@ -0,0 +1,22 @@ +--- +title: Asking for Help +description: "How to properly ask in our forums or support channel for assistance." +--- + +### Before starting your support request: +* **Check if the problem is already reported in our [game compatibility list](https://citra-emu.org/game/)** Someone may be experiencing the same issue as you, or specific settings may be required for the game you are attempting to play. +* **Reset your config file to defaults** This can resolve many common misconfiguration issues. This can be done by going to Configuration menu, General tab, and selecting "Reset All Settings" +* **Make sure you're using the latest Citra Canary build.** We don't provide support for older builds. Make sure you're using the latest Canary build available, as we always pour new improvements into them. +* **Check if your drivers are up-to-date.** Many issues are simply solved by updating your drivers, mainly GPU. Always make sure your GPU drivers are up-to-date before proceeding. Just using the Windows builtin updater usually is not enough! Always install your GPU drivers through your GPU vendor's website. + * Intel: [Automatically update your drivers](https://downloadcenter.intel.com/product/80939/Graphics-Drivers) + * NVIDIA: [Automatic Driver Updates](https://www.geforce.com/drivers) + * ATI: [Auto-Detect and Install Radeon Graphics Drivers for Windows](https://www.amd.com/en/support) +* **Check if your System matches Citra's minimum requirements.** Assuming your system runs it because it runs other emulators is not enough. Many people simply ignore this step thinking their system matches the minimum requirements and end up wasting their time trying to get it to work. + +### Submitting your support request: +* Choose a place to ask for support: + * **Discord:** Go to the [**#citra-support channel on our Discord Server**](https://citra-emu.org/discord/) and submit a message describing your issue alongside uploading your log file. Remember to read the #welcome channel for instructions on how to join the server. + * **Forums:** Go to the [**Support section of our forums**](https://community.citra-emu.org/c/citra-support) and start a new thread or post in an existing one if it discusses the same problem you're experiencing, attaching or uploading your log file. +* **Don't forget to upload the file containing the log.** +* Include screenshots if you believe they help clarifying your problem. Upload them as attachments to the post or upload them to image sharing websites like [**Imgur**](http://imgur.com/) and link them on your request. +* Provide basic system information. CPU, GPU, OS, RAM and GPU Drivers' version are usually enough. \ No newline at end of file diff --git a/site/themes/citra-bs-theme/layouts/_default/baseof.html b/site/themes/citra-bs-theme/layouts/_default/baseof.html index 8a783f1..97466b5 100755 --- a/site/themes/citra-bs-theme/layouts/_default/baseof.html +++ b/site/themes/citra-bs-theme/layouts/_default/baseof.html @@ -78,8 +78,9 @@

Documentation

+ Help Documents Compatibility - Wiki + Dev Wiki FAQ
diff --git a/site/themes/citra-bs-theme/layouts/_default/list.html b/site/themes/citra-bs-theme/layouts/_default/list.html index 6b26975..e2bcf0e 100755 --- a/site/themes/citra-bs-theme/layouts/_default/list.html +++ b/site/themes/citra-bs-theme/layouts/_default/list.html @@ -1,4 +1,7 @@ {{ define "main" }} +

{{ .Title }}

+ {{ .Content }} + {{ $paginator := .Paginate .Data.Pages }} {{ range $paginator.Pages }} diff --git a/site/themes/citra-bs-theme/layouts/partials/menu.html b/site/themes/citra-bs-theme/layouts/partials/menu.html index 688757d..c13ca93 100644 --- a/site/themes/citra-bs-theme/layouts/partials/menu.html +++ b/site/themes/citra-bs-theme/layouts/partials/menu.html @@ -15,11 +15,12 @@
  • Patreon
    • +
  • Patreon