Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added a few help-pages #169

Merged
merged 2 commits into from
Nov 20, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added src/img/screenshots/SettingsAPIsAPIKeysDark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/img/screenshots/SettingsAPIsAPIKeysLight.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/img/screenshots/SettingsExternalToolsDark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/img/screenshots/SettingsLanguegeDark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/img/screenshots/SettingsLanguegeLight.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/img/screenshots/SettingsMinecraftDark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/img/screenshots/SettingsMinecraftLight.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/img/screenshots/SettingsProxyDark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/img/screenshots/SettingsProxyLight.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
59 changes: 59 additions & 0 deletions src/wiki/help-pages/APIs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
eleventyNavigation:
key: APIs
parent: Help pages
---

## Services

<div class="row">
<div class="column">
{% image "Features tab under Launcher tab in settings", "./src/img/screenshots/SettingsAPIsServicesLight.png", "./src/img/screenshots/SettingsAPIsServicesDark.png" %}
</div>
</div>

### Pastebin Service

<!-- TODO: add image of Pastebin Service section -->

This is where you can choose which Paste Service to use.

### Metadata Server

<!-- TODO: add image of Metadata Server section -->

This is where you can set where the launcher gets it metadata.

## API Keys

<div class="row">
<div class="column">
{% image "User Interface tab under Launcher tab in settings", "./src/img/screenshots/SettingsAPIsAPIKeysLight.png", "./src/img/screenshots/SettingsAPIsAPIKeysDark.png" %}
</div>
</div>

### Microsoft Authentication

<!-- TODO: add image of Microsoft Authentication section -->

Set this if you want to use your own client ID for Microsoft Authentication.

### CurseForge Core API

<!-- TODO: add image of CurseForge Core API section -->

Set this if you want to use your own CurseForge API key.

## Miscellaneous

<div class="row">
<div class="column">
{% image "Console tab under Launcher tab in settings", "./src/img/screenshots/SettingsAPIsMiscellaneousLight.png", "./src/img/screenshots/SettingsAPIsMiscellaneousDark.png" %}
</div>
</div>

### User Agent

<!-- TODO: add image of User Agent section -->

Set this if you want to use a custom User Agent.
24 changes: 24 additions & 0 deletions src/wiki/help-pages/Custom-commands.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
eleventyNavigation:
key: Custom Commands
parent: Help pages
---

<div class="row">
<div class="column">
{% image "Mods tab under PrismLauncher settings", "./src/img/screenshots/SettingsCustomCommandsLight.png", "./src/img/screenshots/SettingsCustomCommandsDark.png" %}
</div>
</div>

Pre-launch command runs before the instance launches and post-exit command runs after it exits.

Both will be run in the launcher's working folder with extra environment variables:

* $INST_NAME - Name of the instance
* $INST_ID - ID of the instance (its folder name)
* $INST_DIR - absolute path of the instance
* $INST_MC_DIR - absolute path of Minecraft
* $INST_JAVA - Java binary used for launch
* $INST_JAVA_ARGS - command-line parameters used for launch (warning: will not work correctly if arguments contain spaces)

Wrapper command allows launching using an extra wrapper program (like 'optirun' on Linux)
13 changes: 13 additions & 0 deletions src/wiki/help-pages/Language-settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
eleventyNavigation:
key: Language Settings
parent: Help pages
---

<div class="row">
<div class="column">
{% image "Mods tab under PrismLauncher settings", "./src/img/screenshots/SettingsLanguegeLight.png", "./src/img/screenshots/SettingsLanguegeDark.png" %}
</div>
</div>

In this Page, you can select the language Prism Launcher should use.
77 changes: 77 additions & 0 deletions src/wiki/help-pages/Launcher-settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
eleventyNavigation:
key: Launcher Settings
parent: Help pages
---

## Features

<div class="row">
<div class="column">
{% image "Features tab under Launcher tab in settings", "./src/img/screenshots/SettingsLauncherFeaturesLight.png", "./src/img/screenshots/SettingsLauncherFeaturesDark.png" %}
</div>
</div>

### Folders

