diff --git a/README.md b/README.md index f52e8b3..d73f01e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,80 @@ -# releases +

+ Vainec Protocol +

+

"We build to remember who we were. We fight to forget what we are becoming."

+ +

+ ⬇ Download the latest release +  ·  + All releases +

+ +--- + +**Vainec** is a multiplayer survival game set on a procedurally generated archipelago. +Explore, gather, craft and build, and survive the weather, the wildlife and whatever +walks in the fog. Play alone, host a world for friends, or join a dedicated server. + +> Vainec is in early development. Expect rough edges, missing features and saves that +> may not survive between versions. + +## Downloads + +Every release has three files. Pick the one you need from the +[latest release](https://git.brinke.se/vainec/game/releases/latest): + +| File | For | +|---|---| +| `Vainec-Client-Windows-.zip` | **Playing the game** on Windows | +| `Vainec-Server-Windows-.zip` | Running a dedicated server on Windows | +| `Vainec-Server-Linux-.tar.gz` | Running a dedicated server on Linux | + +The version is the UTC build time, `year.month.day.hourminute`, and is shown in the +game's main menu. Clients and servers should run the same version. + +## Playing + +1. Download `Vainec-Client-Windows-.zip`. +2. Extract the whole zip into a folder of its own. +3. Run `Vainec.exe`. + +**Requirements:** 64-bit Windows 10 or 11 and a graphics card with DirectX 12 +support. + +Windows may warn that the app is unrecognised because the build is not code-signed. +Choose **More info → Run anyway**. + +## Running a dedicated server + +The server has no graphics and runs in a terminal. It listens on **UDP port 27015** by +default, so open or forward that port for players outside your network. + +**Windows** + +```powershell +.\VainecServer.console.exe --headless +``` + +**Linux** + +```bash +mkdir vainec-server && tar -xzf Vainec-Server-Linux-.tar.gz -C vainec-server +cd vainec-server +./VainecServer.x86_64 --headless +``` + +Useful options: + +| Option | Effect | +|---|---| +| `--port=27015` | Port to listen on | +| `--world=` | World to load or create | +| `--seed=` | Seed for a newly generated world | + +Type `help` in the server console to list its commands. + +## Feedback + +Found a bug or have an idea? Tell the developer, and include the version from the main +menu. diff --git a/logo.png b/logo.png new file mode 100644 index 0000000..b469e7c Binary files /dev/null and b/logo.png differ