Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: David Fernández Aldana <luskaner@users.noreply.github.com>
  • Loading branch information
luskaner authored Oct 4, 2024
1 parent 6064111 commit ce5be09
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ Exceptions on tag/commit signature:

## Installation

Both the launcher and server work out of the box without any installation. Just download the compressed archives,
Both the launcher and server work out of the box without any installation. Just download the archives,
decompress and run them.

## How it works
Expand Down Expand Up @@ -196,8 +196,8 @@ Afterwards, it reverses any changes to allow the official launcher to connect to
1. **Download** the proper *full* asset from the latest
stable release from https://github.com/luskaner/aoe2DELanServer/releases.
2. **Uncompress** it somewhere.
3. If not using the Steam or Microsoft Store (Xbox) launcher, **edit the [launcher/config.ini](launcher/resources/config.ini)
file**
3. If not using the Steam or Microsoft Store (Xbox) launcher, **edit the [config](launcher/resources/config.ini)
file** with a text editor (like Notepad)
and modify
the `Client.Executable` section to point to the game launcher path.
You will need to use a custom launcher for 100% offline play.
Expand All @@ -214,6 +214,28 @@ Afterwards, it reverses any changes to allow the official launcher to connect to
and sending an invite as needed. You can share the link to join the lobby automatically (only works if already
in-game).

## Separate server and launcher execution

<details>
<summary>Server instructions</summary>

1. **Download** the proper *server* asset from latest stable release from https://github.com/luskaner/aoe2DELanServer/releases.
2. **Generate the certificate** by simply executing `bin/genCert`.
3. If needed **edit the [config](server/resources/config/config.ini) file**.
4. **Run** the `server` binary/script.

</details>

<details>
<summary>Launcher instructions</summary>

1. **Download** the proper *launcher* asset from latest stable release from https://github.com/luskaner/aoe2DELanServer/releases.
2. **Generate the certificate** by simply executing `bin/genCert`.
3. If needed **edit the [config](launcher/resources/config.ini) file**. You will need to edit the `Client.Executable` section to point to the game launcher path if using a custom launcher which you will need to use a custom launcher for 100% offline play.
4. **Run** the `launcher` binary/script.

</details>

## Development

See [DEVELOPMENT.md](DEVELOPMENT.md) to see how to develop and release builds.
Expand Down

0 comments on commit ce5be09

Please sign in to comment.