-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Closes #691 * Added Windows instruction for the setup * fixed the path to the example, adjusted to the cargo-project name * fixed broken code in the example Original PR contains an extra merge commit we don't want, so this avoids that. - [x] no changelog update needed
- Loading branch information
Showing
4 changed files
with
42 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Windows setup | ||
|
||
This guide has been tested on Windows 11 using PowerShell with elevated rights _(dont use cmd)_. | ||
|
||
# 1. Install a recent version of rust | ||
|
||
To use agb, you'll need to use nightly rust since it requires a few nightly features. | ||
Firstly, ensure that you have **rustup** installed which you can do by following the instructions on the [rust website](https://www.rust-lang.org/tools/install) | ||
|
||
If you have installed rustup, you can update it with `rustup update`. | ||
If the `rustup`-command fails, you'll most probably add the cargo/bin folder to the Path-environment variable. | ||
|
||
|
||
# 2. git | ||
|
||
The source code for the game is hosted on github, so you will need to install git. | ||
|
||
You'd need to follow this official github git [guide](https://github.com/git-guides/install-git). | ||
|
||
# 3. mGBA | ||
|
||
We recommend using the mGBA emulator which you can download from [here](https://mgba.io/downloads.html). | ||
|
||
After installing, you can add the binary to your Path-environment variable and create an alias for the agb run command to use. | ||
|
||
Creating link for mgba-qt: | ||
```PS | ||
New-Item -itemtype hardlink -path "C:\Program Files\mGBA\mgba-qt.exe" -value "C:\Program Files\mGBA\mGBA.exe" | ||
``` | ||
|
||
# 4. gbafix | ||
|
||
In order to be able to play games made with agb on real hardware or on some emulators, you will need to install 'agb-gbafix'. | ||
Agb's implementation can be installed very easily using `cargo install agb-gbafix`. | ||
|
||
That is all you need to get started! | ||
You can now move on to 'building the game'. |