From 22d39dc8feefc278eaa812bdec454f94a29c23f2 Mon Sep 17 00:00:00 2001 From: Ellpeck Date: Thu, 17 Jun 2021 18:46:02 +0200 Subject: [PATCH] explain any kind of custom content in the readme --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 7fc6ef3..d0f0151 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,16 @@ # Tiny Life Example Mod An example mod for my game Tiny Life. Use this template repository to create your own mod! -# Installing mods -Installing a mod is pretty simple: -- Find the `Tiny Life` folder (you can open it from the game's options menu) -- Find the `Mods` folder in there -- If you received the mod you want to install as a `zip` (or any other kind of) archive, extract it first -- Put the mod's `dll` as well as its `Content` folder into the `Mods` folder. +# Getting custom content +You can get custom lots, households and mods from [the community](https://itch.io/board/1032686/mods). -Done! Now just start the game and the mod should automatically load. If there are any errors, they'll be logged in the most recent file in the `Tiny Life/Logs` folder. +Installing a mod or other custom content is pretty simple: +- Find the `Tiny Life` folder (you can open it from the game's options menu) +- Find the `Mods` (or `Custom Lots` or `Custom Households`) folder in there + - For mods, if you received it as a `zip` (or any other kind of archive), extract it first, and then put the mod's `dll` as well as its `Content` folder into the `Mods` folder. + - For custom lots and households, simply put the `json` file(s) you received into the respective folder. + +Done! Now just start the game and the added content should automatically load. If there are any errors, they'll be logged in the most recent file in the `Tiny Life/Logs` folder. # Creating mods To create a mod, all you have to do is create a repository [from this template](https://github.com/Ellpeck/TinyLifeExampleMod/generate) and open the project contained in it using Visual Studio, Rider or any other kind of C# IDE. The code that is already there contains some examples. Once you're done checking them out, you can just delete them and start fresh. @@ -31,7 +33,7 @@ Technically, you can [download the game](https://tinylifegame.com/) and then dec ## Dependency version history Since the mod is compiled against the same dependencies as Tiny Life, it also needs to have the same versions of those dependencies for mods to work correctly with the game. Each update to this repository is [tagged](https://github.com/Ellpeck/TinyLifeExampleMod/tags) with the game's version number. If you want to develop for a certain version, just check that tag's [project file](https://github.com/Ellpeck/TinyLifeExampleMod/blob/main/ExampleMod.csproj) to see the required dependency versions. -# Testing Cheats +# Testing cheats You can open up the game's cheat menu by pressing the `F1` key. Here is a list of some of the more useful cheats for mod development and testing. Keep in mind that `[arguments]` need to be replaced with your custom value. - `ShowNonBuyable` allows you to buy plates, pots and the like - `Need [name] [percentage <= 1]` changes the current person's needs