Vainec

README.md

@@ -0,0 +1,80 @@
+<p align="center">
+  <img src="logo.png" alt="Vainec Protocol" width="280">
+</p>
+
+<p align="center"><em>"We build to remember who we were. We fight to forget what we are becoming."</em></p>
+
+<p align="center">
+  <a href="https://git.brinke.se/vainec/game/releases/latest"><strong>⬇ Download the latest release</strong></a>
+  &nbsp;·&nbsp;
+  <a href="https://git.brinke.se/vainec/game/releases">All releases</a>
+</p>
+
+---
+
+**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-<version>.zip` | **Playing the game** on Windows |
+| `Vainec-Server-Windows-<version>.zip` | Running a dedicated server on Windows |
+| `Vainec-Server-Linux-<version>.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-<version>.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-<version>.tar.gz -C vainec-server
+cd vainec-server
+./VainecServer.x86_64 --headless
+```
+
+Useful options:
+
+| Option | Effect |
+|---|---|
+| `--port=27015` | Port to listen on |
+| `--world=<name>` | World to load or create |
+| `--seed=<number>` | 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.