From 6d651d130f50d70aaeb76de44bb9d51f3c401cf5 Mon Sep 17 00:00:00 2001 From: Kent Edoloverio <69900896+kents00@users.noreply.github.com> Date: Sun, 24 Jul 2022 12:07:22 +0800 Subject: [PATCH 01/12] Adding FIxing Block | Build 41.72 --- scripts/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/scripts/README.md b/scripts/README.md index 915f918..0c6399d 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -120,7 +120,18 @@ Here you can see the ingredients are a knife and a fish. `keep` is declared befo ---------------------------------------- ### The fixing block +When fixing an item in Project Zomboid Build 41.72, you just need the repair item and the fixer; the template example as follows: +``` +fixing Fix Baseball Bat +{ + Require : BaseballBat, + Fixer : Woodglue=2; Woodwork=2, + Fixer : DuctTape=2, + Fixer : Glue=2, + Fixer : Scotchtape=4, +} +``` ---------------------------------------- ### The sound block PZ build 40 introduced new audio code to deal with issues in multiplayer. All sounds now need to be defined in a `sound` block to have them heard by players farther then 20 tiles. Defining a sound here also includes it in PZ's options advanced audio tab. From e4d5f9cc73fd525776af93dc74b8e7c1480e0831 Mon Sep 17 00:00:00 2001 From: Kent Edoloverio <69900896+kents00@users.noreply.github.com> Date: Sun, 24 Jul 2022 12:27:37 +0800 Subject: [PATCH 02/12] Adding Evolved Recipe | Build 41.72 --- scripts/README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 53 insertions(+), 1 deletion(-) diff --git a/scripts/README.md b/scripts/README.md index 0c6399d..1bb6fa5 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -117,10 +117,62 @@ Here you can see the ingredients are a knife and a fish. `keep` is declared befo ---------------------------------------- ### The evolvedrecipe block +The evolved recipe is divided into two parts: the ```thing to be transformed``` and the ```result of the transformation```; we need to create 2 items to do that. + +Example, making sandwich using breadslices: +``` +item BreadSlices +{ + DisplayName = Bread Slices, + DisplayCategory = Food, + Type = Food, + Weight = 0.1, + Icon = BreadSlices, + DaysFresh = 3, + DaysTotallyRotten = 6, + HungerChange = -10, + Calories = 177, + Carbohydrates = 33, + Lipids = 2.22, + Proteins = 5.9, + WorldStaticModel = BreadSlices, +} + +item Sandwich +{ + DisplayName = Sandwich, + DisplayCategory = Food, + Type = Food, + Weight = 0.2, + Icon = Sandwich, + DaysFresh = 3, + DaysTotallyRotten = 6, + HungerChange = -10, + Calories = 360, + Carbohydrates = 42, + Lipids = 8.5, + Proteins = 5.8, + StaticModel = Sandwich, + WorldStaticModel = CheeseSandwich, +} +``` + +Evolved into Sandwich: + +``` +evolvedrecipe Sandwich +{ + BaseItem:BreadSlices, + MaxItems:4, + ResultItem:Sandwich, + Name:Make Sandwich, +} + +``` ---------------------------------------- ### The fixing block -When fixing an item in Project Zomboid Build 41.72, you just need the repair item and the fixer; the template example as follows: +When fixing an item in Project Zomboid Build 41.72, you just need the ```repair item``` and the ```fixer```; the template example as follows: ``` fixing Fix Baseball Bat { From dc6e4b37b09f15248f1f9955aa84d4c81b7faec8 Mon Sep 17 00:00:00 2001 From: Kent Edoloverio <69900896+kents00@users.noreply.github.com> Date: Sun, 24 Jul 2022 12:42:19 +0800 Subject: [PATCH 03/12] Finishing Touches Evolved and Fixing | Build 41.72 --- scripts/README.md | 84 +++++++++++++++++++++++++++-------------------- 1 file changed, 48 insertions(+), 36 deletions(-) diff --git a/scripts/README.md b/scripts/README.md index 1bb6fa5..bb12513 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -121,55 +121,64 @@ The evolved recipe is divided into two parts: the ```thing to be transformed``` Example, making sandwich using breadslices: ``` +module Base { + item BreadSlices -{ - DisplayName = Bread Slices, - DisplayCategory = Food, - Type = Food, - Weight = 0.1, - Icon = BreadSlices, - DaysFresh = 3, - DaysTotallyRotten = 6, - HungerChange = -10, - Calories = 177, - Carbohydrates = 33, - Lipids = 2.22, - Proteins = 5.9, - WorldStaticModel = BreadSlices, -} + { + DisplayName = Bread Slices, + DisplayCategory = Food, + Type = Food, + Weight = 0.1, + Icon = BreadSlices, + DaysFresh = 3, + DaysTotallyRotten = 6, + HungerChange = -10, + Calories = 177, + Carbohydrates = 33, + Lipids = 2.22, + Proteins = 5.9, + WorldStaticModel = BreadSlices, + } item Sandwich -{ - DisplayName = Sandwich, - DisplayCategory = Food, - Type = Food, - Weight = 0.2, - Icon = Sandwich, - DaysFresh = 3, - DaysTotallyRotten = 6, - HungerChange = -10, - Calories = 360, - Carbohydrates = 42, - Lipids = 8.5, - Proteins = 5.8, - StaticModel = Sandwich, - WorldStaticModel = CheeseSandwich, + { + DisplayName = Sandwich, + DisplayCategory = Food, + Type = Food, + Weight = 0.2, + Icon = Sandwich, + DaysFresh = 3, + DaysTotallyRotten = 6, + HungerChange = -10, + Calories = 360, + Carbohydrates = 42, + Lipids = 8.5, + Proteins = 5.8, + StaticModel = Sandwich, + WorldStaticModel = CheeseSandwich, + } + } ``` Evolved into Sandwich: ``` +module Base { + evolvedrecipe Sandwich -{ - BaseItem:BreadSlices, - MaxItems:4, - ResultItem:Sandwich, - Name:Make Sandwich, -} + { + BaseItem:BreadSlices, + MaxItems:4, + ResultItem:Sandwich, + Name:Make Sandwich, + } +} ``` +The ```ResultItem``` is the outcome of constructing Sandwiches with BreadSlices, and ```MaxItems``` is the total number of items made. ```BaseItem``` is the require item ( BreadSlice ) to make an Sandwich. + ---------------------------------------- ### The fixing block When fixing an item in Project Zomboid Build 41.72, you just need the ```repair item``` and the ```fixer```; the template example as follows: @@ -184,6 +193,9 @@ fixing Fix Baseball Bat Fixer : Scotchtape=4, } ``` + +```Require``` an item needs to repair. ```Fixer``` requirements to fix your item + ---------------------------------------- ### The sound block PZ build 40 introduced new audio code to deal with issues in multiplayer. All sounds now need to be defined in a `sound` block to have them heard by players farther then 20 tiles. Defining a sound here also includes it in PZ's options advanced audio tab. From f6311724e2198bb483500ea60ca05b2b5db4113f Mon Sep 17 00:00:00 2001 From: Kent Edoloverio <69900896+kents00@users.noreply.github.com> Date: Sun, 24 Jul 2022 12:47:24 +0800 Subject: [PATCH 04/12] Adding Finishing Touches | Build 41.72 --- translations/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/translations/README.md b/translations/README.md index 379ee23..5cfcda1 100644 --- a/translations/README.md +++ b/translations/README.md @@ -5,7 +5,7 @@ * [Folder Structure](#folder-structure) * [Functionalities](#functionalities) * [Folders](#folders) - * [Be Careful](#be-careful) + * [Warning](#warning) * [Testing Translations Locally](#testing-translations-locally) ---------------------------------------- @@ -143,11 +143,11 @@ This file contains the language, what version and the encoding This file contains credits the to authors. -## Be Careful +## Warning Writing and modifiying the indiviual txt files you should replace the ```[ Translation Name ]``` into two words such as: EN ( English ), PH ( Philippines ) And also modify inside in file Example: -It should change the "'PH"' to a language associated with the file name _[Translation Name].txt. +It should change the "'PH"' to a language associated with the file name ```_[Translation Name].txt``` ``` Challenge_PH = { .................. From 059f531c2582261d81a8b6545cf319a58319aee5 Mon Sep 17 00:00:00 2001 From: Kent Edoloverio <69900896+kents00@users.noreply.github.com> Date: Sun, 24 Jul 2022 12:54:48 +0800 Subject: [PATCH 05/12] Update README.md --- structure/README.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/structure/README.md b/structure/README.md index fb83c08..0facc75 100644 --- a/structure/README.md +++ b/structure/README.md @@ -1,13 +1,15 @@ ## Contents * [Back to Main](../../..) - * [Overview](#overview) + * [Overview](#overview) + * [mod.info](#modinfo) + * [media/](#media) ---------------------------------------- ## Overview This section contains a brief description of the file and folder structure that makes up a mod. Your mod may include other folders in addition to these, but these ones are the most common. -#### mod.info +##### ```mod.info``` This file can be created/edited with any text editor. It contains details like your mod's ID, name, description, preview image etc. ``` name=My First Mod @@ -17,30 +19,30 @@ description=Basic example mod url=https://theindiestone.com/forums/ ``` -#### media/ +##### ```media/``` The actual content of your mod will be placed in subfolders of the `media` folder -#### media/scripts/ +##### ```media/scripts/``` This folder contains text files with item, vehicles and recipe definitions. See the section on Scripts for more information. -#### media/models/ +##### ```media/models/``` Used for 3d models of weapons, vehicles etc. -#### media/textures/ +##### ```media/textures/``` Icons, 3d model textures and the like go in here, in `.png` format. Pay attention to the naming scheme: Item icons should use the `Item_` prefix. -#### media/sound/ +##### ```media/sound/``` Sound files go in here, in `.wav` or `.ogg` format. -#### media/lua/ +##### ```media/lua/``` If your mod includes any .lua scripts, you will need this folder as well as at least one of the subfolders listed below. Any .lua files need to go in the subfolders, not directly in this one. -#### media/lua/shared/ +##### ```media/lua/shared/``` Used for lua scripts shared by client and server-side logic. These are the first Lua scripts that get loaded. -#### media/lua/client/ +##### ```media/lua/client/``` Used for client-side scripts. UI elements, context menus timed actions and the like. These get loaded after any 'shared' lua scripts. -#### media/lua/server/ +##### ```media/lua/server/``` Used for server-side scripts. Item spawning, core farming, weather and other server-side events. These only get loaded when the game is actually started (loading a save, starting a server, etc). From 610cdf0677650b1db48a2841d948fdafea85c039 Mon Sep 17 00:00:00 2001 From: Kent Edoloverio <69900896+kents00@users.noreply.github.com> Date: Sun, 24 Jul 2022 12:55:46 +0800 Subject: [PATCH 06/12] Update README.md --- structure/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/structure/README.md b/structure/README.md index 0facc75..e62ed1b 100644 --- a/structure/README.md +++ b/structure/README.md @@ -4,6 +4,7 @@ * [Overview](#overview) * [mod.info](#modinfo) * [media/](#media) + * [media/scripts/](#mediascripts) ---------------------------------------- ## Overview From be56a21c9c3f5bf3ff45cec6e1735c95279bbce0 Mon Sep 17 00:00:00 2001 From: Kent Edoloverio <69900896+kents00@users.noreply.github.com> Date: Sun, 24 Jul 2022 12:56:36 +0800 Subject: [PATCH 07/12] Update README.md --- structure/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/structure/README.md b/structure/README.md index e62ed1b..9e1f12e 100644 --- a/structure/README.md +++ b/structure/README.md @@ -5,6 +5,7 @@ * [mod.info](#modinfo) * [media/](#media) * [media/scripts/](#mediascripts) + * [media/models/](#mediamodels) ---------------------------------------- ## Overview From 312a68757c8bd7acc323f9fd11f3b319b824670f Mon Sep 17 00:00:00 2001 From: Kent Edoloverio <69900896+kents00@users.noreply.github.com> Date: Sun, 24 Jul 2022 12:58:32 +0800 Subject: [PATCH 08/12] Update README.md --- structure/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/structure/README.md b/structure/README.md index 9e1f12e..c4557c0 100644 --- a/structure/README.md +++ b/structure/README.md @@ -6,6 +6,8 @@ * [media/](#media) * [media/scripts/](#mediascripts) * [media/models/](#mediamodels) + * [media/textures/](#mediatextures) + * [media/sound/](#mediasound) ---------------------------------------- ## Overview From 418e80827c459db6990b01fbb57f8f559e426cc0 Mon Sep 17 00:00:00 2001 From: Kent Edoloverio <69900896+kents00@users.noreply.github.com> Date: Sun, 24 Jul 2022 13:04:04 +0800 Subject: [PATCH 09/12] Update README.md --- structure/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/structure/README.md b/structure/README.md index c4557c0..6676d6f 100644 --- a/structure/README.md +++ b/structure/README.md @@ -8,6 +8,7 @@ * [media/models/](#mediamodels) * [media/textures/](#mediatextures) * [media/sound/](#mediasound) + * [media/lua/](#medialua) ---------------------------------------- ## Overview From 95c8cffdade9f3c7d3d073eedd4e011a344bd365 Mon Sep 17 00:00:00 2001 From: Kent Edoloverio <69900896+kents00@users.noreply.github.com> Date: Sun, 24 Jul 2022 13:04:56 +0800 Subject: [PATCH 10/12] Update README.md --- structure/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/structure/README.md b/structure/README.md index 6676d6f..9433d37 100644 --- a/structure/README.md +++ b/structure/README.md @@ -9,6 +9,7 @@ * [media/textures/](#mediatextures) * [media/sound/](#mediasound) * [media/lua/](#medialua) + * [media/lua/shared/](#medialuashared) ---------------------------------------- ## Overview From 62079616b79c537bb17fcc41771b156fc6455a27 Mon Sep 17 00:00:00 2001 From: Kent Edoloverio <69900896+kents00@users.noreply.github.com> Date: Sun, 24 Jul 2022 13:06:22 +0800 Subject: [PATCH 11/12] Update README.md --- structure/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/structure/README.md b/structure/README.md index 9433d37..dd0f6d0 100644 --- a/structure/README.md +++ b/structure/README.md @@ -10,6 +10,7 @@ * [media/sound/](#mediasound) * [media/lua/](#medialua) * [media/lua/shared/](#medialuashared) + * [media/lua/client/](#medialuaclient) ---------------------------------------- ## Overview From 9e3b871574a975ddbfa5fb80951c53d321f7cbe5 Mon Sep 17 00:00:00 2001 From: Kent Edoloverio <69900896+kents00@users.noreply.github.com> Date: Sun, 24 Jul 2022 13:07:21 +0800 Subject: [PATCH 12/12] Update README.md --- structure/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/structure/README.md b/structure/README.md index dd0f6d0..7f0acd1 100644 --- a/structure/README.md +++ b/structure/README.md @@ -11,6 +11,7 @@ * [media/lua/](#medialua) * [media/lua/shared/](#medialuashared) * [media/lua/client/](#medialuaclient) + * [media/lua/server/](#medialuaserver) ---------------------------------------- ## Overview