Update README.md
This commit is contained in:
@@ -2,15 +2,17 @@
|
|||||||
|
|
||||||
Production-ready Qt6 GUI application for hosting Commonwealth Online servers on Windows.
|
Production-ready Qt6 GUI application for hosting Commonwealth Online servers on Windows.
|
||||||
|
|
||||||
## Quick Start
|
**Looking for the CLI only?** You do not need to build this repo. Download the [`server/`](server/) folder and follow [server/README.md](server/README.md) — run `start.bat` (Windows) or `./start.sh` (Linux / macOS). Python 3.9+ is all you need.
|
||||||
|
|
||||||
|
This repository is for building the **Host GUI**. The GUI wraps the same Python server from `server/` in a native Windows UI.
|
||||||
|
|
||||||
|
## Quick Start (GUI)
|
||||||
|
|
||||||
**First time? Follow the [Setup Instructions](SETUP.md)**
|
**First time? Follow the [Setup Instructions](SETUP.md)**
|
||||||
|
|
||||||
### Building
|
### Building
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd host-gui
|
|
||||||
|
|
||||||
# Check prerequisites
|
# Check prerequisites
|
||||||
check-setup.bat
|
check-setup.bat
|
||||||
|
|
||||||
@@ -18,7 +20,7 @@ check-setup.bat
|
|||||||
build.bat
|
build.bat
|
||||||
```
|
```
|
||||||
|
|
||||||
Output: `host-gui\build\bin\Release\CommonwealthOnlineHost.exe`
|
Output: `build\bin\Release\CommonwealthOnlineHost.exe`
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
@@ -48,14 +50,13 @@ See [SETUP.md](SETUP.md) for detailed instructions and troubleshooting.
|
|||||||
### Quick Build
|
### Quick Build
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd host-gui
|
|
||||||
check-setup.bat # Verify prerequisites
|
check-setup.bat # Verify prerequisites
|
||||||
build.bat # Auto-detect Qt6 and build
|
build.bat # Auto-detect Qt6 and build
|
||||||
```
|
```
|
||||||
|
|
||||||
### From Visual Studio
|
### From Visual Studio
|
||||||
|
|
||||||
1. Open `host-gui` folder in Visual Studio 2022
|
1. Open this repository folder in Visual Studio 2022
|
||||||
2. Wait for CMake to auto-configure
|
2. Wait for CMake to auto-configure
|
||||||
3. Build → Build All
|
3. Build → Build All
|
||||||
4. Run the executable
|
4. Run the executable
|
||||||
@@ -63,7 +64,6 @@ build.bat # Auto-detect Qt6 and build
|
|||||||
### From Command Line (Manual)
|
### From Command Line (Manual)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd host-gui
|
|
||||||
mkdir build
|
mkdir build
|
||||||
cd build
|
cd build
|
||||||
cmake .. -G "Visual Studio 17 2022" -DCMAKE_PREFIX_PATH="C:\Qt\6.8.0\msvc2022_64"
|
cmake .. -G "Visual Studio 17 2022" -DCMAKE_PREFIX_PATH="C:\Qt\6.8.0\msvc2022_64"
|
||||||
@@ -93,7 +93,6 @@ Saved changes apply the next time the server is started. If the server is alread
|
|||||||
## Layout
|
## Layout
|
||||||
|
|
||||||
```
|
```
|
||||||
host-gui/
|
|
||||||
├── CMakeLists.txt # Build configuration
|
├── CMakeLists.txt # Build configuration
|
||||||
├── build.bat # Auto-build script
|
├── build.bat # Auto-build script
|
||||||
├── check-setup.bat # Verify prerequisites
|
├── check-setup.bat # Verify prerequisites
|
||||||
@@ -110,6 +109,7 @@ host-gui/
|
|||||||
│ ├── resources.qrc # Qt resource manifest
|
│ ├── resources.qrc # Qt resource manifest
|
||||||
│ └── icons/
|
│ └── icons/
|
||||||
│ └── app.ico # Application icon
|
│ └── app.ico # Application icon
|
||||||
|
├── server/ # Python relay server (CLI; no build needed)
|
||||||
└── build/ # Build output directory (after building)
|
└── build/ # Build output directory (after building)
|
||||||
└── bin/
|
└── bin/
|
||||||
└── Release/
|
└── Release/
|
||||||
|
|||||||
Reference in New Issue
Block a user