feat: now it is for real, all of the files included

Author: corp-0

.github/workflows/build.yaml

@@ -1,10 +1,15 @@
+# Build output
+tts/
+build/
+
 # .NET
 bin/
 obj/
 *.user
 *.suo
 .vs/
 publish/
+server/HonkTTS.Installer.exe
 
 # Python
 __pycache__/

.gitignore

@@ -1,18 +1,51 @@
 # HonkTTS
 
-This repo will be the future local TTS server for Unitystation. Idea is for the client to run locally their own instance of 
-HonkTTS and their game to request audio data from it, then deserialize and convert into ``wav`` so they can be set as clip
-in an AudioSource and played using the same pipeline any ingame sound uses, being affected by ambient, spatial and 
-following their source.
+HonkTTS is the text-to-speech service used by Unitystation to generate immersive in-game voices.  
+It is an optional module that runs alongside the game and is orchestrated by StationHub.
 
-## Development Requirements
+This repository contains:
+- The Python TTS server (`server/tts_server.py`)
+- Scripts to run and test the server
+- A cross-platform .NET installer (`installer/`) that packages and sets up everything
 
-- [Python 3.11](https://www.python.org/downloads/release/python-3110/)
-- [espeak-ng installed](https://github.com/espeak-ng/espeak-ng/blob/master/docs/guide.md)
+## Latest Installer
 
-## User requirements
-Idea is to compile the application using Nuitka and uploading an artifact for each supported platform. The final users 
-would need to download this executable and set its path inside the game for it to establish communication with it.
+Download the latest installer build from GitHub Releases:
 
-Sadly, the final user also needs [espeak-ng installed](https://github.com/espeak-ng/espeak-ng/blob/master/docs/guide.md). 
-In the case of a Mac user, they would have to [use this homebrew](https://formulae.brew.sh/formula/espeak-ng) (untested).
+`https://github.com/unitystation/honk_tts/releases`
+
+If you only want to use HonkTTS (not develop it), start there.
+
+## Contributing Prerequisites
+
+Required:
+- Git (clone/push workflow)
+- `.NET SDK 10` (project targets `net10.0`)
+
+Useful depending on what you change:
+- Python 3.10+ (for direct server work and local script testing)
+
+## Start Contributing
+
+1. Clone the repo.
+2. Build and run the local end-to-end flow:
+   - Windows: `dev.bat`
+   - Linux/macOS: `./dev.sh`
+3. This will:
+   - Build the installer
+   - Install into `./tts` (including Python runtime and dependencies)
+   - Run server tests (`test_tts`)
+
+The `dev` flow is enough to start iterating even without a system Python install.  
+You can edit the checked-in scripts/source in this repo, rerun `dev`, and validate changes against the locally installed `./tts` instance.
+
+If you only want to build artifacts:
+- Windows: `build.bat`
+- Linux/macOS: `./build.sh`
+
+## Project Layout
+
+- `server/` - TTS API server and runtime scripts
+- `installer/` - Native AOT .NET installer source
+- `build*.{bat,sh}` - local build/package scripts
+- `dev*.{bat,sh}` - quick contributor workflow scripts

README.md

@@ -0,0 +1,34 @@
+@echo off
+setlocal
+
+set "ROOT=%~dp0"
+set "OUT=%ROOT%build"
+
+echo Cleaning output directory...
+if exist "%OUT%" rmdir /s /q "%OUT%"
+mkdir "%OUT%"
+mkdir "%OUT%\scripts"
+
+echo Copying server files...
+copy "%ROOT%server\tts_server.py" "%OUT%\" >nul
+copy "%ROOT%server\requirements.txt" "%OUT%\" >nul
+copy "%ROOT%server\scripts\start_tts.bat" "%OUT%\scripts\" >nul
+copy "%ROOT%server\scripts\start_tts.sh" "%OUT%\scripts\" >nul
+copy "%ROOT%server\scripts\test_server.py" "%OUT%\scripts\" >nul
+copy "%ROOT%server\scripts\test_tts.bat" "%OUT%\scripts\" >nul
+copy "%ROOT%server\scripts\test_tts.sh" "%OUT%\scripts\" >nul
+
+echo Building installer (Release, Native AOT, win-x64)...
+dotnet publish "%ROOT%installer\src\HonkTTS.Installer\HonkTTS.Installer.csproj" ^
+    -r win-x64 -c Release ^
+    -o "%OUT%" ^
+    --nologo
+
+if %errorlevel% neq 0 (
+    echo Build failed.
+    exit /b 1
+)
+
+echo.
+echo Build complete: %OUT%
+dir /b "%OUT%"

build.bat

@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+ROOT="$(cd "$(dirname "$0")" && pwd)"
+OUT="$ROOT/build"
+
+echo "Cleaning output directory..."
+rm -rf "$OUT"
+mkdir -p "$OUT/scripts"
+
+echo "Copying server files..."
+cp "$ROOT/server/tts_server.py" "$OUT/"
+cp "$ROOT/server/requirements.txt" "$OUT/"
+cp "$ROOT/server/scripts/start_tts.bat" "$OUT/scripts/"
+cp "$ROOT/server/scripts/start_tts.sh" "$OUT/scripts/"
+cp "$ROOT/server/scripts/test_server.py" "$OUT/scripts/"
+cp "$ROOT/server/scripts/test_tts.bat" "$OUT/scripts/"
+cp "$ROOT/server/scripts/test_tts.sh" "$OUT/scripts/"
+
+ARCH="$(uname -m)"
+case "$(uname -s)" in
+    Linux*)  RID="linux-x64"; [ "$ARCH" = "aarch64" ] && RID="linux-arm64" ;;
+    Darwin*) RID="osx-x64";   [ "$ARCH" = "arm64" ]   && RID="osx-arm64"  ;;
+    *)       echo "Unsupported OS"; exit 1 ;;
+esac
+
+echo "Building installer (Release, Native AOT, $RID)..."
+dotnet publish "$ROOT/installer/src/HonkTTS.Installer/HonkTTS.Installer.csproj" \
+    -r "$RID" -c Release \
+    -o "$OUT" \
+    --nologo
+
+echo ""
+echo "Build complete: $OUT"
+ls "$OUT"

build.sh

@@ -0,0 +1,14 @@
+@echo off
+setlocal
+
+set "ROOT=%~dp0"
+set "TARGET=%ROOT%tts"
+
+call "%ROOT%build.bat"
+if errorlevel 1 exit /b %errorlevel%
+
+"%ROOT%build\HonkTTS.Installer.exe" "%TARGET%"
+if errorlevel 1 exit /b %errorlevel%
+
+call "%ROOT%tts\test_tts.bat" --keep %*
+exit /b %errorlevel%

dev.bat

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+ROOT="$(cd "$(dirname "$0")" && pwd)"
+TARGET="$ROOT/tts"
+
+"$ROOT/build.sh"
+
+INSTALLER="$ROOT/build/HonkTTS.Installer"
+if [ -x "$INSTALLER" ]; then
+  "$INSTALLER" "$TARGET"
+elif [ -x "$INSTALLER.exe" ]; then
+  "$INSTALLER.exe" "$TARGET"
+else
+  echo "Installer binary not found in $ROOT/build"
+  exit 1
+fi
+
+"$ROOT/tts/test_tts.sh" --keep "$@"

dev.sh

@@ -0,0 +1,18 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+VisualStudioVersion = 17.0.31903.59
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "HonkTTS.Installer", "src\HonkTTS.Installer\HonkTTS.Installer.csproj", "{A1B2C3D4-E5F6-7890-ABCD-EF1234567890}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{A1B2C3D4-E5F6-7890-ABCD-EF1234567890}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{A1B2C3D4-E5F6-7890-ABCD-EF1234567890}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{A1B2C3D4-E5F6-7890-ABCD-EF1234567890}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{A1B2C3D4-E5F6-7890-ABCD-EF1234567890}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+EndGlobal

installer/HonkTTS.Installer.sln

@@ -0,0 +1,14 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net10.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+    <PublishAot>true</PublishAot>
+    <InvariantGlobalization>true</InvariantGlobalization>
+    <RootNamespace>HonkTTS.Installer</RootNamespace>
+    <AssemblyName>HonkTTS.Installer</AssemblyName>
+  </PropertyGroup>
+
+</Project>

installer/src/HonkTTS.Installer/HonkTTS.Installer.csproj

@@ -0,0 +1,65 @@
+namespace HonkTTS.Installer.Models;
+
+public sealed class InstallConfig
+{
+    public string BaseDir { get; }
+
+    public string PythonDir => Path.Combine(BaseDir, "python");
+    public string VenvDir => Path.Combine(BaseDir, "venv");
+    public string EspeakDir => Path.Combine(BaseDir, "espeak-ng");
+    public string ServerDir => Path.Combine(BaseDir, "server");
+    public string TempDir => Path.Combine(BaseDir, ".tmp");
+
+    public string PythonExe => Path.Combine(PythonDir, PlatformInfo.PythonExeRelative);
+    public string PipExe => Path.Combine(PythonDir, PlatformInfo.PipExeRelative);
+    public string VenvPythonExe => Path.Combine(VenvDir, PlatformInfo.VenvPythonRelative);
+    public string VenvPipExe => Path.Combine(VenvDir, PlatformInfo.VenvPipRelative);
+
+    public string EspeakExe => Path.Combine(EspeakDir, PlatformInfo.IsWindows ? "espeak-ng.exe" : "espeak-ng");
+    public string EspeakDataDir => Path.Combine(EspeakDir, "espeak-ng-data");
+
+    public string StartScript => PlatformInfo.IsWindows
+        ? Path.Combine(BaseDir, "start_tts.bat")
+        : Path.Combine(BaseDir, "start_tts.sh");
+    public string TestScript => PlatformInfo.IsWindows
+        ? Path.Combine(BaseDir, "test_tts.bat")
+        : Path.Combine(BaseDir, "test_tts.sh");
+    public string MetadataFile => Path.Combine(BaseDir, "config.json");
+
+    public string SourceServerDir { get; }
+
+    public InstallManifest? InstalledManifest { get; set; }
+
+    public InstallManifest ExpectedManifest { get; set; } = new();
+
+    public static InstallConfig FromArgs(string[] args)
+    {
+        var baseDir = args.Length > 0
+            ? args[0]
+            : Path.Combine(
+                Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData),
+                "StationHub", "Installations", "tts");
+
+        return new InstallConfig(baseDir);
+    }
+
+    private InstallConfig(string baseDir)
+    {
+        BaseDir = Path.GetFullPath(baseDir);
+
+        // The server source is located relative to the installer binary or CWD.
+        var candidates = new[]
+        {
+            Path.Combine(AppContext.BaseDirectory, "..", "..", "..", "..", "..", "server"),
+            Path.Combine(AppContext.BaseDirectory, "server"),
+            Path.Combine(Directory.GetCurrentDirectory(), "server"),
+            Path.Combine(Directory.GetCurrentDirectory(), "..", "server"),
+        };
+
+        SourceServerDir = candidates
+            .Select(d => Path.GetFullPath(d))
+            .FirstOrDefault(d => File.Exists(Path.Combine(d, "tts_server.py")))
+            ?? throw new DirectoryNotFoundException(
+                "Could not locate server/tts_server.py relative to the installer.");
+    }
+}