Skip to content
This repository has been archived by the owner on Oct 24, 2022. It is now read-only.

Commit

Permalink
Remove references to GameDir since it's now redundant
Browse files Browse the repository at this point in the history
  • Loading branch information
Raicuparta committed Nov 17, 2021
1 parent c833d1f commit 0d902c3
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 19 deletions.
1 change: 0 additions & 1 deletion ModTemplate/ModTemplate.csproj.user
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
<Project ToolsVersion="Current" xmlns="http:https://schemas.microsoft.com/developer/msbuild/2003">
<PropertyGroup>
<ProjectView>ProjectFiles</ProjectView>
<GameDir>C:\Program Files\Epic Games\OuterWilds</GameDir>
<OwmlDir>C:\Users\rai\AppData\Roaming\OuterWildsModManager\OWML</OwmlDir>
<ModUniqueName>Raicuparta.ModTemplate</ModUniqueName>
</PropertyGroup>
Expand Down
9 changes: 0 additions & 9 deletions ModTemplate/ModTemplate.user

This file was deleted.

12 changes: 3 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Use this project as a base for new Outer Wilds mods.
- [Prerequisites](#prerequisites)
- [How to use this template](#how-to-use-this-template)
- [Editing ModTemplate.csproj.user](#editing-modtemplatecsprojuser)
- [`<GameDir>`](#gamedir)
- [`<OwmlDir>`](#owmldir)
- [`<ModUniqueName>`](#moduniquename)
- [Editing manifest.json](#editing-manifestjson)
Expand Down Expand Up @@ -56,18 +55,13 @@ Use any text editor for editing this file (Notepad or whatever). The file `ModTe
<Project ToolsVersion="Current" xmlns="http:https://schemas.microsoft.com/developer/msbuild/2003">
<PropertyGroup>
<ProjectView>ProjectFiles</ProjectView>
<GameDir>GAME_DIR</GameDir>
<OwmlDir>OWML_DIR</OwmlDir>
<ModUniqueName>MOD_UNIQUE_NAME</ModUniqueName>
</PropertyGroup>
</Project>
```

You need to replace `GAME_DIR`, `OWML_DIR` and `MOD_UNIQUE_NAME` between the tags. Be careful not to change the tags themselves (the stuff between `< >`, since that will break the file). Remember to restart Visual Studio (or just reload your mod project) if you edit this file, otherwise the changes won't be applied.

#### `<GameDir>`

This is the directory that contains the game's executable (`OuterWilds.exe`). Don't include the executable in the path, just the directory;
You need to replace `OWML_DIR` and `MOD_UNIQUE_NAME` between the tags. Be careful not to change the tags themselves (the stuff between `< >`, since that will break the file). Remember to restart Visual Studio (or just reload your mod project) if you edit this file, otherwise the changes won't be applied.

#### `<OwmlDir>`

Expand Down Expand Up @@ -156,9 +150,9 @@ To make your mod show up in the Mod Manager and in [outerwildsmods.com](https://

## Troubleshooting

If you open `ModTemplate/ModTemplate.csproj`, you'll find references to `$(GameDir)`, `$(OwmlDir)`, and `$(ModUniqueName)`. The value of these variables is read from `ModTemplate/ModTemplate.csproj.user`.
A NuGet package called `OuterWildsGameLibs` is used to get references to the game code. If a game update has been released and this nuget hasn't been updated yet, you might need to reference the game libraries manually.

`$(GameDir)` is used to find references to the needed dll files in `$(GameDir)\OuterWilds_Data\Managed\**.dll`. If you are having problems with missing references (yellow exclamation mark warning icon in Visual Studio reference list), you should double-check your `csproj.user` file, or find the references manually (Right click References in Solution Explorer, select "Add References").
If you open `ModTemplate/ModTemplate.csproj`, you'll find references to `$(OwmlDir)` and `$(ModUniqueName)`. The value of these variables is read from `ModTemplate/ModTemplate.csproj.user`.

`$(OwmlDir)` and `$(ModUniqueName)` are used in the post-build events, to copy the built mod files (and static files like `manifest.json` and `default-config.json`) to the mod directory in `"$(OwmlDir)\Mods\$(ModUniqueName)"`. If you are having problems with post-build events, you can edit them manually in Visual Studio (double click Properties in Solution Explorer, select "Build Events").

Expand Down

0 comments on commit 0d902c3

Please sign in to comment.