From 3964c9d0e9c8e04249a4d3bccbf24d73602c5674 Mon Sep 17 00:00:00 2001 From: Ellpeck Date: Thu, 4 Nov 2021 14:17:00 +0100 Subject: [PATCH] added a guide for finding the data directory --- articles/game_dir.md | 33 +++++++++++++++++++++++++++++++++ articles/getting.md | 2 +- articles/mod_basics.md | 2 +- articles/toc.yml | 2 ++ 4 files changed, 37 insertions(+), 2 deletions(-) create mode 100644 articles/game_dir.md diff --git a/articles/game_dir.md b/articles/game_dir.md new file mode 100644 index 0000000..16d0dfd --- /dev/null +++ b/articles/game_dir.md @@ -0,0 +1,33 @@ +# Finding Tiny Life's Data Folder +Tiny Life's data folder contains the save files, the log files and the folders that you can put custom lots, households and mods into. There are several ways of locating it, and its location differs based on the operating system you're using. + +## From within the game +You can open the data folder easily from within the game by going to the options menu and opening the rightmost tab ("Custom Content"). The tab contains a button to quickly open the data folder. + +## From your computer +### Windows +On Windows, you can simply open a file explorer window and paste the following text into its location field: +``` +%LocalAppData%\Tiny Life +``` +This should automatically cause the explorer to navigate to the appropriate folder. + +### Linux +On Linux, you have to navigate to your home directory (also known as `~`) first. This is usually `/home/username`. From there, you can navigate to `.local/share/Tiny Life`. + +Since `.local` is usually a hidden folder, you might have to configure your file explorer to display hidden files as well. + +You can also use a commandline to navigate to the folder directly using the following command: +``` +cd ~/.local/share/Tiny Life +``` + +### Mac +On Mac, you have to navigate to your home directory (also known as `~`) first. This is usually `Macintosh HD/Users/username`. From there, you can navigate to `.local/share/Tiny Life`. + +Since `.local` is usually a hidden folder, you might have to configure your finder to display hidden files by pressing `Cmd + Shift + .` together. + +You can also use a commandline to navigate to the folder directly using the following command: +``` +cd ~/.local/share/Tiny Life +``` \ No newline at end of file diff --git a/articles/getting.md b/articles/getting.md index 7d92665..0da8864 100644 --- a/articles/getting.md +++ b/articles/getting.md @@ -2,7 +2,7 @@ You can get custom lots, households and mods from [the community](https://itch.io/board/1032686/mods). 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 `Tiny Life` folder by following [this simple guide](game_dir.md) - 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. diff --git a/articles/mod_basics.md b/articles/mod_basics.md index c0fa179..2789b80 100644 --- a/articles/mod_basics.md +++ b/articles/mod_basics.md @@ -4,7 +4,7 @@ This page sums up a few of the basics that you'll need to know if you want to ma ## 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. -The template repository also contains a little `Run` script for [windows](https://github.com/Ellpeck/TinyLifeExampleMod/blob/main/Run.bat) and [linux and mac](https://github.com/Ellpeck/TinyLifeExampleMod/blob/main/Run.sh) that automatically builds your mod, copies it into the `Mods` directory of your Tiny Life instance and runs the game. Note that the script will only work correctly if you've previously launched Tiny Life manually. +The template repository also contains a little `Run` script for [windows](https://github.com/Ellpeck/TinyLifeExampleMod/blob/main/Run.bat) and [linux and mac](https://github.com/Ellpeck/TinyLifeExampleMod/blob/main/Run.sh) that automatically builds your mod, copies it into the `Mods` directory of your Tiny Life instance and runs the game. Note that the script will only work correctly if you've launched Tiny Life manually at least once before. The game's API is **fully documented**. The documentation is easily accessible by opening any of the API's files in your IDE. The most updated version can be found on this site as well. diff --git a/articles/toc.yml b/articles/toc.yml index a06d5d6..09d35bb 100644 --- a/articles/toc.yml +++ b/articles/toc.yml @@ -8,5 +8,7 @@ href: creating_textures.md - name: Contributing Localizations href: localization.md +- name: Finding the Data Folder + href: game_dir.md - name: Testing Cheats href: cheats.md \ No newline at end of file