mirror of
https://github.com/Krevace/ow-voice-mod.git
synced 2025-12-11 20:15:13 +01:00
Initial commit
This commit is contained in:
Grayson
commit
a63b8eeef0
6
.gitignore
vendored
Normal file
6
.gitignore
vendored
Normal file
@ -0,0 +1,6 @@
|
||||
packages
|
||||
.vs
|
||||
bin
|
||||
obj
|
||||
.idea
|
||||
Build
|
||||
21
LICENSE
Normal file
21
LICENSE
Normal file
@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2020 Ricardo Lopes
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
25
ModTemplate.sln
Normal file
25
ModTemplate.sln
Normal file
@ -0,0 +1,25 @@
|
||||
|
||||
Microsoft Visual Studio Solution File, Format Version 12.00
|
||||
# Visual Studio Version 16
|
||||
VisualStudioVersion = 16.0.30204.135
|
||||
MinimumVisualStudioVersion = 10.0.40219.1
|
||||
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ModTemplate", "ModTemplate\ModTemplate.csproj", "{8A39F9E7-1A89-430C-9C3E-BDFB3B7E17DF}"
|
||||
EndProject
|
||||
Global
|
||||
GlobalSection(SolutionConfigurationPlatforms) = preSolution
|
||||
Debug|Any CPU = Debug|Any CPU
|
||||
Release|Any CPU = Release|Any CPU
|
||||
EndGlobalSection
|
||||
GlobalSection(ProjectConfigurationPlatforms) = postSolution
|
||||
{8A39F9E7-1A89-430C-9C3E-BDFB3B7E17DF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
|
||||
{8A39F9E7-1A89-430C-9C3E-BDFB3B7E17DF}.Debug|Any CPU.Build.0 = Debug|Any CPU
|
||||
{8A39F9E7-1A89-430C-9C3E-BDFB3B7E17DF}.Release|Any CPU.ActiveCfg = Release|Any CPU
|
||||
{8A39F9E7-1A89-430C-9C3E-BDFB3B7E17DF}.Release|Any CPU.Build.0 = Release|Any CPU
|
||||
EndGlobalSection
|
||||
GlobalSection(SolutionProperties) = preSolution
|
||||
HideSolutionNode = FALSE
|
||||
EndGlobalSection
|
||||
GlobalSection(ExtensibilityGlobals) = postSolution
|
||||
SolutionGuid = {3C8C943F-F2D5-4733-9CD6-9DD77B9FA9A1}
|
||||
EndGlobalSection
|
||||
EndGlobal
|
||||
29
ModTemplate/ModTemplate.cs
Normal file
29
ModTemplate/ModTemplate.cs
Normal file
@ -0,0 +1,29 @@
|
||||
using OWML.ModHelper;
|
||||
using OWML.Common;
|
||||
|
||||
namespace ModTemplate
|
||||
{
|
||||
public class ModTemplate : ModBehaviour
|
||||
{
|
||||
private void Awake()
|
||||
{
|
||||
// You won't be able to access OWML's mod helper in Awake.
|
||||
// So you probably don't want to do anything here.
|
||||
// Use Start() instead.
|
||||
}
|
||||
|
||||
private void Start()
|
||||
{
|
||||
// Starting here, you'll have access to OWML's mod helper.
|
||||
ModHelper.Console.WriteLine($"My mod {nameof(ModTemplate)} is loaded!", MessageType.Success);
|
||||
|
||||
// Example of accessing game code.
|
||||
LoadManager.OnCompleteSceneLoad += (scene, loadScene) =>
|
||||
{
|
||||
if (loadScene != OWScene.SolarSystem) return;
|
||||
var playerBody = FindObjectOfType<PlayerBody>();
|
||||
ModHelper.Console.WriteLine($"Found player body, and it's called {playerBody.name}!", MessageType.Success);
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
33
ModTemplate/ModTemplate.csproj
Normal file
33
ModTemplate/ModTemplate.csproj
Normal file
@ -0,0 +1,33 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
<PropertyGroup>
|
||||
<ProjectGuid>{8A39F9E7-1A89-430C-9C3E-BDFB3B7E17DF}</ProjectGuid>
|
||||
<TargetFramework>net48</TargetFramework>
|
||||
<OutputPath>Build</OutputPath>
|
||||
<AssemblyTitle>ModTemplate</AssemblyTitle>
|
||||
<Product>ModTemplate</Product>
|
||||
<Copyright>Copyright © 2020</Copyright>
|
||||
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
|
||||
<CopyLocalLockFileAssemblies>false</CopyLocalLockFileAssemblies>
|
||||
</PropertyGroup>
|
||||
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
|
||||
<DebugType>full</DebugType>
|
||||
</PropertyGroup>
|
||||
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
|
||||
<DebugType>none</DebugType>
|
||||
</PropertyGroup>
|
||||
<ItemGroup>
|
||||
<PackageReference Include="OWML" Version="2.1.0" />
|
||||
<PackageReference Include="OuterWildsGameLibs" Version="1.1.11.73" />
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<None Include="default-config.json">
|
||||
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
|
||||
</None>
|
||||
<None Include="manifest.json">
|
||||
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
|
||||
</None>
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<Content Include="ModTemplate.csproj.user" />
|
||||
</ItemGroup>
|
||||
</Project>
|
||||
7
ModTemplate/ModTemplate.csproj.user
Normal file
7
ModTemplate/ModTemplate.csproj.user
Normal file
@ -0,0 +1,7 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<Project ToolsVersion="Current" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
|
||||
<PropertyGroup>
|
||||
<ProjectView>ProjectFiles</ProjectView>
|
||||
<OutputPath>C:\Users\rai\AppData\Roaming\OuterWildsModManager\OWML\Mods\Raicuparta.ModTemplate</OutputPath>
|
||||
</PropertyGroup>
|
||||
</Project>
|
||||
11
ModTemplate/Properties/AssemblyInfo.cs
Normal file
11
ModTemplate/Properties/AssemblyInfo.cs
Normal file
@ -0,0 +1,11 @@
|
||||
using System.Reflection;
|
||||
using System.Runtime.CompilerServices;
|
||||
using System.Runtime.InteropServices;
|
||||
|
||||
// Setting ComVisible to false makes the types in this assembly not visible
|
||||
// to COM components. If you need to access a type in this assembly from
|
||||
// COM, set the ComVisible attribute to true on that type.
|
||||
[assembly: ComVisible(false)]
|
||||
|
||||
// The following GUID is for the ID of the typelib if this project is exposed to COM
|
||||
[assembly: Guid("8a39f9e7-1a89-430c-9c3e-bdfb3b7e17df")]
|
||||
3
ModTemplate/default-config.json
Normal file
3
ModTemplate/default-config.json
Normal file
@ -0,0 +1,3 @@
|
||||
{
|
||||
"enabled": true
|
||||
}
|
||||
8
ModTemplate/manifest.json
Normal file
8
ModTemplate/manifest.json
Normal file
@ -0,0 +1,8 @@
|
||||
{
|
||||
"filename": "ModTemplate.dll",
|
||||
"author": "Raicuparta",
|
||||
"name": "Mod Template",
|
||||
"uniqueName": "Raicuparta.ModTemplate",
|
||||
"version": "0.1.0",
|
||||
"owmlVersion": "2.0.0"
|
||||
}
|
||||
155
README.md
Normal file
155
README.md
Normal file
@ -0,0 +1,155 @@
|
||||
# Outer Wilds Mod Template
|
||||
|
||||
Use this project as a base for new Outer Wilds mods.
|
||||
|
||||
<!-- TOC -->
|
||||
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [How to use this template](#how-to-use-this-template)
|
||||
- [Editing manifest.json](#editing-manifestjson)
|
||||
- [fileName](#filename)
|
||||
- [author](#author)
|
||||
- [name](#name)
|
||||
- [uniqueName](#uniquename)
|
||||
- [version](#version)
|
||||
- [owmlVersion](#owmlversion)
|
||||
- [Editing ModTemplate.csproj.user](#editing-modtemplatecsprojuser)
|
||||
- [Updating OWML](#updating-owml)
|
||||
- [Building the mod](#building-the-mod)
|
||||
- [Releasing the mod](#releasing-the-mod)
|
||||
- [Increasing the version](#increasing-the-version)
|
||||
- [Pushing the code to GitHub](#pushing-the-code-to-github)
|
||||
- [Creating a file for the release](#creating-a-file-for-the-release)
|
||||
- [Uploading the release to GitHub](#uploading-the-release-to-github)
|
||||
- [Adding your mod to the database](#adding-your-mod-to-the-database)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
|
||||
<!-- /TOC -->
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- An IDE that supports .NET, like Visual Studio ([download Visual Studio Community here](http://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community));
|
||||
- Outer Wilds Mod Manager (get it from the [Outer Wilds Mods](https://outerwildsmods.com/) website);
|
||||
- OWML installed in the Mod Manager;
|
||||
- A GitHub account (required for forking the repo and for releasing your mod to the public);
|
||||
|
||||
## How to use this template
|
||||
|
||||
1. [Generate your repository from this template](https://github.com/Raicuparta/ow-mod-template/generate);
|
||||
2. Clone your new repository to your machine;
|
||||
3. Edit `ModTemplate/manifest.json` (see [Editing manifest.json](#editing-manifestjson) for more info);
|
||||
4. Edit `ModTemplate/ModTemplate.csproj.user` (see [Editing ModTemplate.csproj.user](#editing-modtemplatecsprojuser) for more info);
|
||||
5. Open `ModTemplate.sln` in Visual Studio (double clicking the `.sln` file should do the trick);
|
||||
6. Start writing your mod code in `ModTemplate/ModTemplate.cs` ([Read OWML's docs to learn what you can do](https://github.com/amazingalek/owml/wiki/For-modders)).
|
||||
7. [Build the mod](#building-the-mod);
|
||||
8. [Release the mod](#releasing-the-mod);
|
||||
|
||||
## Editing manifest.json
|
||||
|
||||
Use any text editor for editing this file (Notepad or whatever). The file `ModTemplate/manifest.json` should look like this:
|
||||
|
||||
```json
|
||||
{
|
||||
"filename": "ModTemplate.dll",
|
||||
"author": "AUTHOR",
|
||||
"name": "MOD_NAME",
|
||||
"uniqueName": "MOD_UNIQUE_NAME",
|
||||
"version": "0.1.0",
|
||||
"owmlVersion": "0.7.3"
|
||||
}
|
||||
```
|
||||
|
||||
Edit each entry with the correct information for your mod:
|
||||
|
||||
#### fileName
|
||||
|
||||
Visual Studio will use the project's name for the dll, so this will usually be `[ProjectName].dll`. Since this template's project name is `ModTemplate`, `fileName` will be `ModTemplate.dll`. Remember that if you change your project's name, you'll have to change this entry too.
|
||||
|
||||
#### author
|
||||
|
||||
Your beautiful name.
|
||||
|
||||
#### name
|
||||
|
||||
The human-readable name of your mod, which will show in the Mod Manager.
|
||||
|
||||
#### uniqueName
|
||||
|
||||
The unique ID of your mod. Can be anything really, as long as it isn't already taken by another mod. You can search for your `uniqueName` in the [mod database](https://raw.githubusercontent.com/Raicuparta/ow-mod-db/master/database.json) if you wanna make sure it isn't already in use.
|
||||
|
||||
#### version
|
||||
|
||||
The version number of the mod. It's important that this version number is consistent with the versions used in GitHub releases. (see [Releasing the mod](#releasing-the-mod) for more info);
|
||||
|
||||
#### owmlVersion
|
||||
|
||||
OWML version used for your mod. Only used to show a warning to users using an OWML version different than this. Just make sure that the version here is the one installed in the NuGet packages (see [Updating OWML](#updating-owml) for more info);
|
||||
|
||||
|
||||
## Editing ModTemplate.csproj.user
|
||||
|
||||
Use any text editor for editing this file (Notepad or whatever). The file `ModTemplate/ModTemplate.csproj.user` should look like this:
|
||||
|
||||
```xml
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<Project ToolsVersion="Current" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
|
||||
<PropertyGroup>
|
||||
<ProjectView>ProjectFiles</ProjectView>
|
||||
<OutputPath>OUTPUT_PATH</OutputPath>
|
||||
</PropertyGroup>
|
||||
</Project>
|
||||
```
|
||||
|
||||
Here you can replace `OUTPUT_PATH` with the path where your mod files will live.
|
||||
|
||||
Example: `C:\Users\rai\AppData\Roaming\OuterWildsModManager\OWML\Mods\Raicuparta.ModTemplate`.
|
||||
|
||||
To make your mod automatically show up in the Outer Wilds Mod Manager every time you build it, follow the format `{MODS_DIRECTORY}/{MOD_UNIQUE_NAME}`.
|
||||
|
||||
To get your `{MODS_DIRECTORY}`, open the Outer Wilds Mod Manager and click the "Mods Directory" button on the top right of the "Mods" tab. The `{MOD_UNIQUE_NAME}` part of the path is just the `uniqueName` that you defined in your mod's `manifest.json`.
|
||||
|
||||
## Updating OWML
|
||||
|
||||
It's important to keep OWML up to date in your project. In Visual Studio's Solution Explorer, right click "References" and select "Manage NuGet Packages...". In the "Installed" tab, find OWML and press the update button, if it's available (blue circle with a white arrow pointing up). After updating, make note of the new OWML version number. Update your `manifest.json` file with the latest OWML version (see [Editing manifest.json](#editing-manifestjson) for more info).
|
||||
|
||||
## Building the mod
|
||||
|
||||
Before attempting to build the mod, make sure you've edited [ModTemplate.csproj.user](#editing-modtemplatecsprojuser), and [manifest.json](#editing-manifestjson) with the correct info. After that's done, go to Visual Studio, open the "Build" menu at the top, and select "Build Solution". If all goes well, your mod should immediately show up the the Mod Manager. You can now press "Start Game" in the manager, and the game should start with your mod enabled (as long as your mod has the checkbox set to enabled).
|
||||
|
||||
## Releasing the mod
|
||||
|
||||
After you've written the code for your mod, you can release it and make it available for download.
|
||||
|
||||
#### Increasing the version
|
||||
|
||||
Always increase your mod's version in [manifest.json](#editing-manifestjson) every time you publish a new release. For instance, change it from "0.1.0" to "0.2.0".
|
||||
|
||||
#### Pushing the code to GitHub
|
||||
|
||||
If you forked the ow-mod-template repository as per the initial instructions, you now have your own version of this repository in your GitHub account. Your GitHub username will displayed as the mod's author, and the description for the mod will be fetched from the repository description on Github. The `README.md` file will be your mod's readme, so update it with instructions on how to use your mod. There's a button in the Mod Manager that will point to your mod's readme once you publish it.
|
||||
|
||||
#### Creating a file for the release
|
||||
|
||||
In the Mod Manager, find your mod, click the three dots menu button, and select "Show in explorer". You should see the directory to where your mod was built. Create a **zip** that includes all these files. This will be your release. Has to be **zip** specifically.
|
||||
|
||||
#### Uploading the release to GitHub
|
||||
|
||||
1. Go to the releases page of your repository (GitHub should show you a link to this page on the right side of the repository's page). Press "Draft a new release".
|
||||
2. In the "Tag version" field, insert the same mod version that you included in [manifest.json](#editing-manifestjson). It's very important that the release tag version is the same as the `version` field in the `manifest.json` inside the zip, otherwise your mod will always show as outdated in the Mod Manager.
|
||||
3. Release title and description are up to you.
|
||||
4. Add your zip to the release as a binary by drag & dropping the file to the release assets area (or just click "Attach binaries by etc etc" and select your file). Make sure you only upload one zip file, since anything after the first one will be ignored by the mod database / mod manager.
|
||||
5. Press "Publish release".
|
||||
|
||||
#### Adding your mod to the database
|
||||
|
||||
To make your mod show up in the Mod Manager and in [outerwildsmods.com](https://outerwildsmods.com), you need to add it to the database. [Click here to request for your mod to be added to the database](https://github.com/Raicuparta/ow-mod-db/issues/new?assignees=Raicuparta&labels=add-mod&template=add-mod.yml&title=%5BYour+mod+name+here%5D). Learn more about the Outer Wilds Mod Database in the [ow-mod-db repository](https://github.com/Raicuparta/ow-mod-db).
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
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. [More information on the ow-game-libs repo](https://github.com/Raicuparta/ow-game-libs).
|
||||
|
||||
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").
|
||||
|
||||
You'll also find references to `$(TargetPath)`, which is the path to where Visual Studio places your mod dll after building, and `$(ProjectDir)`, the path with your mod's Visual Studio project. These don't need to be defined manually, they always exist.
|
||||
Loading…
x
Reference in New Issue
Block a user