Ellpeck/TinyLifeExampleMod
1
0
Fork 0
mirror of https://github.com/Ellpeck/TinyLifeExampleMod.git synced 2024-11-22 20:08:34 +01:00
Code Issues Projects Releases Wiki Activity

explain any kind of custom content in the readme

Browse source
This commit is contained in:
Ell 2021-06-17 18:46:02 +02:00
parent 0ce7b27ef4
commit 22d39dc8fe
1 changed files with 10 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -1,14 +1,16 @@
# Tiny Life Example Mod # Tiny Life Example Mod
An example mod for my game Tiny Life. Use this template repository to create your own mod! An example mod for my game Tiny Life. Use this template repository to create your own mod!
# Installing mods # Getting custom content
Installing a mod is pretty simple: You can get custom lots, households and mods from [the community](https://itch.io/board/1032686/mods).
- 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.
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 # 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. 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 ## 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. 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. 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 - `ShowNonBuyable` allows you to buy plates, pots and the like
- `Need [name] [percentage <= 1]` changes the current person's needs - `Need [name] [percentage <= 1]` changes the current person's needs