diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 406a915c..9d2868cb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,6 +30,10 @@ If you have ideas to improve the project, open an issue to discuss them before s - Follow the coding standard defined in the project. - Ensure your code is clean and well-commented. +## Documentation + +`docs/` is the single source of truth for RiftLauncher's documentation. Map every claim you write there to the app's current behaviour, the repository, the [releases page](https://github.com/StratumServer/RiftLauncher/releases) or the [issue tracker](https://github.com/StratumServer/RiftLauncher/issues), not to how VS Launcher used to behave. If a step or a claim can't be verified against one of those, treat it as a hypothesis and say so rather than writing it as fact. The same goes for screenshots and embedded videos: note plainly when one predates a UI or branding change instead of leaving the reader to guess why what they see doesn't match. + ## Submitting a Pull Request 1. **Update your branch**: Make sure your branch is up to date with the main branch. diff --git a/docs/README.md b/docs/README.md index 876ec290..c9f0ae38 100644 --- a/docs/README.md +++ b/docs/README.md @@ -7,3 +7,7 @@ description: Welcome to the official RiftLauncher docs!

v1.3.0 Home Page (VS Launcher, the project RiftLauncher is forked from)

On this page you'll find all the info you need to install, use and contribute to RiftLauncher. + +Start with [Installation](get-started/installation/README.md), then [Usage](get-started/usage/README.md) covers everything from your first Vintage Story version to backups and mods. + +Need help? Report bugs on the [GitHub Issue Tracker](https://github.com/StratumServer/RiftLauncher/issues) or ask on the [Stratum Discord server](https://discord.gg/vQm6z2urZs). diff --git a/docs/get-started/installation/linux.md b/docs/get-started/installation/linux.md index 34cc7cc8..ef629485 100644 --- a/docs/get-started/installation/linux.md +++ b/docs/get-started/installation/linux.md @@ -10,7 +10,7 @@ RiftLauncher works on ANY Linux distro thanks to the AppImage compilation we're Installing it on Linux is as easy as downloading the AppImage and double clicking it.... that's it. Let's get started: {% hint style="success" %} -If you're using Arch Linux or a derivative there is a `.pacman` package on the releases page you can install with `sudo pacman -U riftlauncher-X.X.X.pacman`. There is no RiftLauncher package on the AUR: the `vs-launcher` AUR package belongs to the archived original project and does not track our releases. +If you're using Arch Linux or a derivative there is a `.pacman` package on the releases page. There is no RiftLauncher package on the AUR: the `vs-launcher` AUR package belongs to the archived original project and does not track our releases. There's no distro repository either, so the first install is always a manual download from the releases page; if you'd like to maintain a repository or an AUR package, say hi on the [Stratum Discord server](https://discord.gg/vQm6z2urZs). {% endhint %} {% stepper %} @@ -28,7 +28,17 @@ On the releases page, the first version is always the latest one. There you'll s {% hint style="info" %} Every release ships four Linux builds: `riftlauncher-X.X.X.AppImage`, `.deb`, `.x86_64.rpm` and `.pacman`. There is no Flatpak build; the runtimes it needs aren't available on our build machines. -If you prefer a packaged install over the AppImage, install the `.deb`, `.rpm` or `.pacman` with your usual package tool and then skip steps 3, 4 and 5. Just open it like any other app. All three update themselves the same way the AppImage does, except that replacing an installed package needs elevated privileges, so RiftLauncher will show a system password prompt (`pkexec`, `sudo` or similar) each time it applies an update. +If you prefer a packaged install over the AppImage, install the `.deb`, `.rpm` or `.pacman` once and then skip steps 3, 4 and 5: + +```sh +sudo dpkg -i riftlauncher-X.X.X.deb +# or +sudo rpm -i riftlauncher-X.X.X.x86_64.rpm +# or +sudo pacman -U riftlauncher-X.X.X.pacman +``` + +From there just open it like any other app. All three update themselves the same way the AppImage does, except that replacing an installed package needs elevated privileges, so RiftLauncher will show a system password prompt (`pkexec`, `sudo` or similar) each time it applies an update. {% endhint %} {% endstep %} @@ -203,7 +213,7 @@ sudo steamos-readonly enable {% endstepper %} {% hint style="info" %} -This SteamOS guide was sent by an user that got it working with this. I don't know what each stem does and didn't tested it. +This sequence is inherited from the original VS Launcher docs, where it came from a user who got it working on their own machine. Nobody on the current team has a Steam Deck, so it has never been reproduced or verified step by step. If you run it and something is off, a report on the [Stratum Discord server](https://discord.gg/vQm6z2urZs) would be very welcome. {% endhint %} ### Nixos @@ -241,5 +251,5 @@ If you're coming from VS Launcher, its own folder is `/home/username/.config/VSL --- {% hint style="info" %} -If you find any issue report it on the [GitHub Issue Tracker](https://github.com/StratumServer/RiftLauncher/issues) and if you need help ask us on the [GitHub Discussions](https://github.com/StratumServer/RiftLauncher/discussions) or on the [Official Vintage Story Discord Server](https://discord.com/channels/302152934249070593/1314991001571557488). +If you find any issue report it on the [GitHub Issue Tracker](https://github.com/StratumServer/RiftLauncher/issues) and if you need help ask us on the [Stratum Discord server](https://discord.gg/vQm6z2urZs), the [GitHub Discussions](https://github.com/StratumServer/RiftLauncher/discussions) or the [Official Vintage Story Discord Server](https://discord.com/channels/302152934249070593/1314991001571557488). {% endhint %} diff --git a/docs/get-started/installation/macos.md b/docs/get-started/installation/macos.md index d30cfb15..1455948d 100644 --- a/docs/get-started/installation/macos.md +++ b/docs/get-started/installation/macos.md @@ -5,4 +5,6 @@ icon: apple # MacOS -COMING SOON +MacOS support is planned but not available yet. No MacOS build is published, so RiftLauncher cannot install or launch Vintage Story on a Mac today. + +Follow the [GitHub Releases Page](https://github.com/StratumServer/RiftLauncher/releases) or the [GitHub Issue Tracker](https://github.com/StratumServer/RiftLauncher/issues) to know when that changes. diff --git a/docs/get-started/installation/windows.md b/docs/get-started/installation/windows.md index 9db135aa..b8c03379 100644 --- a/docs/get-started/installation/windows.md +++ b/docs/get-started/installation/windows.md @@ -33,15 +33,9 @@ Double click the downloaded file. The installer lets you pick where to install R ### Install .NET 7, 8 and 10 -If you already played Vintage Story before this will be already installed so, you can skip this process. If you didn't played it before go to e next link to download .NET 7, 8 and 10: +If you already played Vintage Story on this machine before, these are likely installed already and you can skip this step. Otherwise grab all three from the [.NET downloads page](https://dotnet.microsoft.com/download/dotnet): Vintage Story versions need different .NET major versions depending on when they were built, so having 7, 8 and 10 covers you whichever version you end up playing. -{% embed url="https://dotnet.microsoft.com/es-es/download/dotnet/thank-you/sdk-7.0.410-windows-x64-installer" %} - -{% embed url="https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/sdk-8.0.419-windows-x64-installer" %} - -{% embed url="https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/sdk-10.0.201-windows-x64-installer" %} - -Once the download is complete just install it. +Once the downloads are complete just install them. {% endstep %} {% endstepper %} diff --git a/docs/get-started/translation/README.md b/docs/get-started/translation/README.md index 7c2a21a5..b03f0f43 100644 --- a/docs/get-started/translation/README.md +++ b/docs/get-started/translation/README.md @@ -7,8 +7,8 @@ description: Guide for those that want to translate RiftLauncher to another lang RiftLauncher is developed using i18next which makes it translatable to any language.\ In this guide you will see the 2 ways to translate RiftLauncher. -The first one is easier but you won't have a visual interface, comments, automatic translations or many other advantages of option 2. If you only want to translate RiftLauncher once and you don't plan to update the translation with new versions of the launcher or you don't want to break your head too much and you don't mind editing a `.json` by hand then this is your option. +**Option 1** is quicker to start but harder to maintain: you edit a `.json` file by hand, with no visual interface and no automatic checks. Good for a one-off translation you don't plan to keep updating. -The second option is a bit more tedious the first time since you have to install an application (Visual Studio Code), create an account on GitHub and configure a few things. In 10 minutes you have everything ready. The advantage of this option is that you will have a visual interface where you can easily see what new keys you have that are not translated, automatically translate keys with one click, leave notes about translations for other people, synchronize new changes with one click, add translations directly to the RiftLauncher repository... when you have the first setup ready you'll only need to make a few clicks and you'll be able to translate new things, the tedious part it only the first time. +**Option 2** takes about ten minutes to set up the first time, since you have to install Visual Studio Code, create a GitHub account and configure a couple of things. After that it's the easier option to keep translating as the launcher changes: a visual interface shows you which keys are missing, offers one-click machine translation as a starting point, lets other people leave notes on entries, and syncs and submits your changes with a few clicks. With this said, let's start with the guide! diff --git a/docs/get-started/translation/option-2-recomended.md b/docs/get-started/translation/option-2-recomended.md index 6af827e7..19ea19c5 100644 --- a/docs/get-started/translation/option-2-recomended.md +++ b/docs/get-started/translation/option-2-recomended.md @@ -134,9 +134,9 @@ i18n Ally doesn't know by default which language to use as default, you've to sp ### **Open the editor and translate** -On the left menu you'll see a localization icon, if this one does not appear just click to open a few files from the left menu and wait a few seconds/a minute and it'll appear, it'll search for the lang files and do everything itself. Here you've a little video showing how to translate: +On the left menu you'll see a localization icon, if this one does not appear just click to open a few files from the left menu and wait a few seconds/a minute and it'll appear, it'll search for the lang files and do everything itself. -VÍDEO +Open that Localization panel and you'll get the list of every key, with the missing ones flagged, and you can edit translations inline without ever opening the raw `.json`. {% endstep %} {% step %} diff --git a/docs/get-started/usage/README.md b/docs/get-started/usage/README.md index 32c2e459..dc3e2005 100644 --- a/docs/get-started/usage/README.md +++ b/docs/get-started/usage/README.md @@ -7,3 +7,7 @@ description: You don't know how to use RiftLauncher? You're on the right place. Using RiftLauncher is easy. With just a few clicks you'll be ready to play any version you want. First of all you should know a few things so you don't get lost on the process so let's start with this litle guide! + +{% hint style="info" %} +Several of the video guides linked from these pages were recorded before the rebrand from VS Launcher, so the app on screen is still branded VS Launcher. The interface and the steps are the same; only the name and the icon changed. +{% endhint %} diff --git a/docs/get-started/usage/game-client/backups.md b/docs/get-started/usage/game-client/backups.md index 4ee30505..e310ac58 100644 --- a/docs/get-started/usage/game-client/backups.md +++ b/docs/get-started/usage/game-client/backups.md @@ -8,7 +8,7 @@ description: If you want to make some backups of your Installations just follow **Backups** will save a compressed copy of your data on a separated folder so if your worlds got corrupted you can just restore a backup and continue playing. {% hint style="warning" %} -Backups are not a 100% secure, if the world was already damaged there is nothing you can do about it. I have tried them many times and they have never failed but they may fail at some point, I hope they don't. +Backups aren't a guarantee. If the world was already damaged before the backup ran, there is nothing a backup can do about it. Restoring one has never failed in practice, but treat it as a safety net rather than a certainty. {% endhint %} ## Configuring Backups diff --git a/docs/get-started/usage/game-client/install-vintage-story.md b/docs/get-started/usage/game-client/install-vintage-story.md index 87d90a51..1cf5a914 100644 --- a/docs/get-started/usage/game-client/install-vintage-story.md +++ b/docs/get-started/usage/game-client/install-vintage-story.md @@ -103,7 +103,7 @@ Extract the `.tar.gz` on the folder you want. You should not delete or move this If you downloaded it from the Client Area make sure to change the `Vintagestory` executable permissions to allow execution: ```sh -sudo chmod -x ./Vintagestory +sudo chmod +x ./Vintagestory ``` {% endstep %} @@ -147,7 +147,7 @@ Extract the `.tar.gz` on the folder you want. You should not delete or move this If you downloaded it from the Client Area make sure to change the `Vintagestory` executable permissions to allow execution: ```sh -sudo chmod -x ./Vintagestory +sudo chmod +x ./Vintagestory ``` {% endstep %} diff --git a/docs/get-started/usage/game-client/vintage-story-is-already-installed.md b/docs/get-started/usage/game-client/vintage-story-is-already-installed.md index 783f5d18..e67fb648 100644 --- a/docs/get-started/usage/game-client/vintage-story-is-already-installed.md +++ b/docs/get-started/usage/game-client/vintage-story-is-already-installed.md @@ -17,7 +17,7 @@ If you already have the game installed you just need to tell RiftLauncher where **VS Versions** are the base game files like assets, code, executables... By default this ones can be found on the next folder: - **Windows:** `C:/Users/YourUsername/AppData/Roaming/Vintagestory` -- **Linux:** The folder where you extracted the `.tat.gz` or `/home/YourUsername/.local/share/Vintagestory/` +- **Linux:** The folder where you extracted the `.tar.gz` or `/home/YourUsername/.local/share/Vintagestory/` {% hint style="warning" %} Don't confuse it with `VintagestoryData`, that's the Installation(data) folder. @@ -50,7 +50,7 @@ Add an already created Installation | VS Launcher Guides ### Update `modPaths` and `ModPaths` -The `clientsettings.json` and `serverconfig.json` files in the copied installation are still configured for the game to search for mods in the old locations. You must update the `modPaths` in `clientsettings.json` and `ModPaths` in `serverconfig.json` so the game looks in the moved mods folder. +The `clientsettings.json` and `serverconfig.json` files in a copied installation may still point the game at the mods folder's old location. If the game can't find your mods after the move, update `modPaths` in `clientsettings.json` and `ModPaths` in `serverconfig.json` to the folder's new location. RiftLauncher does not rewrite these two fields for you, so this is a manual edit.