doughphunghus/How to install 7 Days to Die modlets.txt

## How to install 7 Days to Die modlets.txt
Last updated: July 4, 2020

Don't be discouraged by all this text!
The basic process is actually *very* easy and is "usually" painless and works.
I'm just documenting a lot of the pitfalls should this be your first time to try adding modlets to the game.

This is a long, drawn out discussion over how to ***manually*** load modlets into "7 Days to Die" ("modlets". Not mods or overhauls).

This does **not** cover how to use mod launchers, which I recommend you use if you can. You can find them by
searching on the "Tools" forum on the 7 Days to die forums: https://community.7daystodie.com/forum/33-tools/

########################################
# Information about Mod/Modlet "types"
########################################
There are several ways a mod for 7 Days to Die can be made.  Here's a link to the forums that categorizes them
for modders: https://community.7daystodie.com/topic/10732-definitions-of-the-types-of-mods-found-in-this-forum/

Just to reiterate: These instructions are for "Modlets" only as there may be additional steps/tools to load for other types.
Usually these other types will specify what is needed to load/build them.  If there is no additional documantion
it likely is a modlet.  Hopefully the modding author specifies/documents this somewhere, but not all do.
Additionally: Some modding authors just say "Mod" and its really a modlet as the name "Modlet" doesn't seem to sit
well with everyone ;)

########################################
# Game versions
########################################
This document addresses the game "7 Days to Die" versions on PC's.
- alpha 17
- alpha 18
- alpha 19

Note: To date you cannot add modlets to the game played on Consoles (PS4/XBox).

########################################
# Find modlets you want to try out
########################################
Modlets can be found in several locations. Most notable are these forums which will help you find them
Mods forum: https://community.7daystodie.com/forum/27-mods/
Older Mods list (a18 and older): https://community.7daystodie.com/topic/5429-mod-list/
Newer Mods list (a18 and newer): https://community.7daystodie.com/topic/18946-new-mod-list-project/

