|
| 1 | +--- |
| 2 | +sidebar_label: Windows |
| 3 | +--- |
| 4 | + |
| 5 | +import Tabs from '@theme/Tabs'; |
| 6 | +import TabItem from '@theme/TabItem'; |
| 7 | + |
| 8 | +# Installing RGBDS on Windows |
| 9 | + |
| 10 | +The install instructions are a bit different depending on the environment in which you wish to use RGBDS. |
| 11 | + |
| 12 | +<Tabs> |
| 13 | +<TabItem value="wsl" label="WSL"> |
| 14 | + |
| 15 | +Using WSL is recommended if your version of Windows supports it (which Windows 10 and 11 do). |
| 16 | + |
| 17 | +Please refer to [the install instructions](linux.md) for your WSL's running Linux distribution. |
| 18 | +You can check what your WSL distribution is by running `wsl -l -v` in the Command Prompt. |
| 19 | +(The default Linux distribution on WSL is Ubuntu, whose package manager is `apt`.) |
| 20 | + |
| 21 | +</TabItem> |
| 22 | +<TabItem value="cygwin" label="Cygwin / MSYS2"> |
| 23 | + |
| 24 | +1. Go the [latest release](https://github.com/gbdev/rgbds/releases/latest) (or pick a specific version from [the list](https://github.com/gbdev/rgbds/releases)). |
| 25 | +2. Under "Assets" at the bottom, download either <code>rgbds-<var><version></var>-win32.zip</code> (for 32-bit Windows) or <code>rgbds-<var><version></var>-win64.zip</code> (for 64-bit Windows). |
| 26 | + (For example, version 0.7.0 for 64-bit Windows would have `rgbds-0.7.0-win64.zip`). |
| 27 | +3. Unzip the .zip file. |
| 28 | + It should give you the RGBDS `.exe` files and a couple of `.dll` files. |
| 29 | +4. Copy all of those `.exe` and `.dll` files to the `/usr/local/bin` directory of your Cygwin/MSYS2 installation. |
| 30 | + (You can learn its equivalent Windows path by running `cygpath -w /usr/local/bin` in the Cygwin terminal.) |
| 31 | + |
| 32 | + :::caution |
| 33 | + |
| 34 | + Do not put them in a subdirectory (e.g. `/usr/local/bin/rgbds/`)! |
| 35 | + This would not work. |
| 36 | + |
| 37 | + ::: |
| 38 | + |
| 39 | +After that, you should be able to use RGBDS from within the Cygwin/MSYS2 terminal, which you can confirm by running `rgbasm -V`. |
| 40 | + |
| 41 | +If `rgbasm -V` doesn't work, check that `/usr/local/bin` is listed in your Cygwin/MSYS2 `PATH` (run `echo $PATH` to check). |
| 42 | +If it isn't listed, you must add it (e.g. run `echo 'export PATH="/usr/local/bin:$PATH"' >> ~/.bashrc`, then close your Cygwin terminal and open a new one). |
| 43 | + |
| 44 | +:::tip |
| 45 | + |
| 46 | +If you can choose between using Cygwin or MSYS2, be advised that Cygwin is slower and has been reported to cause a bit of trouble to some. |
| 47 | + |
| 48 | +::: |
| 49 | + |
| 50 | +</TabItem> |
| 51 | +<TabItem value="win32" label="None of those"> |
| 52 | + |
| 53 | +1. Go the [latest release](https://github.com/gbdev/rgbds/releases/latest) (or pick a specific version from [the list](https://github.com/gbdev/rgbds/releases)) |
| 54 | +2. Under "Assets" at the bottom, download either <code>rgbds-<var><version></var>-win32.zip</code> (for 32-bit Windows) or <code>rgbds-<var><version></var>-win64.zip</code> (for 64-bit Windows). |
| 55 | + (For example, version 0.7.0 for 64-bit Windows would have `rgbds-0.7.0-win64.zip`). |
| 56 | +3. Unzip the .zip file. |
| 57 | + It should give you the RGBDS `.exe` files and a couple of `.dll` files. |
| 58 | +4. Either: |
| 59 | + - ...put all of the files in a directory, then add that directory to Windows' `PATH`. |
| 60 | + This will *permanently* allow you to use RGBDS *from any directory*. |
| 61 | + |
| 62 | + <Tabs> |
| 63 | + <TabItem value="gui" label="Graphically"> |
| 64 | + |
| 65 | + 1. Open the Environment Variables dialog for your account. |
| 66 | + You can do this by either: |
| 67 | + - ...typing "edit environment variables for your account" in the Start menu's Search box and clicking the Control Panel item that's found. |
| 68 | + - ...opening the Control Panel, clicking its "User Accounts" item, clicking the "User Accounts" heading in that item, and clicking "Change my environment variables" in the sidebar. |
| 69 | + 2. Click the "Path" line in the **top** panel to highlight it. |
| 70 | + 6. Click "Edit..." to open the "Edit environment variable" dialog for "Path". |
| 71 | + 7. Click "Browse...", select the folder that the RGBDS files are in, and click OK. |
| 72 | + 8. The folder should be added to the bottom of the "Path" list. |
| 73 | + Make sure that the new entry (which should be highlighted) is at the bottom of the list; if not, click on "Move Down" until it is. |
| 74 | + 9. Click "OK" to finish the "Edit environment variable" dialog, and again for the "Environment Variables" dialog. |
| 75 | + |
| 76 | + </TabItem> |
| 77 | + <TabItem value="cmd" label="Command Prompt"> |
| 78 | + |
| 79 | + Run the command <code>setx PATH "%PATH%<var><rgbds_path></var>;"</code>, replacing <code><var><rgbds_path></var></code> with the path to the directory that contains `rgbasm.exe`, `rgblink.exe`, etc. |
| 80 | + Then close the Command Prompt and open a new one for the changes to take effect. |
| 81 | + |
| 82 | + If you only want to modify the `PATH` temporarily, instead of the permanent [`setx`](https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/setx) command, you can use the **temporary** [`set`](https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/set_1). |
| 83 | + |
| 84 | + </TabItem> |
| 85 | + <TabItem value="pwsh" label="PowerShell"> |
| 86 | + |
| 87 | + Run the command <code>setx PATH \$\{Env:PATH\}<var><rgbds_path></var>;</code>, replacing <code><var><rgbds_path></var></code> with the path to the directory that contains `rgbasm.exe`, `rgblink.exe`, etc. |
| 88 | + Then close the PowerShell window and open a new one for the changes to take effect. |
| 89 | + |
| 90 | + If you only want to modify the `PATH` temporarily, instead of the permanent [`setx`](https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/setx) command, you can use the **temporary** [`set`](https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/set_1). |
| 91 | + |
| 92 | + </TabItem> |
| 93 | + </Tabs> |
| 94 | + |
| 95 | + - ...or put all of the files in your project's directory. |
| 96 | + - ...or put all of the files in a directory already in the `PATH`. |
| 97 | +5. RGBDS can now be used from your favorite command line (most likely the Command prompt or PowerShell). |
| 98 | + You can test it by running `rgbasm -V`, which should print the version you installed! |
| 99 | + |
| 100 | +</TabItem> |
| 101 | +</Tabs> |
0 commit comments