From 3e28840fe4fdb81f48d16fe80e6800261e2e9755 Mon Sep 17 00:00:00 2001 From: Esper Thomson Date: Wed, 3 Jan 2024 02:01:01 -0500 Subject: [PATCH] Updated readme. --- README.md | 32 +++++++++++++++++++------------- 1 file changed, 19 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index bdd83db..2503a03 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ example of how to do this. ```cs var asm = System.Reflection.Assembly.GetExecutingAssembly(); var patch = asm.GetManifestResourceStream("MyModName.my-file-name.optoctreepatch"); -TerrainPatcher.TerrainRegistry.PatchTerrain(patch); +TerrainPatcher.TerrainRegistry.PatchTerrain("my-file-name", patch); ``` ### Dependency Registration @@ -73,6 +73,16 @@ add the `[BepInDependency("Esper89.TerrainPatcher")]` attribute to your mod's en internal class Mod : BaseUnityPlugin { /* ... */ } ``` +### Licensing + +Terrain Patcher is licensed under the GNU AGPL, which says that derivative works must also be +licensed under the GNU AGPL. If your mod directly interacts with Terrain Patcher (e.g. by +referencing `TerrainPatcher.dll` and calling `TerrainPatcher.TerrainRegistry.PatchTerrain`), it +might be considered a derivative work. To avoid any possible copyright issues, if your mod isn't +licensed under the GNU AGPL, you should avoid referencing `TerrainPatcher.dll` or otherwise +interacting with Terrain Patcher directly. Patches can still be loaded without referencing Terrain +Patcher by distributing them alongside your mod. + ## Patch Format The Subnautica Terrain Patch Format (the `optoctreepatch` format) is documented in @@ -137,18 +147,14 @@ also create a `dist.zip` file in `target` for easy distribution. ## License -``` -Copyright (C) 2021, 2023 Esper Thomson +Copyright © 2021, 2023 Esper Thomson -This program is free software: you can redistribute it and/or modify -it under the terms of version 3 of the GNU Affero General Public License -as published by the Free Software Foundation. +This program is free software: you can redistribute it and/or modify it under the terms of version +3 of the GNU Affero General Public License as published by the Free Software Foundation. -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU Affero General Public License for more details. +This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without +even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero +General Public License for more details. -You should have received a copy of the GNU Affero General Public License -along with this program. If not, see . -``` +You should have received a copy of the GNU Affero General Public License along with this program. +If not, see .