diff --git a/frontend/docs/client/ClientCommands.md b/frontend/docs/client/ClientCommands.md index d9df28589618..4d0a1feeaaff 100644 --- a/frontend/docs/client/ClientCommands.md +++ b/frontend/docs/client/ClientCommands.md @@ -24,22 +24,8 @@ description: List of all client commands. | /fontsize | Changes the font size of the UI (chat, dialogs etc.). Valid fontsize is -3 to 5. | | /ctd | This command was added in SA-MP 0.3.7 RC2. It enables client debugging of the player camera target. | | /rcon | More related to the server rather than the client. This command is used to execute RCON commands. RCON is the built-in admin system. RCON stands for [Remote Control](../server/ControllingServer#using-rcon). | -| /hudscalefix | This command was added in SA-MP 0.3.7 R3. Enables/disables the radar scale fix, so that the game's radar scales better in widescreen resolutions (i.e. no more 'egg of finding'). This sets the sa-mp.cfg 'nohudscale' option. | +| /hudscalefix | This command was added in SA-MP 0.3.7 R3. Enables/disables the radar scale fix, so that the game's radar scales better in widescreen resolutions (i.e. no more 'egg of finding'). This sets the sa-mp.cfg 'nohudscalefix' option. | ## File sa-mp.cfg -| Option | Description | -| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| pagesize | See /pagesize. | -| fpslimit | See /fpslimit. | -| disableheadmove | See /headmove. | -| timestamp | See /timestamp. | -| ime | This controls whether the chat window input supports Input Method text editing and language switching. 1 enables IME, 0 disables it. | -| audiomsgoff | See /audiomsg. | -| multicore | Toggle whether the SA-MP client uses multiple CPU cores when running. Default is 1 (DOES use multiple CPU cores). Set to 0 if you experience mouse problems. | -| directmode | This allows players with chat text drawing problems to use the slower direct-to-screen text rendering mode. 0 to disable, 1 to enable. | -| audioproxyoff | If this option is set to 1, and there is a proxy server set in your Windows Internet Options, the proxy will not be used when playing audio streams in SA-MP. | -| nonametagstatus | See /nametagstatus. | -| fontface | Allows you to change the font of chat, dialogs and the scoreboard. i.e. fontface="Comic Sans MS". Not officially supported, and may cause problems. | -| fontweight | This option toggles whether your chat font is bold or not. 0 = BOLD (default) and 1 = NORMAL. | -| nohudscale | This option was added in 0.3.7 R3. See /hudscalefix. | +For descriptions of all options in `sa-mp.cfg`, see the [`sa-mp.cfg` documentation](./sa-mp.cfg.md). diff --git a/frontend/docs/client/ClientOnLinux.md b/frontend/docs/client/ClientOnLinux.md index 74884133cb11..5bd5f0f09d2a 100644 --- a/frontend/docs/client/ClientOnLinux.md +++ b/frontend/docs/client/ClientOnLinux.md @@ -6,6 +6,122 @@ description: Guide on how to run the open.mp client on Linux. # Guide on how to run the open.mp client on Linux +The open.mp launcher can run on Linux in two ways: + +- **With its GUI**, under Proton. You get the full launcher with its server browser. It needs the Microsoft Edge WebView2 Runtime and a launcher version with Wine support. +- **From the command line**, under any Wine. It works with every launcher version and does not need WebView2, but you have no GUI: you connect to one server per command. + +Both start with the same prefix setup. After that, follow **only one** of the two options. + +## Set up the prefix + +The commands below use `~/Games/openmp` as the prefix and `~/Downloads` for downloads. Change the paths to match yours, and always use the **same prefix** in every step. Run them in bash or zsh. If your shell is fish, type `bash` first. + +:::tip + +The command-line route also works in a prefix made with Lutris or Bottles, if you already have one with GTA San Andreas and the launcher in it. In that case skip to [Option B](#option-b-command-line-only-any-wine). + +::: + +1. Install [umu-launcher](https://github.com/Open-Wine-Components/umu-launcher) from your distribution's packages (`umu-launcher` on Arch/CachyOS, Fedora and others) or from its releases page. It runs Windows programs through Proton without Steam. + +2. Set these variables in your terminal. Every command below uses them: + +``` +export WINEPREFIX="$HOME/Games/openmp" +export GAMEID=umu-omplauncher +export STORE=none +``` + +If you want a specific Proton, also set `PROTONPATH` to its folder, for example `export PROTONPATH="$HOME/.local/share/Steam/compatibilitytools.d/Proton-CachyOS Latest"`. Without it, umu-run downloads and uses GE-Proton. + +3. Create the prefix. The first run takes a while: + +``` +umu-run wineboot +``` + +4. Copy your GTA San Andreas folder into the prefix, for example to `~/Games/openmp/drive_c/Games/GTA San Andreas`. Copy the folder itself, not a symlink. + +5. Download the portable open.mp launcher, `omp-launcher.exe` from its [latest release](https://github.com/openmultiplayer/launcher/releases/latest), into the prefix. It runs without installing. Don't use `omp-launcher-setup.exe`, because the installer tries to install WebView2 by itself and fails inside the prefix. + +``` +mkdir -p "$WINEPREFIX/drive_c/Games/omp-launcher" +curl -fL https://github.com/openmultiplayer/launcher/releases/latest/download/omp-launcher.exe -o "$WINEPREFIX/drive_c/Games/omp-launcher/omp-launcher.exe" +``` + +The prefix is ready. Now follow **only one** of these, not both: + +- [Option A: Launcher GUI](#option-a-launcher-gui-proton) if you want the full launcher with its server browser. **Recommended.** +- [Option B: Command line only](#option-b-command-line-only-any-wine) if you only want to connect to a server by command. + +## Option A: Launcher GUI (Proton) + +:::warning + +The GUI needs **Proton**. Under stock Wine the launcher window stays white. + +::: + +### Tested on: + +- umu-launcher with Proton-CachyOS 11.0, WebView2 Runtime 156 +- SteamOS 3.9.5 on Steam Deck with GE-Proton through Lutris +- Fedora Silverblue 44 with GE-Proton through Lutris (UMU-Proton did not work in this setup) +- Arch Linux with KDE Plasma on Wayland, PipeWire, and Proton-CachyOS-SLR through the Steam copy of GTA:SA (downgraded to 1.0, running in SLR) + +:::note + +Got the GUI working on a different setup (another Proton or Wine build, Lutris, Bottles, Heroic, Steam, another desktop)? Please report it on the open.mp Discord or GitHub with your distribution, desktop, Wine or Proton version and WebView2 version, so it can be added to this list. + +::: + +### How to: + +1. Download the x86 WebView2 Runtime and install it into the prefix. The launcher's window is built on it: + +``` +curl -fL "https://go.microsoft.com/fwlink/p/?LinkId=2124701" -o ~/Downloads/MicrosoftEdgeWebView2RuntimeInstallerX86.exe +umu-run ~/Downloads/MicrosoftEdgeWebView2RuntimeInstallerX86.exe /silent /install +``` + +The installer runs without a window. If the terminal stops at `ntsync: up and running.`, the installer may still be running. Wait for the command to finish and the shell prompt to return before going on. + +2. Start the launcher with Xalia disabled for this launch: + +``` +PROTON_USE_XALIA=0 umu-run "$WINEPREFIX/drive_c/Games/omp-launcher/omp-launcher.exe" +``` + +On the first start it downloads the open.mp client files by itself. In its settings, set the game path to your GTA San Andreas folder (`C:\Games\GTA San Andreas` in the example), then pick a server and play. + +3. Add the launcher to your app menu, so you can start it like any other app from now on. Proton does not create menu entries by itself. Run this once, from the same terminal: + +``` +mkdir -p "$HOME/.local/share/applications" "$HOME/.local/share/icons" +curl -fL https://raw.githubusercontent.com/openmultiplayer/launcher/master/src-tauri/icons/128x128.png -o "$HOME/.local/share/icons/openmp-launcher.png" +PROTON_ENV=${PROTONPATH:+"\"PROTONPATH=$PROTONPATH\""} +cat > "$HOME/.local/share/applications/omp-launcher.desktop" < diff --git a/frontend/i18n/bs/docusaurus-plugin-content-docs/current/client/sa-mp.cfg.md b/frontend/i18n/bs/docusaurus-plugin-content-docs/current/client/sa-mp.cfg.md index 918ba6095c51..ca1cab2c285c 100644 --- a/frontend/i18n/bs/docusaurus-plugin-content-docs/current/client/sa-mp.cfg.md +++ b/frontend/i18n/bs/docusaurus-plugin-content-docs/current/client/sa-mp.cfg.md @@ -24,3 +24,4 @@ description: sa-mp konfiguracioni fajl klijenta. | **nonametagstatus** | Ako je ova opcija postavljena na 0, igrači će vidjeti ikonu pješčanog sata pored oznaka drugih igrača kada su pauzirani. Ovo je podrazumevano omogućeno (0). Ova opcija se može promijeniti u igri koristeći komandu na strani klijenta /nametagstatus. | | **fontface** | Omogućava vam da promijenite font razgovora, dijaloga i semafora. _tj. fontface="Comic Sans MS"_. Nije službeno podržano i može uzrokovati probleme. | | **fontweight** | Ova opcija mijenja da li je vaš font za chat podebljan ili ne. **0 = BOLD (zadano) i 1 = NORMALNO.** | +| **nohudscalefix** | Uključuje ili isključuje ispravku skale radara. Ova opcija se može mijenjati i u igri pomoću komande /hudscalefix. | diff --git a/frontend/i18n/de/docusaurus-plugin-content-docs/current/client/ClientCommands.md b/frontend/i18n/de/docusaurus-plugin-content-docs/current/client/ClientCommands.md index 25a5603ecf6a..742085c9dd45 100644 --- a/frontend/i18n/de/docusaurus-plugin-content-docs/current/client/ClientCommands.md +++ b/frontend/i18n/de/docusaurus-plugin-content-docs/current/client/ClientCommands.md @@ -24,22 +24,8 @@ description: Liste aller Client Befehle. | /fontsize | Ändert die Font-Größe des UI (Chat, Dialoge etc.). Mögliche Fontgröße: -3 bis 5. | | /ctd | Mit SA-MP 0.3.7 RC2 hinzugefügt. Der Befehl aktiviert client debuggen des Ziels der Spielerkamera. | | /rcon | Betrifft eher den Server als den Client. Der Befehl wird gebraucht und RCON Befehle auszuführen. RCON ist ein eingebautes Adminsystem. RCON steht für [Remote Control](../server/ControllingServer#using-rcon). | -| /hudscalefix | Mit SA-MP 0.3.7 R3 hinzugefügt. (de-)aktiviert den radar scale fix, sodass das Radar bei widescreen Auflösungen besser skaliert wird. Dies setzt in der sa-mp.cfg die 'nohudscale' option. | +| /hudscalefix | Mit SA-MP 0.3.7 R3 hinzugefügt. (de-)aktiviert den radar scale fix, sodass das Radar bei widescreen Auflösungen besser skaliert wird. Dies setzt in der sa-mp.cfg die 'nohudscalefix' option. | ## Datei sa-mp.cfg -| Option/Einstellung | Funktion | -| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| pagesize | Siehe /pagesize. | -| fpslimit | Siehe /fpslimit. | -| disableheadmove | Siehe /headmove. | -| timestamp | Siehe /timestamp. | -| ime | Dies steuert, ob die Eingabe im Chatfenster die Textbearbeitung der Eingabemethode und die Sprachumschaltung unterstützt. 1 aktiviert IME, 0 deaktiviert IME. | -| audiomsgoff | Siehe /audiomsg. | -| multicore | (de-)aktiviert, ob der SA-MP Client mehrere CPU-Kerne nutzen kann. Standard ist `1` (Nutzung mehrerer Kerne). Bei Mausproblemen auf `0` setzen.. | -| directmode | Diese Funktion ermöglicht dem Spieler bei text drawing Problemen auf einen langsameren direct-to-screen Text Render Modus zurückzugreifen. 0 = deaktiviert, 1 = aktiviert. | -| audioproxyoff | Wenn diese Option auf `1` gesetzt ist, und ein proxy server in den Windows Internet Einstellungen vorhanden ist, wird diese Proxy nicht beim Abspielen von Audio-Streams genutzt. | -| nonametagstatus | Siehe /nametagstatus. | -| fontface | Mit Version 0.3.7 hinzugefügt. Ermöglicht die Font von Chat, Dialogen und Scoreboard zu ändern. Bsp. fontface="Comic Sans MS". Nicht offiziell unterstützt, es könnte Fehler verursachen. | -| fontweight | Mit Version 0.3.7 hinzugefügt. Diese Option (de-)aktiviert ob die Chat Font `FETT` geschrieben ist. 0 = FETT (standard) und 1 = NORMAL. | -| nohudscale | Mit Version 0.3.7 R3 hinzugefügt. Siehe /hudscalefix. | +Eine Beschreibung aller Optionen in `sa-mp.cfg` findest du in der Dokumentation zu [`sa-mp.cfg`](./sa-mp.cfg.md). diff --git a/frontend/i18n/de/docusaurus-plugin-content-docs/current/client/ClientOnLinux.md b/frontend/i18n/de/docusaurus-plugin-content-docs/current/client/ClientOnLinux.md index 7d00a1f6b87f..c609bc142b1b 100644 --- a/frontend/i18n/de/docusaurus-plugin-content-docs/current/client/ClientOnLinux.md +++ b/frontend/i18n/de/docusaurus-plugin-content-docs/current/client/ClientOnLinux.md @@ -1,24 +1,192 @@ -# Wie starte ich den OMP Client auf Linux +--- +title: "open.mp Client unter Linux" +sidebar_label: "open.mp Client unter Linux" +description: Anleitung zum Ausführen des open.mp Clients unter Linux. +--- -### Warnung! Du bekommst KEINE funktionierende Gui, du kannst das hier nur mit Wine im Terminal oder mit einem Batch Skript starten. +# Anleitung zum Ausführen des open.mp Clients unter Linux -### (Getestet auf wine-ge 8-26 mit dem 32-Bit Präfix, gestartet durch Lutris) +Der open.mp Launcher kann unter Linux auf zwei Arten ausgeführt werden: -Um den Client zum laufen zu bringen musst du den Launcher Herunterladen, und [omp-client.dll](https://assets.open.mp/omp-client.dll). \ -Dann musst du die omp-client.dll in den AppData\Local\mp.open.launcher\omp\ Ordner mit deinem Präfix packen.\ -Danach kannst du den open mp Launcher über die Kommandozeile (CLI) starten. Alternativ kannst du eine Batch-Datei erstellen, wie unten beschrieben, um den Launcher deiner Wahl hinzuzufügen. +- **Mit grafischer Oberfläche** unter Proton. Damit erhältst du den vollständigen Launcher mit Serverbrowser. Dafür werden die Microsoft Edge WebView2 Runtime und eine Launcher-Version mit Wine-Unterstützung benötigt. +- **Über die Kommandozeile** mit beliebigem Wine. Das funktioniert mit jeder Launcher-Version und benötigt WebView2 nicht, bietet aber keine grafische Oberfläche: Pro Befehl verbindest du dich mit genau einem Server. -### Hier ist eine simple .bat Datei zum editieren +Beide Varianten beginnen mit derselben Einrichtung des Präfixes. Folge danach **nur einer** der beiden Optionen. + +## Präfix einrichten + +Die folgenden Befehle verwenden `~/Games/openmp` als Präfix und `~/Downloads` für Downloads. Passe die Pfade an dein System an und verwende in jedem Schritt **dasselbe Präfix**. Führe die Befehle in bash oder zsh aus. Wenn du fish verwendest, starte zuerst `bash`. + +:::tip + +Die Kommandozeilen-Variante funktioniert auch mit einem Präfix aus Lutris oder Bottles, wenn GTA San Andreas und der Launcher bereits darin installiert sind. Springe in diesem Fall zu [Option B](#option-b-command-line-only-any-wine). + +::: + +1. Installiere [umu-launcher](https://github.com/Open-Wine-Components/umu-launcher) über die Pakete deiner Distribution (`umu-launcher` für Arch/CachyOS, Fedora und weitere) oder von der Releases-Seite. Damit lassen sich Windows-Programme über Proton ohne Steam ausführen. + +2. Lege diese Variablen in deinem Terminal fest. Alle folgenden Befehle verwenden sie: + +``` +export WINEPREFIX="$HOME/Games/openmp" +export GAMEID=umu-omplauncher +export STORE=none +``` + +Wenn du eine bestimmte Proton-Version verwenden möchtest, setze außerdem `PROTONPATH` auf ihren Ordner, zum Beispiel `export PROTONPATH="$HOME/.local/share/Steam/compatibilitytools.d/Proton-CachyOS Latest"`. Ohne diese Angabe lädt umu-run GE-Proton herunter und verwendet es. + +3. Erstelle das Präfix. Beim ersten Start dauert es eine Weile: + +``` +umu-run wineboot +``` + +4. Kopiere deinen GTA-San-Andreas-Ordner in das Präfix, zum Beispiel nach `~/Games/openmp/drive_c/Games/GTA San Andreas`. Kopiere den Ordner selbst, keinen Symlink. + +5. Lade den portablen open.mp Launcher `omp-launcher.exe` aus der [aktuellen Version](https://github.com/openmultiplayer/launcher/releases/latest) in das Präfix. Er läuft ohne Installation. Verwende nicht `omp-launcher-setup.exe`, da der Installer versucht, WebView2 selbst zu installieren und im Präfix fehlschlägt. ``` -Z:\path\to\omp-launcher.exe -h server.ip -p port -n dzmtrzz -g Z:\home\yourname\foo\bar\baz\gamepath\ +mkdir -p "$WINEPREFIX/drive_c/Games/omp-launcher" +curl -fL https://github.com/openmultiplayer/launcher/releases/latest/download/omp-launcher.exe -o "$WINEPREFIX/drive_c/Games/omp-launcher/omp-launcher.exe" ``` -Du kannst die omp-launcher.exe mit dem Parameter --help starten, um mehr Informationen über weitere Parameter zu erhalten, falls das oben genannte Beispiel nicht ausreicht. +Das Präfix ist bereit. Folge nun **nur einer** dieser Optionen: + +- [Option A: Launcher-GUI](#option-a-launcher-gui-proton), wenn du den vollständigen Launcher mit Serverbrowser verwenden möchtest. **Empfohlen.** +- [Option B: Nur Kommandozeile](#option-b-command-line-only-any-wine), wenn du dich nur per Befehl mit einem Server verbinden möchtest. + +## Option A: Launcher-GUI (Proton) {#option-a-launcher-gui-proton} + +:::warning + +Die GUI benötigt **Proton**. Mit regulärem Wine bleibt das Launcher-Fenster weiß. + +::: + +### Getestet mit: + +- umu-launcher mit Proton-CachyOS 11.0, WebView2 Runtime 156 +- SteamOS 3.9.5 auf Steam Deck mit GE-Proton über Lutris +- Fedora Silverblue 44 mit GE-Proton über Lutris (UMU-Proton funktionierte in dieser Konfiguration nicht) +- Arch Linux mit KDE Plasma unter Wayland, PipeWire und Proton-CachyOS-SLR über die Steam-Version von GTA:SA (auf Version 1.0 herabgestuft, läuft in SLR) + +:::note + +Funktioniert die GUI bei dir mit einer anderen Konfiguration (einer anderen Proton- oder Wine-Version, Lutris, Bottles, Heroic, Steam oder einem anderen Desktop)? Melde es bitte auf dem open.mp Discord oder GitHub und nenne deine Distribution, Desktop-Umgebung, Wine- oder Proton-Version sowie WebView2-Version, damit wir sie hier ergänzen können. + +::: + +### Vorgehensweise: + +1. Lade die x86-Version der WebView2 Runtime herunter und installiere sie im Präfix. Das Launcher-Fenster basiert darauf: + +``` +curl -fL "https://go.microsoft.com/fwlink/p/?LinkId=2124701" -o ~/Downloads/MicrosoftEdgeWebView2RuntimeInstallerX86.exe +umu-run ~/Downloads/MicrosoftEdgeWebView2RuntimeInstallerX86.exe /silent /install +``` + +Der Installer zeigt kein Fenster an. Wenn die Ausgabe bei `ntsync: up and running.` stehen bleibt, läuft der Installer möglicherweise noch. Warte, bis der Befehl beendet ist und die Eingabeaufforderung zurückkehrt, bevor du fortfährst. + +2. Starte den Launcher für diesen Start mit deaktiviertem Xalia: + +``` +PROTON_USE_XALIA=0 umu-run "$WINEPREFIX/drive_c/Games/omp-launcher/omp-launcher.exe" +``` + +Beim ersten Start lädt der Launcher die open.mp-Clientdateien selbst herunter. Stelle in den Einstellungen den Spielpfad auf deinen GTA-San-Andreas-Ordner ein (im Beispiel `C:\Games\GTA San Andreas`), wähle dann einen Server aus und spiele los. + +3. Füge den Launcher zum Anwendungsmenü hinzu, damit du ihn künftig wie jede andere Anwendung starten kannst. Proton erstellt Menüeinträge nicht selbst. Führe diesen Schritt einmal im selben Terminal aus: + +``` +mkdir -p "$HOME/.local/share/applications" "$HOME/.local/share/icons" +curl -fL https://raw.githubusercontent.com/openmultiplayer/launcher/master/src-tauri/icons/128x128.png -o "$HOME/.local/share/icons/openmp-launcher.png" +PROTON_ENV=${PROTONPATH:+"\"PROTONPATH=$PROTONPATH\""} +cat > "$HOME/.local/share/applications/omp-launcher.desktop" < "$HOME/.local/share/applications/omp-launcher.desktop" < "$HOME/.local/share/applications/omp-launcher.desktop" < "$HOME/.local/share/applications/omp-launcher.desktop" < "$HOME/.local/share/applications/omp-launcher.desktop" < "$HOME/.local/share/applications/omp-launcher.desktop" <