Skip to content

Commit

Permalink
pre-release README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Mawrak authored Nov 23, 2023
1 parent 77e27ce commit ea75cd4
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,25 @@
# Telltale-Cutscene-Editor
A tool to make custom cutscenes in TWDTTDS. Made with Script Editor + Tweaks v3b.1.0+.
# Telltale Cutscene Editor
A tool to make custom cutscenes in TWDTTDS. Made with [Script Editor + Tweaks v3b.1.0](https://github.com/Telltale-Modding-Group/Telltale-Script-Editor-Tweaks).

This mod is a tool made to allow easy creation of custom cutscenes within Telltale's game engine. This tool only works with The Walking Dead: The Telltale Definitive Series. It does not work in other games. You need to own a valid copy of The Walking Dead: The Telltale Definitive Series (TWDTTDS) in order to use this tool.

Watch Demo Scene here:

This tool uses custom .ini formats, as well as .lua scripts, to save and load your work. Therefore, this tool cannot be used to modify any existing cutscenes made by Telltale, which use their own internal formats. You can only create new cutscenes using Telltale's resources, not edit any existing Telltale cutscenes.

This tool is meant to be used by advanced users - users who know their way around computer, know the difference between files and folders and can understand basic computer-related terminology (and can look terms up if they are unfamiliar with them). Creation of simple cutscenes does not require coding knowledge beyond following the steps of scene setup. More complex features will require writing some new, more complex code, though nothing too difficult. In general, knowledge of the basics of coding will make understanding of this tool much easier, though it is not required. Telltale scripts are written in lua, so if you have knowledge of that language specifically, it's also a plus.

## Usage

1) Download and unpack the archive.
2) Follow the steps outlined in the tutorial.

## Special Thanks

**Kas (PrincessPeachFan2014)** - for coming up with, writing down and keeping track of the entire sequence of events and dialogues in the Demo Scene, for making incredibly helpful suggestions and critiques of my work during development, and for showing interest and support for the development of this tool.

**David Matos (frostbone25)** - for pioneering Telltale scripting and helping me understand it, along with many other important things about Telltale modding.

**Violet (droyti)** - for creating the original Script Editor.

**Lucas Saragosa** - for helping me and others understand and edit Telltale's formats, and for amazing and continued contributions to the modding community.

0 comments on commit ea75cd4

Please sign in to comment.