Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog/snippets/other.7036.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- (#7036) Game repository: Update the setup instructions for the development environment.
2 changes: 1 addition & 1 deletion docs/development-start-here/lua-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ For Linux users you can use the following bash script file instead:

# Change this to the location of your run proton run script
RunProton="$HOME/Applications/FAF/downlords-faf-client-1.6.0/run"
$RunProton $HOME/.faforever/bin/ForgedAlliance.exe /init init_dev.lua /showlog /log "dev.log" /EnableDiskWatch /nomovie
$RunProton $HOME/.faforever/bin/ForgedAlliance.exe /init init_local_development.lua /showlog /log "dev.log" /EnableDiskWatch /nomovie

# /init Define what initialisation file to use
# /EnableDiskWatch Allows the game to reload files when it sees they're changed on disk
Expand Down
6 changes: 3 additions & 3 deletions docs/development/developmentEnviroment.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Fork the repository. Clone your fork to your system using your favourite Git too

- `C:/ProgramData/FAForever/bin`

Copy the contents of `repository/setup/bin` into the `bin` folder. Open `init_dev.lua` now found in the `bin` folder. At the top it states:
Copy the contents of `repository/setup/bin` into the `bin` folder. Open `init_local_development.lua` now found in the `bin` folder. At the top it states:

```lua
-- change this to the location of the repository on your disk. Note that `\` is used
Expand Down Expand Up @@ -131,13 +131,13 @@ _This step is optional and only required when you intend to investigate an excep
With thanks to KionX we have a [debugger](https://github.com/FAForever/FADeepProbe). When an exception occurs it can trace the exception to a line of Lua code. A compiled executable is available in each [release](https://github.com/FAForever/FADeepProbe/releases). Store the executable in your `bin` folder. This is the same `bin` folder as defined earlier. We need to adapt the bat / bash files to use the debugger. As an example we change the bat file from:

```bat
ForgedAlliance.exe /init "init_dev.lua" /EnableDiskWatch /showlog /log "dev.log"
ForgedAlliance.exe /init "init_local_development.lua" /EnableDiskWatch /showlog /log "dev.log"
```

To:

```bat
FADeepProbe.exe /init "init_dev.lua" /EnableDiskWatch /showlog /log "dev.log"
FADeepProbe.exe /init "init_local_development.lua" /EnableDiskWatch /showlog /log "dev.log"
```

The arguments are passed along by the debugger. The change to the bash script is similar. When the game crashes the debugger will try and inform you in the log what happened.
Expand Down
4 changes: 2 additions & 2 deletions docs/development/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Open up two explorers. Navigate to where you cloned the repository in one. Navig

- `C:\ProgramData\FAForever\bin`

Copy the `init_local_development.lua` file your fork to the the bin folder. The game uses an initialisation file to understand where it should (not) search for game files. The initialisation file you just copied is an adjusted initialisation file that tells the game to also look at your local repository. We still need to tell it where that is. Open up the file that you copied. At the top you'll find:
Copy the `init_local_development.lua` file from your fork to the bin folder. The game uses an initialisation file to understand where it should (not) search for game files. The initialisation file you just copied is an adjusted initialisation file that tells the game to also look at your local repository. We still need to tell it where that is. Open up the file that you copied. At the top you'll find:

```lua
-- change this to the location of the repository on your disk. Note that `\` is used
Expand Down Expand Up @@ -64,7 +64,7 @@ For Linux users you can use the following bash script file instead:

# Change this to the location of your run proton run script
RunProton="$HOME/Applications/FAF/downlords-faf-client-1.6.0/run"
$RunProton $HOME/.faforever/bin/ForgedAlliance.exe /init init_dev.lua /showlog /log "dev.log" /EnableDiskWatch /nomovie
$RunProton $HOME/.faforever/bin/ForgedAlliance.exe /init init_local_development.lua /showlog /log "dev.log" /EnableDiskWatch /nomovie

# /init Define what initialisation file to use
# /EnableDiskWatch Allows the game to reload files when it sees they're changed on disk
Expand Down
2 changes: 1 addition & 1 deletion setup/bin/dev_linux.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Change this to the location of your run proton run script (you will have copied this into your client folder https://wiki.faforever.com/en/FAQ/Client-Setup)
RunProton="$HOME/Applications/FAF/downlords-faf-client-1.6.0/run"
$RunProton $HOME/.faforever/bin/ForgedAlliance.exe /init init_dev.lua /showlog /log "dev.log" /EnableDiskWatch /nomovie
$RunProton $HOME/.faforever/bin/ForgedAlliance.exe /init init_local_development.lua /showlog /log "dev.log" /EnableDiskWatch /nomovie

# /init Define what initialisation file to use
# /EnableDiskWatch Allows the game to reload files when it sees they're changed on disk
Expand Down
File renamed without changes.
6 changes: 3 additions & 3 deletions setup/setup-english.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ _There is a section about Git in the FAQ if you're unfamilar with it._
Fork the repository. Clone your fork to your system using your favorite Git tool. We refer to the `repository` directory as the location of your repository on your system. We refer to the `bin` directory as the `bin` folder in the data location, as defined in the client settings. By default this is:
- `C:/ProgramData/FAForever/bin`

Copy the contents of `repository/setup/bin` into the `bin` folder. Open `init_dev.lua` now found in the `bin` folder. At the top it states:
Copy the contents of `repository/setup/bin` into the `bin` folder. Open `init_local_development.lua` now found in the `bin` folder. At the top it states:

```lua
-- change this to the location of the repository on your disk. Note that `\` is used
Expand Down Expand Up @@ -126,11 +126,11 @@ _This step is optional and only required when you intend to investigate an excep
With thanks to KionX we have a [debugger](https://github.com/FAForever/FADeepProbe). When an exception occurs it can trace the exception to a line of Lua code. A compiled executable is available in each [release](https://github.com/FAForever/FADeepProbe/releases). Store the executable in your `bin` folder. This is the same `bin` folder as defined earlier. We need to adapt the bat / bash files to use the debugger. As an example we change the bat file from:

```bat
ForgedAlliance.exe /init "init_dev.lua" /EnableDiskWatch /showlog /log "dev.log"
ForgedAlliance.exe /init "init_local_development.lua" /EnableDiskWatch /showlog /log "dev.log"
```
To:
```bat
FADeepProbe.exe /init "init_dev.lua" /EnableDiskWatch /showlog /log "dev.log"
FADeepProbe.exe /init "init_local_development.lua" /EnableDiskWatch /showlog /log "dev.log"
```

The arguments are passed along by the debugger. The change to the bash script is similar. When the game crashes the debugger will try and inform you in the log what happened.
Expand Down
6 changes: 3 additions & 3 deletions setup/setup-russian.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ _В ЧаВо есть раздел о Git, если вы с ним не знак
Форкните репозиторий. Клонируйте свой форк в свою систему с помощью вашего инструмента Git. Далее `репозиторий` - каталог вашего репозитория в вашей системе, а каталог `bin` - папка в расположении данных, как указано в настройках клиента. По умолчанию это:
- `C:/ProgramData/FAForever/bin`

Скопируйте содержимое `repository/setup/bin` в папку `bin`. Откройте `init_dev.lua`, который теперь находится в папке `bin`. В верхней части указано:
Скопируйте содержимое `repository/setup/bin` в папку `bin`. Откройте `init_local_development.lua`, который теперь находится в папке `bin`. В верхней части указано:

```lua
-- измените это на расположение репозитория на вашем диске. Обратите внимание, что `\` используется
Expand Down Expand Up @@ -89,11 +89,11 @@ _Этот шаг является необязательным и требует
Благодаря KionX у нас есть [отладчик](https://github.com/FAForever/FADeepProbe). Когда возникает исключение, он может отследить его до строки кода Lua. Скомпилированный исполняемый файл доступен в каждом [релизе](https://github.com/FAForever/FADeepProbe/releases). Сохраните исполняемый файл в папке `bin`. Это та же самая папка `bin`, как определено ранее. Нам нужно адаптировать файлы bat/bash для использования отладчика. В качестве примера мы меняем bat-файл с:

```bat
ForgedAlliance.exe /init "init_dev.lua" /EnableDiskWatch /showlog /log "dev.log"
ForgedAlliance.exe /init "init_local_development.lua" /EnableDiskWatch /showlog /log "dev.log"
```
На:
```bat
FADeepProbe.exe /init "init_dev.lua" /EnableDiskWatch /showlog /log "dev.log"
FADeepProbe.exe /init "init_local_development.lua" /EnableDiskWatch /showlog /log "dev.log"
```

Аргументы передаются отладчиком. Изменения в сценарии bash аналогичны. Когда игра вылетает, отладчик попытается сообщить вам в журнале, что произошло.
Expand Down
Loading