<!-- TODO: add image of folder section -->

This is where you can set the location for the Instances, Mods & Icons folders.

### Mods

<!-- TODO: add image of mods section -->

Disable the usage of metadata provided by Modrinth and CursForge for mods.

## User Interface

<div class="row">
<div class="column">
{% image "User Interface tab under Launcher tab in settings", "./src/img/screenshots/SettingsLauncherUserInterfaceLight.png", "./src/img/screenshots/SettingsLauncherUserInterfaceDark.png" %}
</div>
</div>

### Instance view sorting mode

<!-- TODO: add image of Instance view sorting mode section -->

How the instances should be sorted.

### Theme

<!-- TODO: add image of Theme section -->

This is where you can choose which Icon Theme, Color Theme or Background Cat you want.

### Tools

<!-- TODO: add image of Tools section -->

This is where you can choose if you want a menubar or toolbar.

## Console

<div class="row">
<div class="column">
{% image "Console tab under Launcher tab in settings", "./src/img/screenshots/SettingsLauncherConsoleLight.png", "./src/img/screenshots/SettingsLauncherConsoleDark.png" %}
</div>
</div>

### Console Settings

<!-- TODO: add image of Console Settings section -->

This is where you set when the log window should appear.

### History limit

<!-- TODO: add image of History limit section -->

This is where you set if you want to limit the log length and by how much.

### Console font

<!-- TODO: add image of Console font section -->

This is where you can change the font and font size of the log.
43 changes: 43 additions & 0 deletions src/wiki/help-pages/Minecraft-settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
eleventyNavigation:
key: Minecraft Settings
parent: Help pages
---

<div class="row">
<div class="column">
{% image "Mods tab under PrismLauncher settings", "./src/img/screenshots/SettingsMinecraftLight.png", "./src/img/screenshots/SettingsMinecraftDark.png" %}
</div>
</div>

### Window Size

<!-- TODO: add image of Window Size section -->

This is where you set the Window size and if it should be maximized*.

*Only works on 1.5.2 and older

### Native library workarounds

<!-- TODO: add image of Native library workarounds section -->

Enable the usage of system libraries instead of the included ones.

### Performance

<!-- TODO: add image of Performance section -->

Enable some external tools related to performance.

### Game time

<!-- TODO: add image of Game time section -->

Set if you want to record play time and which to show.

### Miscellaneous

<!-- TODO: add image of Miscellaneous section -->

Set when you want to close or quit the launcher.
29 changes: 29 additions & 0 deletions src/wiki/help-pages/Proxy-settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
eleventyNavigation:
key: Proxy Settings
parent: Help pages
---

<div class="row">
<div class="column">
{% image "Mods tab under PrismLauncher settings", "./src/img/screenshots/SettingsProxyLight.png", "./src/img/screenshots/SettingsProxyDark.png" %}
</div>
</div>

### Type

<!-- TODO: add image of Type section -->

This is where you choose if and what type of proxy you want to use.

### Address and Port

<!-- TODO: add image of Address and Port section -->

This is where you can set the Address and Port of your proxy server.

### Authentication

<!-- TODO: add image of Authentication section -->

This is where you fill in the login details of your proxy.
37 changes: 37 additions & 0 deletions src/wiki/help-pages/Tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
eleventyNavigation:
key: External Tools
parent: Help pages
---

<div class="row">
<div class="column">
{% image "Mods tab under PrismLauncher settings", "./src/img/screenshots/SettingsExternalToolsLight.png", "./src/img/screenshots/SettingsExternalToolsDark.png" %}
</div>
</div>

<!-- TODO: add description of what each tool does -->

### JProfiler

<!-- TODO: add image of JProfiler section -->

This is where you set to path to your JProfiler executable.

### JVisualVM

<!-- TODO: add image of JVisualVM section -->

This is where you set to path to your JVisualVM executable.

### MCEdit

<!-- TODO: add image of MCEdit section -->

This is where you set to path to your MCEdit executable.

### External Editors

<!-- TODO: add image of External Editors section -->

This is where you set to path to your text editor of choice or leave it blank to use the systems default one.