v3b.2.0 - Support for other Telltale Games added, Priority Settings added

Author: Mawrak

src/main/EditorMenu.ts

@@ -129,7 +129,7 @@ export const getEditorMenu = (window: BrowserWindow, state: Readonly<AppState>)
 				{
                     //Mawrak Tweaks - changed links to my fork
 					label: 'Docs',
-					click: () => shell.openExternal('https://github.com/Mawrak/Telltale-Script-Editor-Tweaks/wiki')
+					click: () => shell.openExternal('https://github.com/Mawrak/Telltale-Script-Editor-Tweaks')
 				},
 				{
 					label: 'About',

src/main/handlers/BuildProject.ts

@@ -10,6 +10,9 @@ import {
 	ResourceDescription
 } from './ResdescUtils';
 import crypto from 'crypto';
+import {BrowserWindow, dialog, shell, Menu} from 'electron';
+import { getFiles, getFilesInDirectory, getIPCMainChannelSource, openBuildsDirectory } from '../utils';
+
 
 const generateHash = (string: string) => {
 	const hash = crypto.createHash('md5');
@@ -28,18 +31,23 @@ type Hash = string;
 type Cache = { tseproj?: Hash } & Record<string, Record<string, Hash>>;
 export type Logger = (message: string) => void;
 
-const writeResourceDescription = async (project: Project, resdesc: ResourceDescription, cachePath: string, log: Logger) => {
+
+
+const writeResourceDescription = async (project: Project, resdesc: ResourceDescription, cachePath: string, log: Logger, gameNumber:number, PrioritySetting:number) => {
+    
+    
 	const resdescOutputPath = path.join(cachePath, generateResourceDescriptionName(project, resdesc));
 
 	await fs.mkdir(path.dirname(resdescOutputPath), {recursive: true});
-
-	await fs.writeFile(resdescOutputPath, generateResourceDescriptionContents(project, resdesc));
-	const process = exec(`resources\\ttarchext.exe -V 7 -e 0 -o 67 "${resdescOutputPath}" "${cachePath}"`, (e, out, err) => {
+    //const gameNumber = useAppSelector(state => state.storage.gameNumber);
+	await fs.writeFile(resdescOutputPath, generateResourceDescriptionContents(project, resdesc, PrioritySetting));
+	const process = exec(`resources\\ttarchext.exe -V 7 -e 0 -o ${gameNumber} "${resdescOutputPath}" "${cachePath}"`, (e, out, err) => {
 		log(out);
 		log(err);
 	});
 
 	await new Promise(resolve => process.addListener('close', resolve));
+
 };
 
 const compileLua = async (filePath: string, projectPath: string, cachePath: string, log: Logger) => {
@@ -59,10 +67,10 @@ const compileLua = async (filePath: string, projectPath: string, cachePath: stri
 	if (error) throw new Error(error);
 };
 
-export const buildProject = async (log: Logger, state: AppState, { projectPath, project }: { projectPath: string, project: Project }): Promise<ModInfo | void> => {
+export const buildProject = async (log: Logger, state: AppState, { projectPath, project}: { projectPath: string, project: Project, gameNumber: number}, gameNumber : number, PrioritySetting : number): Promise<ModInfo | void>  => {
 	const buildsPath = path.join(projectPath, 'Builds');
 	const cachePath = path.join(buildsPath, 'cache');
-
+    //const gameNumberConst = projectPath.gameNumber;
 	let previousCache: Cache;
 
 	try {
@@ -130,7 +138,7 @@ export const buildProject = async (log: Logger, state: AppState, { projectPath,
 
 			log(`============== Generating ${resdescName}...`);
 
-			tasks.push(writeResourceDescription(project, resdesc, cachePath, log));
+			tasks.push(writeResourceDescription(project, resdesc, cachePath, log, gameNumber, PrioritySetting));
 			continue;
 		}
 
@@ -179,7 +187,7 @@ export const buildProject = async (log: Logger, state: AppState, { projectPath,
 
 		log(`============== Generating ${ttarchFilePath} from ${archivePath}...`);
 
-		const process = exec(`resources\\ttarchext.exe -b -o 67 "${ttarchFilePath}" "${archivePath}"`, (error, stdout, stderr) => {
+		const process = exec(`resources\\ttarchext.exe -b -o ${gameNumber} "${ttarchFilePath}" "${archivePath}"`, (error, stdout, stderr) => {
 			log(stdout);
 			log(stderr);
 		});

src/main/handlers/IPCHandlers.ts

@@ -194,7 +194,7 @@ export const registerIPCHandlers = (window: BrowserWindow) => {
 	GetGamePathChannel(source).handle(async () => {
 		await dialog.showMessageBox({
 			title: 'Select executable',
-			message: 'Please select the executable file for Telltale\'s The Walking Dead: Definitive Edition',
+			message: 'Please select the executable file for the target game.',
 			type: 'warning'
 		});
 
@@ -223,12 +223,13 @@ export const registerIPCHandlers = (window: BrowserWindow) => {
 	}
 
 	BuildProjectChannel(source).handle(async data => {
-		const modInfo = await buildProject(log, state, data);
+		const modInfo = await buildProject(log, state, data, data.gameNumber, data.PrioritySetting);
 
 		if (!modInfo) return;
 
 		const buildsPath = path.join(data.projectPath, 'Builds');
 		const cachePath = path.join(buildsPath, 'cache');
+        //const gameNumberConst = data.gameNumber;
 
 		const zipFileName = `build-${format(new Date(), "yyyy-MM-dd'T'HH-mm-ss")}.zip`;
 		log(`============== Creating ${zipFileName}...`);
@@ -274,7 +275,7 @@ export const registerIPCHandlers = (window: BrowserWindow) => {
 		modinfo?: string
 	};
 
-	RunProjectChannel(source).handle(async ({ project, projectPath, gamePath, modBuildPath }) => {
+	RunProjectChannel(source).handle(async ({ project, projectPath, gamePath, modBuildPath, gameNumber, PrioritySetting }) => {
         //Mawrak tweaks - added ability to choose mod folder
 
 		let archivesPath = path.join(path.dirname(gamePath), 'Archives');
@@ -286,7 +287,7 @@ export const registerIPCHandlers = (window: BrowserWindow) => {
 
 		const cachePath = path.join(projectPath, 'Builds', 'cache');
 
-		const modInfo = await buildProject(log, state, {project, projectPath});
+		const modInfo = await buildProject(log, state, {project, projectPath, gameNumber}, gameNumber, PrioritySetting);
 
 		if (!modInfo) return;
 

src/main/handlers/ResdescUtils.ts

@@ -43,7 +43,7 @@ export const createResourceDescription = (project: Project, archive: string): Re
 	};
 };
 
-export const generateResourceDescriptionContents = (project: Project, { setName, enableMode, setVersion, ttarchName }: ResourceDescription) => `
+export const generateResourceDescriptionContents = (project: Project, { setName, enableMode, setVersion, ttarchName }: ResourceDescription, PrioritySetting: number) => `
 --This file was automatically generated by the Telltale Script Editor, available at https://github.com/Telltale-Modding-Group/Telltale-Script-Editor"
 --File associated with '${project.mod.name}' by ${project.mod.author}, version ${project.mod.version}
 local set = {}
@@ -52,13 +52,13 @@ set.setName = "${setName}"
 set.descriptionFilenameOverride = ""
 set.logicalName = "<>" --Empty for now, band-aid fix for later.
 set.logicalDestination = "<>"
-set.priority = 30
+set.priority = ${PrioritySetting}
 set.localDir = _currentDirectory
 set.enableMode = "${enableMode}"
 set.version = "${setVersion}"
 set.descriptionPriority = 0
 set.gameDataName = "${setName} Game Data"
-set.gameDataPriority = 30
+set.gameDataPriority = ${PrioritySetting}
 set.gameDataEnableMode = "constant"
 set.localDirIncludeBase = true
 set.localDirRecurse = false

src/renderer/components/Builds.tsx

@@ -63,7 +63,7 @@ export const Builds = () => {
 			</Code>
 
 			<Group position="right" p="xs">
-				<Button onClick={handleClearBuildArchives} color="red">Clear Build Archives</Button>
+				<Button onClick={handleClearBuildArchives} color="red">Clear Cached Build Archives</Button>
 				<Button onClick={handleOpenBuildsDirectory}>Open Builds Directory</Button>
 			</Group>
 		</Stack>

src/renderer/components/modals/AboutModal.tsx

@@ -5,7 +5,7 @@ export const AboutModal = () => {
 	return <Container>
 		<Stack align="center">
 			<Title order={1}>Telltale Script Editor + Tweaks</Title>
-			<Text>Version 3b.1.0</Text>
+			<Text>Version 3b.2.0</Text>
 		</Stack>
 	</Container>
 };

src/renderer/components/modals/SettingsModal.tsx

@@ -9,6 +9,10 @@ import {OverlayActions} from '../../slices/OverlaySlice';
 
 export const SettingsModal = ({context, id}: ContextModalProps) => {
 	const dispatch = useAppDispatch();
+    //Mawrak Tweaks - new setting - Game number
+    const gameNumber = useAppSelector(state => state.storage.gameNumber);
+    //Mawrak Tweaks - new setting - Priority
+    const PrioritySetting = useAppSelector(state => state.storage.PrioritySetting)
 	const gameExePath = useAppSelector(state => state.storage.gamePath);
 	const maximumBuildsToKeep = useAppSelector(state => state.storage.maximumBuildsToKeep);
 	const saveFilesOnBuild = useAppSelector(state => state.storage.saveFilesOnBuild);
@@ -42,6 +46,98 @@ export const SettingsModal = ({context, id}: ContextModalProps) => {
 	return <Container>
 		<Stack>
 			<Title order={1}>Settings</Title>
+           <Select
+				required
+				label="Select Target Game"
+				placeholder="Pick a game to set Game number."
+                description="Most games from 58 to 67 should work. Support for older games is untested."
+				defaultValue={String(gameNumber)}
+				data={[
+					{ value: '0', label: '0   Wallace & Gromit: Episode 1: Fright of the Bumblebees' },
+					{ value: '1', label: '1   Wallace & Gromit: Episode 2: The Last Resort' },
+					{ value: '2', label: '2   Wallace & Gromit: Episode 3: Muzzled' },
+					{ value: '3', label: '3   Telltale Texas Hold-em' },
+                    { value: '4', label: '4   Bone: Out From Boneville' },
+					{ value: '5', label: '5   Bone: The Great Cow Race' },
+					{ value: '6', label: '6   Sam & Max: Episode 101 - Culture Shock' },
+					{ value: '7', label: '7   Sam & Max: Episode 102 - Situation: Comedy' },
+                    { value: '8', label: '8   Sam & Max: Episode 103 - The Mole, The Mob, and the Meatball' },
+					{ value: '9', label: '9   Sam & Max: Episode 104 - Abe Lincoln Must Die!' },
+                    { value: '10', label: '10  Sam & Max: Episode 105 - Reality 2.0' },
+					{ value: '11', label: '11  Sam & Max: Episode 106 - Bright Side of the Moon' },
+					{ value: '12', label: '12  Sam & Max: Episode 201 - Ice Station Santa' },
+					{ value: '13', label: '13  Sam & Max: Episode 202 - Moai Better Blues' },
+                    { value: '14', label: '14  Sam & Max: Episode 203 - Night of the Raving Dead' },
+					{ value: '15', label: '15  Sam & Max: Episode 204 - Chariots of the Dogs' },
+					{ value: '16', label: '16  Sam & Max: Episode 205 - Whats New, Beelzebub' },
+					{ value: '17', label: '17  Strong Bad: Episode 1 - Homestar Ruiner' },
+                    { value: '18', label: '18  Strong Bad: Episode 2 - Strong Badia the Free' },
+					{ value: '19', label: '19  Strong Bad: Episode 3 - Baddest of the Bands' },
+                    { value: '20', label: '20  Strong Bad: Episode 4 - Daneresque 3' },
+					{ value: '21', label: '21  Strong Bad: Episode 5 - 8-Bit Is Enough' },
+					{ value: '22', label: '22  CSI 3 - Dimensions of Murder / Bone demo' },
+					{ value: '23', label: '23  CSI 4 - Hard Evidence (demo)' },
+                    { value: '24', label: '24  Tales of Monkey Island 101: Launch of the Screaming Narwhal' },
+					{ value: '25', label: '25  Wallace & Gromit: Episode 4: The Bogey Man' },
+					{ value: '26', label: '26  Tales of Monkey Island 102: The Siege of Spinner Cay' },
+					{ value: '27', label: '27  Tales of Monkey Island 103: Lair of the Leviathan' },
+                    { value: '28', label: '28  CSI 5 - Deadly Intent' },
+					{ value: '29', label: '29  Tales of Monkey Island 104: The Trial and Execution of Guybrush Threepwood' },
+                    { value: '30', label: '30  CSI 4 - Hard Evidence' },
+					{ value: '31', label: '31  Tales of Monkey Island 105: Rise of the Pirate God' },
+					{ value: '32', label: '32  CSI 5 - Deadly Intent (demo)' },
+					{ value: '33', label: '33  Sam & Max: Episode 301 - The Penal Zone' },
+                    { value: '34', label: '34  Sam & Max: Episode 302 - The Tomb of Sammun-Mak' },
+					{ value: '35', label: '35  Sam & Max: Episode 303 - They Stole Maxs Brain!' },
+					{ value: '36', label: '36  Puzzle Agent - The Mystery of Scoggins' },
+					{ value: '37', label: '37  Sam & Max: Episode 304 - Beyond the Alley of the Dolls' },
+                    { value: '38', label: '38  Sam & Max: Episode 305 - The City That Dares Not Sleep' },
+					{ value: '39', label: '39  Poker Night at the Inventory' },
+                    { value: '40', label: '40  CSI 6 - Fatal Conspiracy' },
+					{ value: '41', label: '41  Back To The Future: Episode 1 - Its About Time' },
+					{ value: '42', label: '42  Back To The Future: Episode 2 - Get Tannen!' },
+					{ value: '43', label: '43  Back To The Future: Episode 3 - Citizen Brown' },
+                    { value: '44', label: '44  Hector: Episode 1 - We Negotiate with Terrorists' },
+					{ value: '45', label: '45  Back To The Future: Episode 4 - Double Visions' },
+					{ value: '46', label: '46  Back To The Future: Episode 5 - OUTATIME' },
+					{ value: '47', label: '47  Puzzle Agent 2' },
+                    { value: '48', label: '48  Jurassik Park: The Game' },
+					{ value: '49', label: '49  Hector: Episode 2 - Senseless Act of Justice' },
+                    { value: '50', label: '50  Hector: Episode 3 - Beyond Reasonable Doom' },
+					{ value: '51', label: '51  Law and Order: Legacies' },
+					{ value: '52', label: '52  Walking Dead: A New Day' },
+					{ value: '53', label: '53  Poker Night 2' },
+                    { value: '54', label: '54  The Wolf Among Us' },
+					{ value: '55', label: '55  The Walking Dead: Season 2' },
+					{ value: '56', label: '56  Tales from the Borderlands' },
+					{ value: '57', label: '57  Game of Thrones' },
+                    { value: '58', label: '58  Minecraft: Story Mode' },
+					{ value: '59', label: '59  The Walking Dead: Michonne' },
+                    { value: '60', label: '60  Batman: The Telltale Series' },
+					{ value: '61', label: '61  The Walking Dead: A New Frontier' },
+					{ value: '62', label: '62  Marvels Guardians of the Galaxy' },
+					{ value: '63', label: '63  Minecraft: Story Mode - Season Two' },
+                    { value: '64', label: '64  Batman: The Enemy Within' },
+					{ value: '65', label: '65  Bone: Out From Boneville 2.0' },
+					{ value: '66', label: '66  Bone: The Great Cow Race 2.0' },
+                    { value: '67', label: '67  The Walking Dead: The Telltale Definitive Series' },
+				]}
+				onChange={e => dispatch(StorageActions.setGameNumber(Number(e) ??  Number('67')))}
+			/>
+            <NumberInput
+				required
+				label="ttarchext Game number"
+				description="Default is 67 (TWDTTDS)."
+				value={gameNumber}
+				onChange={e => dispatch(StorageActions.setGameNumber(e ?? 67))}
+			/>
+            <NumberInput
+				required
+				label="Priority"
+				description="Set to 30 if editing TWDTTDS's main menu. Set to 1100 if overwriting existing Telltale assets. Default is 30."
+				value={PrioritySetting}
+				onChange={e => dispatch(StorageActions.setPrioritySetting(e ?? 30))}
+			/>
 			<TextInput
 				required
 				label="Game Executable"

src/renderer/hooks.ts

@@ -11,6 +11,8 @@ export const useBuildProject = () => {
 	const dispatch = useAppDispatch();
 	const projectPath = useAppSelector(state => state.filetree.root?.path);
 	const project = useAppSelector(state => state.project.currentProject);
+    const gameNumber = useAppSelector(state => state.storage.gameNumber);
+    const PrioritySetting = useAppSelector(state => state.storage.PrioritySetting);
 	const gameExePath = useAppSelector(state => state.storage.gamePath);
 	const saveFilesOnBuild = useAppSelector(state => state.storage.saveFilesOnBuild);
     const modBuildPath2 = useAppSelector(state => state.storage.modBuildPath);
@@ -22,7 +24,7 @@ export const useBuildProject = () => {
 
 		dispatch(BuildsActions.clearLogs());
 		dispatch(SidebarActions.setActiveTab('logs'));
-		const buildZipPath = await MainProcess.buildProject({ projectPath, project });
+		const buildZipPath = await MainProcess.buildProject({ projectPath, project, gameNumber, PrioritySetting });
 		dispatch(FileTreeAsyncActions.refreshRootDirectory());
 
 		if (!buildZipPath) {
@@ -62,7 +64,7 @@ export const useBuildProject = () => {
 		}
 
 		try {
-			await MainProcess.runProject({ projectPath, project, gamePath, modBuildPath});
+			await MainProcess.runProject({ projectPath, project, gamePath, modBuildPath, gameNumber, PrioritySetting});
 		} catch {
 			showNotification({
 				title: 'Unexpected Error',

src/renderer/slices/StorageSlice.ts

@@ -8,6 +8,8 @@ import {setSelectedTheme} from '../renderer';
 
 interface StorageState {
 	initialised: boolean,
+    gameNumber: number,
+    PrioritySetting: number,
 	gamePath?: string,
     modBuildPath?: string,
 	sidebarWidth: number,
@@ -19,26 +21,35 @@ interface StorageState {
 
 const initialState: StorageState = {
 	initialised: false,
+    gameNumber: 67,
 	sidebarWidth: 250,
 	recentProjects: [],
 	maximumBuildsToKeep: 5,
 	saveFilesOnBuild: true,
-	selectedTheme: "light"
+	selectedTheme: "light",
+    PrioritySetting: 30
 };
 
 // NOTE: This is automatically synchronised with a config file on disk to persist data between application restarts.
 export const StorageSlice = createSlice({
 	name: 'storage',
 	initialState,
 	reducers: {
+        //Mawrak Tweaks - new setting - Game number
+        setGameNumber: (state, {payload}: PayloadAction<number>) => {
+			state.gameNumber = payload
+		},
+        //Mawrak Tweaks - new setting - Priority
+        setPrioritySetting: (state, {payload}: PayloadAction<number>) => {
+			state.PrioritySetting = payload
+		},
 		setGamePath: (state, {payload}: PayloadAction<string | undefined>) => {
 			state.gamePath = payload
 		},
         //Mawrak Tweaks - new setting - Mod Folder
         setModPath: (state, {payload}: PayloadAction<string | undefined>) => {
 			state.modBuildPath = payload
 		},
-        
 		setSidebarWidth: (state, {payload}: PayloadAction<number>) => {
 			state.sidebarWidth = Math.round(Math.max(payload, initialState.sidebarWidth));
 		},

src/shared/Channels.ts

@@ -39,10 +39,11 @@ export const RenameFileChannel = createInvokableChannel<{ file: EditorFile, newN
 export const DeleteFileChannel = createInvokableChannel<EditorFile, void>('deletefile');
 export const CreateFileChannel = createInvokableChannel<{ directoryPath: string, extension: string }, string>('createfile');
 export const CreateDirectoryChannel = createInvokableChannel<string, string>('createdirectory');
-export const BuildProjectChannel = createInvokableChannel<{ projectPath: string, project: Project }, string | undefined>('buildproject');
+export const BuildProjectChannel = createInvokableChannel<{ projectPath: string, project: Project, gameNumber: number, PrioritySetting: number}, string | undefined>('buildproject');
 export const GetGamePathChannel = createInvokableChannel<void, string | undefined>('getgamepath');
 export const GetLocalStoreChannel = createInvokableChannel<void, AppState["storage"]>('getlocalstore');
-export const RunProjectChannel = createInvokableChannel<{ projectPath: string, project: Project, gamePath: string, modBuildPath: string}, void>('runproject');
+export const RunProjectChannel = createInvokableChannel<{ projectPath: string, project: Project, gamePath: string, modBuildPath: string, gameNumber: number, PrioritySetting: number}, void>('runproject');
+
 
 export const OpenInExplorerChannel = createChannel<string>('openinexplorer');
 export const MenuNewProjectChannel = createChannel('menu:newproject');