https://github.com/beyond-all-reason/bar_debug_launcher

A simple debug launcher for testing engines, lobbies and games
https://github.com/beyond-all-reason/bar_debug_launcher

Last synced: 9 days ago
JSON representation

A simple debug launcher for testing engines, lobbies and games

• Host: GitHub
• URL: https://github.com/beyond-all-reason/bar_debug_launcher
• Owner: beyond-all-reason
• Created: 2022-09-20T08:59:16.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-23T12:23:56.000Z (3 months ago)
• Last Synced: 2024-08-23T13:42:57.156Z (3 months ago)
• Language: Python
• Size: 114 MB
• Stars: 1
• Watchers: 2
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Bar Replay and Debug Launcher

A simple debug launcher for testing engines, lobbies and games, and for playing replays. 

## Installation

Copy the `bar_demo_debug_launcher.exe` and `bar-icon.ico` from this repository next to wherever your Beyond-All-Reason.exe is

## Associating replays to auto-start on double click

Right click any replay in your BAR/data/demos folder, and and set the "Open With" to "bar_demo_debug_launcher.exe". You can now double-click any replay and it should download all that is needed and start the replay!.

## Choosing a replay and starting it directly

Click the "Open and launch a replay" button, select it, and it should be loaded. 

## Watching replays and loading savegames in a specific engine version without opening new engine windows. 

1. Select the engine version you wish to use.

2. Use Spring-launcher with rapid://byar-chobby:test

3. Click start with the above selected settings 

## Developing the BAR Chobby lobby

1. Make sure you have git cloned https://github.com/beyond-all-reason/BYAR-Chobby into BAR/data/games/BYAR-Chobby.sdd

2. Select the engine version you want to use

3. Select BYAR Chobby $VERSION as the game/menu you want to run

4. Click start with the above selected settings 

Note that you wont have automatic downloads of game updates and maps in this mode!

## Testing and developing the BAR game

1. Make sure you have git cloned https://github.com/beyond-all-reason/Beyond-All-Reason into BAR/data/games/BAR.sdd

2. Select the engine version you want to use

3. Select the game/menu Beyond All Reason $VERSION

4. Click start with the above selected settings 

## Testing maps quickly

1. Select the engine version you want to use

2. Select the game/menu rapid://byar:test

4. Select the map you want from the dropdown, if it doesnt appear, choose your own once ingame. 

5. Choose your map in the engine splash screen, if you didnt choose above

## Testing modoptions

Same as testing and developing the BAR game, but you can can specify a list of modoptions in the Additinoal modoptions field. 

## Testing different engines

All engines should go into bar/data/engine/  

Each into their own subfolder

They will then appear in the engine selector dropdown in the BAR debug launcher

## Attaching debuggers and development tools like VSCode

1. Select all the options you want

2. Copy paste the generated command line into your IDE

![kép](https://user-images.githubusercontent.com/109391/198118232-67bb8956-d976-4c88-9ade-da48e1a735e7.png)

## Debugging the Debug Launcher itself

Use the BAR_Demo_Debug_Launcher_console.exe to get a console, open a ticket for any bug you may find. 

### Dev Notes:

Exe is built without a console:

pyinstaller --onefile --icon=bar-icon.ico --noconsole BAR_Debug_Launcher.py