Modding: Difference between revisions
Planetalgol (talk | contribs) |
Planetalgol (talk | contribs) |
||
Line 185: | Line 185: | ||
====Mapping Resources==== | ====Mapping Resources==== | ||
* [https://www.pztiles.com/home PZ Tiles and a comprehensive selection of other mapping and tile making resources.] | |||
* [https://drive.google.com/drive/folders/12jQxlDlyC-fACV45oCWshZb60QHoQ6kf The build 41 base and vegetation maps for PZ.] | * [https://drive.google.com/drive/folders/12jQxlDlyC-fACV45oCWshZb60QHoQ6kf The build 41 base and vegetation maps for PZ.] | ||
* [https://theindiestone.com/forums/index.php?/topic/25742-project-zomboid-basemap/ The build 40 base and vegetation maps for PZ.] | * [https://theindiestone.com/forums/index.php?/topic/25742-project-zomboid-basemap/ The build 40 base and vegetation maps for PZ.] |
Revision as of 04:34, 2 February 2022
Terms & Conditions
By purchasing Project Zomboid, you are permitted to:
- Change or distribute the base files or contents in any way you like, provided that those changes do not result in you making Project Zomboid available to play or download (this includes making it available open source), or are for the purposes of cheating, unauthorised hacking, exploits or griefing other people or are malicious or illegal in intent or practice.
- Use art, music, video footage or other assets of Project Zomboid for creative purposes in any way you like providing the end result is related in some way to promoting Project Zomboid, is for non-commercial use only (unless we agreed otherwise with you) and states Project Zomboid as its influence and origin by supplying the following wording prominently with the assets: “Thanks to The Indie Stone for creating Project Zomboid http://projectzomboid.com/), which made this possible. This is an unofficial fan production for non-commercial purposes made under the Indie Stone Terms [link to these terms]“
You are not permitted to:
- Modify the base files of Project Zomboid to include malicious code or other naughtiness.
- Distribute Project Zomboid yourself, or host its download. In order to ensure the game’s integrity we recommend it should only ever be downloaded from established portals on which we’ve placed it (e.g. Steam).
In terms of the modding of PZ, you also agree that:
- The Indie Stone reserve the right to implement any features in the game irrespective of whether mods exist that accomplish the same goal.
- PZ modders are solely responsible for their mod, including (but not limited to compliance with any hosting platforms (such as Steam Workshop). They are also responsible for obtaining third party consents for any third party materials in the mod. Legally, we have to ask that modders to ‘represent and warrant’ (i.e. promise legally) that their mod is their own original work and any third party contents are fully and properly licensed by the modder.
- Creation of mods is subject to our modding guidelines, which may be updated from time to time with any technical requirements regarding how PZ mods must work.
- Project Zomboid modders are free to receive monetary/gift donations from the players who use their releases, and appreciate the time and effort put into them. However having mods created exclusively for those who choose to donate (or separate ‘in-mod’ content and bonuses) is not allowed. Mod creators cannot sell modifications to Project Zomboid.
How to install/play mods
To get a full tutorial on how to install mods, see [RoboMat's tutorial on the forums].
To start a mod up, first make sure the mod is installed in the correct directory. Once you have done this, start up Project Zomboid. Once you get to the main menu, down at the bottom of the screen when you see "Survival" and "Sandbox" you will also find a menu option called Mods. Click on it, which will then lead you to the mod menu.
In there you should see the list of mods that you have installed. Double click on the mod you wish to start and a green tick should appear next to the mod. Next thing to do is shut down Project Zomboid and start it up again. Once started your mod should now be ready to go. Instructions on using the mod are usually contained in README's or information in the thread.
Current mods
Modding tutorials
Tutorial | Author | Last updated |
---|---|---|
Project Zomboid Modding Guide (WIP) | Fenris Wolf | July 27, 2019 |
Lua Events | PZwiki | , |
Lua Events (v41.65) | co` | June 13, 2023 |
RoboMat's Tutorials | RoboMat | July 24, 2013 |
Java Scripting Guide | Lemmy101 | July 24, 2013 |
Javadoc reference to Project Zomboid codebase
- Project Zomboid Java documentation
- Project Zomboid Java documentation v41.65 (Unofficial)
- Project Zomboid Java documentation v40.43 (Unofficial)
- Project Zomboid Java documentation v39.67 (Unofficial)
- Project Zomboid Java documentation v38.30 (Unofficial)
Basic Lua language
- An Introduction to Lua
- Variables, Assignments and Datatypes
- Arithmetic Operators
- Relational and Boolean Operators
- Concatentation and Length Operators
- If Statements and Functions
- Loops
- Local and Global Variables
- Tables
- Looping Through Tables
Modding Tools
- Tutorial to setup IntelliJ with the Libraries here. Start using the power of this IDE to help you in finding the methods and objects you didn't know existed.
- Notepad++, a simple editor.
- VS code, a simple editor.
- Free Online GUID Generator: for making GUIDs for modded clothing and outfits.
Important Additional Modding Resources
- Setting up the mod.info file: a link to a post on TIS Discord explaining how.
- PZ Keycode references.
- Variables to use when creating an item.
- Guide for adding a new Skill/Perk, add XP and find all perks names.
- Guide for adding a custom trait.
- Guide for adding new clothing items with modding for build 41.
General Additional Modding Resources
- Guide to make a hair mod.
- A YouTube playlist with Blackbeard's modding tutorials.
- Photoshop Masks used for making and editing tile sprites, a link to a post on TIS Discord with the file.
- Global Mod Data: How to use this powerful tool for tracking global mod data.
- Guide to make a custom Timed Action.
- A list of all the animation variables used in timed actions.
- SpawnerAPI: Allows for pending the spawns of vehicles, items, zombies in order to spawn things anywhere in the world. Upon loading the cell in question the item becomes spawned in.
- Guide to how PZ loot distribution works on TIS Discord.
- Spawning a tile from it's name: a link to a post on TIS Discord explaining how.
- How to spawn loot on specific zombie outfit corpses: a link to a post on TIS Discord explaining how.
- Item spawning examples that work: a link to a post on TIS Discord explaining how.
- An archive with files demonstrating how to add modded sandbox options: a link to a post on TIS Discord.
- A tool for dumping distro table contents to console.txt: a lint to a post on TIS Discord with the code.
- How to use read/write with files in mods, useful for server ini files: a link to a post on TIS Discord explaining how.
Old and more specific Additional Modding Resources
- PZ Crash Auto Launcher: a tool for anyone interested in not constantly having to open and close PZ 24/7 while testing stuff.
- How to host and join locally from two games on the same pc.
- isoRangeScan: This is an utility function meant for large scale scans of isoGridSquares around a given IsoObject. The scans are done fractally - that is to say from a center (or centers) outward to fill a larger area.
- ItemZed: for editing Item scripts and distribution files (out of date, needs to be updated to work properly with build 41)
Mapping tutorials
- Main article: Mapping
Tutorial | Author | Last updated |
---|---|---|
The One Stop TileZed Mapping Shop | RingoD123 | January 30, 2017 |
How to Combine Map Mods | RingoD123 | June 11, 2017 |
Full list of current Room Definitions | RingoD123 | February 7, 2014 |
Making new room definitions | RingoD123 | June 10, 2017 |
Mapping Tutorial's and Videos | Thuztor | April 20, 2015 |
Mapping Tutorial's and Videos (Outdated) | Thuztor | September 12, 2017 |
VegMap to Testing Custom Map | Cpt_Paradox | January 28, 2017 |
Making rooms with the place wall tool, item spawns, ortho and more! | Cpt_Paradox | November 30, 2017 |
Sliding Glass Doors, New Textures, Here's How! | Cpt_Paradox | November 30, 2017 |
How to make a map Start to Finish Full Video Tutorial | BlackBeard | January 30, 2017 |
All player made Building Archives | BlackBeard | May 31, 2019 |
Custom texture packs and tile definitions | EasyPickins | June 5, 2014 |
Card's Tutorial for Terrain Generation | Cardenaglo | February 22, 2017 |
Video Tutorials mapping | Atoxwarrior | June 26, 2016 |
Mapping tools
- TileZed, WorldEd, and Tilesets (May 17, 2018)