Sometimes people put their mods here on Github or Nexusmods (https://www.nexusmods.com/7daystodie) or
personal dropbox. A https://7daystodiemods.com/ website was made recently (2019) for easy browsing/searching of mods
that just points back to mods on other forums.

########################################
# A note about modlet version compatibilty issues
########################################
Its very annoying when you're several hours into a game and you realize a modlet you loaded isn't
working/is broken/isn't compatible with the game version you're using.
Because of this, try to make sure the modlet you want to load is compatible with the version of the
game you are using before you start a long game.

"7 Days to Die" "alpha" versions change frequently so modlets may break in different versions of the game
(or even minor patches to a version).  The version that the modlet was built/tested on *may*:
- Be located in a file called "ModInfo.xml" in the modlet, in some field/description.
- Be in a README file inside the modlet.
- Be in a forum post or dowload location where the modlet was found.
- Not be listed anywhere.

If in doubt, you can just load it and when the game is starting press "F1" and watch everything load.
If you see errors/warnings it will generally tell you what file/modlet it occurred in (but not always).

Loading "version incompatible" modlets generally doesn't do any harm to the game itself, but sometimes
it may cause the game to freeze/crash/throw errors (seen via pressing "F1").

Another issue you may see with incompatible modlets is missing graphics (for that modlet).

There are many other small issues that can occur with version incompatibilities that mainly hamper
seamles gaemplay

########################################
# Prepare the game to load modlets
########################################
You need to create a single folder to put modlets into.

Locate the "7 Days to Die" game home folder on your PC
- If using Steam: Right click on the game in the game library, and choose "properties".
Go to the "Local Files" tab -> "Browse Local files"

- If using Steam and Windows, it's likely in this location:
C:\Program Files (x86)\Steam\steamapps\common\7 Days to Die

- If using Steam and Ubuntu, it's likely in this location:
~/.local/share/Steam/steamapps/common/7 Days To Die

2. If you do not have it already, create a folder/directory called "Mods" in this location.
Note: This folder/directory name is case sensitive (use a capital "M")

Note (per info/comments from simkorn266.  Thanks!): If installing for Linux server (7DTD):\
- If installing for Linux server (7DTD) dont forget to change the folder to change the Mods folder to 777(permision)\
- And take a look in the Mods folder if the .xml is to execute

Note: From this point on I will reference folders/directories as simply "folders" since the majority
of people are likely using Windows OS for this game.

########################################
# Get some modlets to put into the Mods folder.
########################################
After downloading some modlets, make sure you know what modlet folder to use! Many modlets are
zipped/tarballed or are part of "modlet collections" containing multiple modlets. You cannot load
a zipped/tarballed modlet, it must be extracted first to get to the correct modlet folder, which may
result in extra folders being created.

The "correct" folder to use in the next step to load a single modlet is the one that contains
the "ModInfo.xml" file. Consider you have downloaded and unzipped a modlet called "Final Folder"
and now you have this folder structure for example:
  .../Downloads/SomeFolder/SomeOtherFolder/YetAnotherFolder/FinalFolder/ModInfo.xml

In this case, the "modlet" is the "FinalFolder" folder.

Copy that modlet folder and everything in it into the "Mods" folder

########################################
# Run the game
########################################
Note: Some warnings may appear from some modlets (or they may fail to load)
This may be "normal", or may be because the modlet author has written the modlet for a different
version of the game than you are using.  Its also possible that if you have loaded many modlets
that they are "colliding" with each other (changing or using the same internal game settings/names/etc).
If you see a lot of collisions the modlets may not work as advertised.
	Last updated: July 4, 2020

	Don't be discouraged by all this text!
	The basic process is actually very easy and is "usually" painless and works.
	I'm just documenting a lot of the pitfalls should this be your first time to try adding modlets to the game.

	This is a long, drawn out discussion over how to *manually* load modlets into "7 Days to Die" ("modlets". Not mods or overhauls).

	This does not cover how to use mod launchers, which I recommend you use if you can. You can find them by
	searching on the "Tools" forum on the 7 Days to die forums: https://community.7daystodie.com/forum/33-tools/

	########################################
	# Information about Mod/Modlet "types"
	########################################
	There are several ways a mod for 7 Days to Die can be made. Here's a link to the forums that categorizes them
	for modders: https://community.7daystodie.com/topic/10732-definitions-of-the-types-of-mods-found-in-this-forum/

	Just to reiterate: These instructions are for "Modlets" only as there may be additional steps/tools to load for other types.
	Usually these other types will specify what is needed to load/build them. If there is no additional documantion
	it likely is a modlet. Hopefully the modding author specifies/documents this somewhere, but not all do.
	Additionally: Some modding authors just say "Mod" and its really a modlet as the name "Modlet" doesn't seem to sit
	well with everyone ;)

	########################################
	# Game versions
	########################################
	This document addresses the game "7 Days to Die" versions on PC's.
	- alpha 17
	- alpha 18
	- alpha 19

	Note: To date you cannot add modlets to the game played on Consoles (PS4/XBox).

	########################################
	# Find modlets you want to try out
	########################################
	Modlets can be found in several locations. Most notable are these forums which will help you find them
	Mods forum: https://community.7daystodie.com/forum/27-mods/
	Older Mods list (a18 and older): https://community.7daystodie.com/topic/5429-mod-list/
	Newer Mods list (a18 and newer): https://community.7daystodie.com/topic/18946-new-mod-list-project/

	Sometimes people put their mods here on Github or Nexusmods (https://www.nexusmods.com/7daystodie) or
	personal dropbox. A https://7daystodiemods.com/ website was made recently (2019) for easy browsing/searching of mods
	that just points back to mods on other forums.

	########################################
	# A note about modlet version compatibilty issues
	########################################
	Its very annoying when you're several hours into a game and you realize a modlet you loaded isn't
	working/is broken/isn't compatible with the game version you're using.
	Because of this, try to make sure the modlet you want to load is compatible with the version of the
	game you are using before you start a long game.

	"7 Days to Die" "alpha" versions change frequently so modlets may break in different versions of the game
	(or even minor patches to a version). The version that the modlet was built/tested on may:
	- Be located in a file called "ModInfo.xml" in the modlet, in some field/description.
	- Be in a README file inside the modlet.
	- Be in a forum post or dowload location where the modlet was found.
	- Not be listed anywhere.

	If in doubt, you can just load it and when the game is starting press "F1" and watch everything load.
	If you see errors/warnings it will generally tell you what file/modlet it occurred in (but not always).

	Loading "version incompatible" modlets generally doesn't do any harm to the game itself, but sometimes
	it may cause the game to freeze/crash/throw errors (seen via pressing "F1").

	Another issue you may see with incompatible modlets is missing graphics (for that modlet).

	There are many other small issues that can occur with version incompatibilities that mainly hamper
	seamles gaemplay

	########################################
	# Prepare the game to load modlets
	########################################
	You need to create a single folder to put modlets into.

	Locate the "7 Days to Die" game home folder on your PC
	- If using Steam: Right click on the game in the game library, and choose "properties".
	Go to the "Local Files" tab -> "Browse Local files"

	- If using Steam and Windows, it's likely in this location:
	C:\Program Files (x86)\Steam\steamapps\common\7 Days to Die

	- If using Steam and Ubuntu, it's likely in this location:
	~/.local/share/Steam/steamapps/common/7 Days To Die

	2. If you do not have it already, create a folder/directory called "Mods" in this location.
	Note: This folder/directory name is case sensitive (use a capital "M")

	Note (per info/comments from simkorn266. Thanks!): If installing for Linux server (7DTD):\
	- If installing for Linux server (7DTD) dont forget to change the folder to change the Mods folder to 777(permision)\
	- And take a look in the Mods folder if the .xml is to execute

	Note: From this point on I will reference folders/directories as simply "folders" since the majority
	of people are likely using Windows OS for this game.

	########################################
	# Get some modlets to put into the Mods folder.
	########################################
	After downloading some modlets, make sure you know what modlet folder to use! Many modlets are
	zipped/tarballed or are part of "modlet collections" containing multiple modlets. You cannot load
	a zipped/tarballed modlet, it must be extracted first to get to the correct modlet folder, which may
	result in extra folders being created.

	The "correct" folder to use in the next step to load a single modlet is the one that contains
	the "ModInfo.xml" file. Consider you have downloaded and unzipped a modlet called "Final Folder"
	and now you have this folder structure for example:
	.../Downloads/SomeFolder/SomeOtherFolder/YetAnotherFolder/FinalFolder/ModInfo.xml

	In this case, the "modlet" is the "FinalFolder" folder.

	Copy that modlet folder and everything in it into the "Mods" folder

	########################################
	# Run the game
	########################################
	Note: Some warnings may appear from some modlets (or they may fail to load)
	This may be "normal", or may be because the modlet author has written the modlet for a different
	version of the game than you are using. Its also possible that if you have loaded many modlets
	that they are "colliding" with each other (changing or using the same internal game settings/names/etc).
	If you see a lot of collisions the modlets may not work as advertised.