Add OWML mod skeleton and import English translation template
Phase 2 (mod skeleton) + Phase 3 (import English source): - manifest.json / SlovakTranslation.cs / ILocalizationAPI.cs registering "Slovenčina" via xen.LocalizationUtility (Interplanetary Polyglot). - SlovakTranslation.csproj / .sln building net48 against the OWML and OuterWildsGameLibs NuGet packages — no game install needed to compile. - assets/Translation.xml: English source template (896 KB, 2424 entries, keys == values) to be translated into Slovak. - Project docs (README/PLAN/CLAUDE) and .gitignore. Build verified: dotnet build -c Release stages a loadable mod folder. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -1,2 +1,70 @@
|
||||
# Outer-Wilds-SK-Translation-Mod
|
||||
# Outer Wilds — Slovenský preklad / Slovak Translation Mod
|
||||
|
||||
> **Neoficiálny slovenský preklad hry Outer Wilds** (základná hra + rozšírenie
|
||||
> *Echoes of the Eye*). Pridáva do hry jazyk **Slovenčina**.
|
||||
>
|
||||
> *An unofficial Slovak (slovenčina) translation mod for Outer Wilds, covering
|
||||
> the base game and the Echoes of the Eye DLC.*
|
||||
|
||||
**Stav / Status:** 🚧 **Work in progress** — the mod scaffold and translation are
|
||||
being built. See [`PLAN.md`](PLAN.md) for the roadmap.
|
||||
|
||||
Outer Wilds officially ships in 12 languages; Slovak is not one of them. This mod
|
||||
adds it as a new selectable language using the community localization framework —
|
||||
no changes to the game's own files are required.
|
||||
|
||||
---
|
||||
|
||||
## How it works
|
||||
|
||||
The mod is a small [OWML](https://github.com/ow-mods/owml) mod that registers a
|
||||
new language through **[Interplanetary Polyglot / Localization Utility](https://outerwildsmods.com/mods/interplanetarypolyglot/)**
|
||||
(`xen.LocalizationUtility`). All translated text lives in a single
|
||||
`assets/Translation.xml`; the utility swaps the game's strings for the Slovak ones
|
||||
at runtime.
|
||||
|
||||
## Installation
|
||||
|
||||
1. Install the **[Outer Wilds Mod Manager](https://outerwildsmods.com/mod-manager/)**.
|
||||
2. Install this mod through the Mod Manager. Its dependency **Interplanetary
|
||||
Polyglot** (`xen.LocalizationUtility`) will be pulled in automatically.
|
||||
3. Launch the game via the Mod Manager.
|
||||
4. In **Settings → Language**, choose **Slovenčina**.
|
||||
- Tip: the optional [Language Swap](https://outerwildsmods.com/mods/languageswap/)
|
||||
mod lets you switch language in-game with `Ctrl+L`.
|
||||
|
||||
> Until the first release is published, the mod is not yet in the Mod Manager
|
||||
> database — see [`PLAN.md`](PLAN.md) for how to build it from source.
|
||||
|
||||
## Contributing / Prispievanie
|
||||
|
||||
Translation fixes are very welcome — the goal is natural, consistent Slovak.
|
||||
|
||||
- **Report** mistranslations or awkward phrasing as an issue.
|
||||
- **Edit** only the `<value>` of each entry in `assets/Translation.xml`.
|
||||
**Never change the `<key>`** — it is the English identifier the game matches on.
|
||||
- Preserve all inline formatting exactly, e.g. `<color=orange>…</color>`,
|
||||
`<i>`, and speaker prefixes like `POKE:`.
|
||||
- Follow the terminology in `docs/glossary.md` so names (Nomai, the Eye, Ash Twin
|
||||
Project, …) stay consistent across the whole game.
|
||||
|
||||
See [`CLAUDE.md`](CLAUDE.md) for the full conventions and repo layout.
|
||||
|
||||
## License & disclaimer
|
||||
|
||||
The **original mod code and the Slovak translation** in this repository are
|
||||
released under the [MIT License](LICENSE).
|
||||
|
||||
This is an **unofficial** fan project. It is **not affiliated with, approved by, or
|
||||
endorsed by Mobius Digital or Annapurna Interactive.** *Outer Wilds*, its story,
|
||||
dialogue, characters, and other assets are **© Mobius Digital / Annapurna
|
||||
Interactive**; the underlying game text remains their property and is used here
|
||||
under **Mobius Digital's Fan Content Policy**. The MIT license covers only this
|
||||
project's own contributions, not the source material.
|
||||
|
||||
## Credits
|
||||
|
||||
- **Mobius Digital / Annapurna Interactive** — *Outer Wilds*.
|
||||
- **[xen-42](https://github.com/xen-42)** — the Localization Utility /
|
||||
Interplanetary Polyglot framework this mod is built on.
|
||||
- The Outer Wilds modding community.
|
||||
|
||||
Reference in New Issue
Block a user