Skip to content

Commit

Permalink
various grammar fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
lunarlattice0 committed Aug 20, 2023
1 parent 41ab09f commit 2c89aa1
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions src/Configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

To change Vinegar's behavior, edit the `config.toml` file at `~/.config/vinegar/config.toml` (or `$XDG_CONFIG_HOME/vinegar/config.toml` if applicable).

Anything added to the configuration file is an override over the default values (the default configuration file can be seen [here](https://github.com/vinegarhq/vinegar/blob/master/internal/config/config.toml)), which are designed to be the best for the average user. However, by editing the configuration file you can tune your performance or apply other customizations.
Anything added to the configuration file is an override over the default values (the default configuration file can be seen [here](https://github.com/vinegarhq/vinegar/blob/master/internal/config/config.toml)) which are designed to be the best for the average user. Editing the configuration file allows you to tune your performance or apply other customizations.

## Configuration Values
This section will explain what each value in the global configuration file represents.

| Option | Description | Default |
| ------------- | ---------------------------------------------------------------------------------------------------------- | --------- |
| `launcher` | the program that is used to launch Wine when launching Roblox; can be set to `gamemoderun`. | none |
| `launcher` | the program that is used to launch Wine when launching Roblox; this can be set to `gamemoderun`. | none |
| `wineroot` | the path to a valid Wine 'root' installation directory. | none |

For Studio or Player configurations, you will need to specify it as a table, an example can be seen below.
Expand All @@ -20,7 +20,7 @@ For Studio or Player configurations, you will need to specify it as a table, an
| `renderer` | selects the rendering engine to be used by Roblox via FFlags. | `"D3D11"` |
| `forced_version` | forces Vinegar to use a specific version, the release channel must be adjusted for the version. | none |
| `auto_kill_prefix` | tells Vinegar to automatically kill the wineprefix after the application closes. | `false` |
| `dxvk` | automatically uses DXVK for the application, installs if neccessary. | Player: `true`, Studio: `false` |
| `dxvk` | automatically uses DXVK for the application and installs if neccessary. | Player: `true`, Studio: `false` |
| `[app.fflags]` | the table used to set FFlags for the given application type. | See below. |
| `[app.env]` | the table used to set environment variables for the given application type. | Player: `DXVK_HUD=fps` |

Expand Down
4 changes: 2 additions & 2 deletions src/Home/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

## Welcome to the documentation of the Vinegar project!

- Vinegar is a transparent, minimal, configurable, fast bootstrapper and launcher for Roblox Player and Roblox Studio.
- Vinegar is a transparent, minimal, configurable, and fast bootstrapper and launcher for Roblox Player and Roblox Studio.
- The software and documentation are both open source, and can be accessed [on GitHub](https://github.com/vinegarhq).
- There is no <abbr title="Graphical User Interface">GUI</abbr> for Vinegar at this time, Vinegar is primarily CLI.
- There is no <abbr title="Graphical User Interface">GUI</abbr> for Vinegar at this time.
- Vinegar is an alternative to [Grapejuice](https://brinkervii.gitlab.io/grapejuice/).

To get started, proceed to [the installation guide](Installation/index.md)!
Expand Down
4 changes: 2 additions & 2 deletions src/Installation/guides/source.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Installation from source

## Installing Wine
Before you can install Vinegar, you will first have to install Wine first, you can see the guide for your distribution: [Wine Wiki: Download](https://wiki.winehq.org/Download), you may visit the page according to your preferred Linux distribution of choice. The guide for installing Wine can also be found on your distributions Wiki pages, such as [Arch](https://wiki.archlinux.org/title/wine) and [Gentoo](https://wiki.gentoo.org/wiki/Wine). Additionally, you will need the GnuTLS library in-order for Roblox networking to function properly:
Before you can install Vinegar, you will first have to install Wine first. You can use the guide for your distributionon the [wine wiki](https://wiki.winehq.org/Download). For instance, you can find guides for [Arch](https://wiki.archlinux.org/title/wine) and [Gentoo](https://wiki.gentoo.org/wiki/Wine). Additionally, you will need the GnuTLS library in-order for Roblox networking to function properly:

- Arch: `lib32-gnutls`
- Void: `gnutls-32bit` via `void-repo-multilib`
- Gentoo: `net-libs/gnutls` via `ABI_X86="64 32"`, refer to [Gentoo Wiki: package.use](https://wiki.gentoo.org/wiki//etc/portage/package.use)

It is recommended to make sure you have installed Wine 8.3 and up on your system, as it can give a significant performance increase.
It is recommended to ensure that you have installed Wine 8.3 or above on your system, as it can give a significant performance increase.

## Building Vinegar

Expand Down

0 comments on commit 2c89aa1

Please sign in to comment.