Update 'README.md'

This commit is contained in:
MNTLe 2023-05-10 17:15:38 +12:00
parent a66446d519
commit 9ba970b9b0

View File

@ -1,3 +1,36 @@
# DOSBox_Game_Runner
# DOSBox Game Runner
A short python script to run a game in DOSBox.
A simple Python script to run DOS games in DOSBox.
## Description
This script is designed to make it easy to run DOS games in DOSBox on modern operating systems. It provides a GUI interface for configuring the DOSBox environment and launching the game.
The script reads configuration settings from a `dbgr.conf` file, which can be edited using the included `config_editor.py` script.
## Requirements
- Python 3.x
- DOSBox
## Installation
1. Install DOSBox.
2. Clone the repository or download the source code.
3. Run `pip install -r requirements.txt` to install dependencies (PyQt5 and configparser).
4. Edit `dbgr.conf` to configure DOSBox settings for your system.
## Usage
1. Launch `game_runner.py`.
2. Use the `config_editor.py` script to edit the configuration settings as needed.
3. Click the "Launch Game" button to start the configured game in DOSBox.
## Contributing
Contributions are welcome! If you encounter any bugs or issues, please submit them via the issue tracker. Pull requests with bug fixes and new features are also welcome.
## License
This project is licensed under the MIT License. See `LICENSE` for details.