');
}
parent.append(patch);
}
updateUI(file) {
this.checkbox.checked = this.checkPatchBytes(file) === "on";
}
validatePatch(file) {
var status = this.checkPatchBytes(file);
if(status === "on") {
console.log('"' + this.name + '"', "is enabled!");
} else if(status === "off") {
console.log('"' + this.name + '"', "is disabled!");
} else {
return '"' + this.name + '" is neither on nor off! Have you got the right file?';
}
}
applyPatch(file) {
this.replaceAll(file, this.checkbox.checked);
}
replaceAll(file, featureOn) {
for(var i = 0; i < this.patches.length; i++) {
replace(file, this.patches[i].offset,
featureOn? this.patches[i].on : this.patches[i].off);
}
}
checkPatchBytes(file) {
var patchStatus = "";
for(var i = 0; i < this.patches.length; i++) {
var patch = this.patches[i];
if(bytesMatch(file, patch.offset, patch.off)) {
if(patchStatus === "") {
patchStatus = "off";
} else if(patchStatus != "off"){
return "on/off mismatch within patch";
}
} else if(bytesMatch(file, patch.offset, patch.on)) {
if(patchStatus === "") {
patchStatus = "on";
} else if(patchStatus != "on"){
return "on/off mismatch within patch";
}
} else {
return "patch neither on nor off";
}
}
return patchStatus;
}
}
class DynamicPatch {
constructor(options) {
this.name = options.name;
this.patches = options.patches;
this.tooltip = options.tooltip;
this.mode = options.mode;
this.target = options.target;
}
createUI(parent) {
var id = createID();
var label = this.name;
this.ui = $('
', {'class' : 'patch'});
this.checkbox = $('
')[0];
this.ui.append(this.checkbox);
this.ui.append('
' + label + ' ');
if(this.tooltip) {
this.ui.append('
' + this.tooltip + '
');
}
parent.append(this.ui);
}
updateUI(file) {
if (this.mode === 'all') {
this.checkbox.checked = this.checkPatchAll(file, true) === "on";
} else {
this.checkbox.checked = this.checkPatch(file, true) === "on";
}
}
validatePatch(file) {
var status = this.mode === 'all' ? this.checkPatchAll(file) : this.checkPatch(file);
if(status === "on") {
console.log('"' + this.name + '"', "is enabled!");
} else if(status === "off") {
console.log('"' + this.name + '"', "is disabled!");
} else {
return '"' + this.name + '" is neither on nor off! Have you got the right file?';
}
}
applyPatch(file) {
this.replaceAll(file, this.checkbox.checked);
}
replaceAll(file, featureOn) {
for(var i = 0; i < this.patches.length; i++) {
if (Array.isArray(this.patches[i].offset)) {
this.patches[i].offset.forEach((offset) => {
if (this.target === 'string') {
replace(file, offset,
new TextEncoder().encode(featureOn? this.patches[i].on : this.patches[i].off));
} else {
this.patches[i].on = this.patches[i].on.map((patch, idx) => patch === 'XX' ? file[offset + idx] : patch);
this.patches[i].off = this.patches[i].off.map((patch, idx) => patch === 'XX' ? file[offset + idx] : patch);
replace(file, offset,
featureOn? this.patches[i].on : this.patches[i].off)
}
}
);
} else {
if (this.target === 'string') {
replace(file, this.patches[i].offset,
new TextEncoder().encode(featureOn? this.patches[i].on : this.patches[i].off));
} else {
this.patches[i].on = this.patches[i].on.map((patch, idx) => patch === 'XX' ? file[this.patches[i].offset + idx] : patch);
this.patches[i].off = this.patches[i].off.map((patch, idx) => patch === 'XX' ? file[this.patches[i].offset + idx] : patch);
replace(file, this.patches[i].offset,
featureOn? this.patches[i].on : this.patches[i].off);
}
}
}
}
checkPatch(file, updateUiFlag = false) {
var patchStatus = "";
if (updateUiFlag) {
var listUi = $('
');
this.ui.append(listUi);
}
for(var i = 0; i < this.patches.length; i++) {
var patch = this.patches[i];
var offOffset = this.searchPatchOffset(file, patch.off, i);
var onOffset = this.searchPatchOffset(file, patch.on, i);
this.patches[i].offset = offOffset === -1 ? onOffset : offOffset;
if(offOffset > 0) {
if (updateUiFlag) {
if (this.target === 'string') {
listUi.append('
0x' + offOffset.toString(16) + ' ' + patch.off + ' will be replaced with '+ patch.on +' ');
} else {
listUi.append('
0x' + offOffset.toString(16) + ' will be replaced ');
}
}
if(patchStatus === "") {
patchStatus = "off";
}
} else if(onOffset > 0) {
if (updateUiFlag) {
if (this.target === 'string') {
listUi.append('
0x' + onOffset.toString(16) + ' ' + patch.on + ' will be replaced with '+ patch.off +' ');
} else {
listUi.append('
0x' + onOffset.toString(16) + ' will be replaced ');
}
}
if(patchStatus === "") {
patchStatus = "on";
}
} else if (this.mode === 'all') {
continue;
} else {
return "patch string not found";
}
}
return patchStatus;
}
checkPatchAll(file, updateUiFlag = false) {
var patchStatus = "";
if (updateUiFlag) {
var listUi = $('
');
this.ui.append(listUi);
}
for(var i = 0; i < this.patches.length; i++) {
var patch = this.patches[i];
var offOffset = this.searchPatchOffsetAll(file, patch.off);
var onOffset = this.searchPatchOffsetAll(file, patch.on);
this.patches[i].offset = offOffset.length === 0 ? onOffset : offOffset;
if(offOffset.length > 0) {
if (updateUiFlag) {
offOffset.forEach((offset) => {
listUi.append('
0x' + offset.toString(16) + ' will be replaced ');
});
}
if(patchStatus === "") {
patchStatus = "off";
}
} else if(onOffset.length > 0) {
if (updateUiFlag) {
onOffset.forEach((offset) => {
listUi.append('
0x' + offset.toString(16) + ' will be replaced ');
});
}
if(patchStatus === "") {
patchStatus = "on";
}
} else {
return "patch string not found";
}
}
return patchStatus;
}
searchPatchOffset(file, search, offset) {
if (this.target === 'string') {
var searchBytes = new TextEncoder().encode(search);
} else {
var searchBytes = search;
}
Uint8Array.prototype.indexOfArr = function(searchElements, fromIndex) {
fromIndex = fromIndex || 0;
var index = Array.prototype.indexOf.call(this, searchElements[0], fromIndex);
if(searchElements.length === 1 || index === -1) {
return {
match: false,
index: -1,
};
}
for(var i = index, j = 0; j < searchElements.length && i < this.length; i++, j++) {
if (this.target !== 'string' && searchElements[j] === 'XX') {
continue;
}
if(this[i] !== searchElements[j]) {
return {
match: false,
index,
};
}
}
return {
match: true,
index,
};
};
var idx = 0;
var foundCount = 0;
for (var i = 0; i < file.length; i++) {
var result = file.indexOfArr(searchBytes, idx);
if (result.match) {
if (offset === foundCount) {
return result.index;
}
foundCount++;
} else if (result.index === -1) {
break;
}
idx = result.index + 1;
}
return -1;
}
searchPatchOffsetAll(file, search) {
if (this.target === 'string') {
var searchBytes = new TextEncoder().encode(search);
} else {
var searchBytes = search;
}
Uint8Array.prototype.indexOfArr = function(searchElements, fromIndex) {
fromIndex = fromIndex || 0;
var index = Array.prototype.indexOf.call(this, searchElements[0], fromIndex);
if(searchElements.length === 1 || index === -1) {
return {
match: false,
index: -1,
};
}
for(var i = index, j = 0; j < searchElements.length && i < this.length; i++, j++) {
if (this.target !== 'string' && searchElements[j] === 'XX') {
continue;
}
if(this[i] !== searchElements[j]) {
return {
match: false,
index,
};
}
}
return {
match: true,
index,
};
};
var idx = 0;
var foundOffsetArray = [];
for (var i = 0; i < file.length; i++) {
var result = file.indexOfArr(searchBytes, idx);
if (result.match) {
foundOffsetArray.push(result.index);
} else if (result.index === -1) {
break;
}
idx = result.index + 1;
}
return foundOffsetArray;
}
}
// Each unique kind of patch should have createUI, validatePatch, applyPatch,
// updateUI
// The DEFAULT state is always the 1st element in the patches array
class UnionPatch {
constructor(options) {
this.name = options.name;
this.offset = options.offset;
this.patches = options.patches;
this.tooltip = options.tooltip;
}
createUI(parent) {
this.radios = [];
var radio_id = createID();
var container = $("
", {"class": "patch-union"});
container.append('
' + this.name + ':');
if(this.tooltip) {
container.append('' + this.tooltip + '
');
}
container.append(' ');
for(var i = 0; i < this.patches.length; i++) {
var patch = this.patches[i];
var id = createID();
var label = patch.name;
var patchDiv = $('
', {'class' : 'patch'});
var radio = $('
')[0];
this.radios.push(radio);
patchDiv.append(radio);
patchDiv.append('
' + label + ' ');
if(patch.tooltip) {
patchDiv.append('
' + patch.tooltip + '
');
}
container.append(patchDiv);
}
parent.append(container);
}
updateUI(file) {
for(var i = 0; i < this.patches.length; i++) {
if(bytesMatch(file, this.offset, this.patches[i].patch)) {
this.radios[i].checked = true;
return;
}
}
// Default fallback
this.radios[0].checked = true;
}
validatePatch(file) {
for(var i = 0; i < this.patches.length; i++) {
if(bytesMatch(file, this.offset, this.patches[i].patch)) {
console.log(this.name, "has", this.patches[i].name, "enabled");
return;
}
}
return '"' + this.name + '" doesn\'t have a valid patch! Have you got the right file?';
}
applyPatch(file) {
var patch = this.getSelected();
replace(file, this.offset, patch.patch);
}
getSelected() {
for(var i = 0; i < this.patches.length; i++) {
if(this.radios[i].checked) {
return this.patches[i];
}
}
return null;
}
}
// Each unique kind of patch should have createUI, validatePatch, applyPatch,
// updateUI
class NumberPatch {
constructor(options) {
this.name = options.name;
this.tooltip = options.tooltip;
this.offset = options.offset;
this.size = options.size;
this.min = options.min;
this.max = options.max;
}
createUI(parent) {
var id = createID();
var label = this.name;
var patch = $('
', {'class': 'patch'});
patch.append('
' + label + ': ');
var minmax = ' ';
if (this.min !== null) {
minmax += 'min="' + this.min + '" ';
}
if (this.max) {
minmax += 'max="' + this.max + '" ';
}
this.number = $('
')[0];
patch.append(this.number);
if (this.tooltip) {
patch.append('
' + this.tooltip + '
');
}
parent.append(patch)
}
updateUI(file) {
// This converts bytes from the file to big endian by shifting each
// byte `i` bytes to the left then doing a bitwise OR to add the less
// significant bytes that were gathered at earlier iterations of loop
var val = 0;
for (var i = 0; i < this.size; i++) {
val = (file[this.offset + i] << (8 * i)) | val;
}
this.number.value = val;
}
validatePatch(file) {
return;
}
applyPatch(file) {
// Convert user inputted number to little endian
const view = new DataView(new ArrayBuffer(this.size * 2));
view.setInt32(1, this.number.value, true);
for (var i = 0; i < this.size; i++) {
var val = view.getInt32(1);
// Shift off less significant bytes
val = val >> ((this.size - 1 - i) * 8);
// Mask off more significant bytes
val = val & 0xFF;
// Write this byte
file[this.offset + i] = val;
}
}
}
var loadPatch = function(_this, self, patcher) {
patcher.loadPatchUI();
patcher.updatePatchUI();
patcher.container.show();
var successStr = patcher.filename;
if ($.type(_this.description) === "string") {
successStr += "(" + patcher.description + ")";
}
self.successDiv.html(successStr + " loaded successfully!");
};
class PatchContainer {
constructor(patchers) {
this.patchers = patchers;
this.createUI();
}
getSupportedDLLs() {
var dlls = [];
for (var i = 0; i < this.patchers.length; i++) {
var name = this.patchers[i].filename;
if (dlls.indexOf(name) === -1) {
dlls.push(name);
}
}
return dlls;
}
createUI() {
var self = this;
var container = $("
", {"class": "patchContainer"});
var header = this.getSupportedDLLs().join(", ");
container.html("
" + header + " ");
var supportedDlls = $("
");
this.forceLoadTexts = [];
this.forceLoadButtons = [];
this.matchSuccessText = [];
for (var i = 0; i < this.patchers.length; i++) {
var checkboxId = createID();
var listItem = $("");
$('')
.attr("for", checkboxId)
.text(this.patchers[i].description)
.addClass('patchPreviewLabel')
.appendTo(listItem);
var matchPercent = $('').addClass('matchPercent');
this.forceLoadTexts.push(matchPercent);
matchPercent.appendTo(listItem);
var matchSuccess = $('').addClass('matchSuccess');
this.matchSuccessText.push(matchSuccess);
matchSuccess.appendTo(listItem);
var forceButton = $('').text('Force load?').hide();
this.forceLoadButtons.push(forceButton);
forceButton.appendTo(listItem);
$(" ", {
"class": "patchPreviewToggle",
"id": checkboxId,
"type": "checkbox",
}).appendTo(listItem);
var patchPreviews = $("").addClass('patchPreview');
for (var j = 0; j < this.patchers[i].mods.length; j++) {
var patchName = this.patchers[i].mods[j].name;
$('').text(patchName).appendTo(patchPreviews);
}
patchPreviews.appendTo(listItem);
listItem.appendTo(supportedDlls);
}
$("html").on("dragover dragenter", function () {
container.addClass("dragover");
return true;
})
.on("dragleave dragend drop", function () {
container.removeClass("dragover");
return true;
})
.on("dragover dragenter dragleave dragend drop", function (e) {
e.preventDefault();
e.stopPropagation();
});
container.on("drop", function (e) {
var files = e.originalEvent.dataTransfer.files;
if (files && files.length > 0)
self.loadFile(files[0]);
});
var filepickerId = createID();
this.fileInput = $(" ",
{
"class": "fileInput",
"id": filepickerId,
"type": "file",
});
var label = $("", {"class": "fileLabel", "for": filepickerId});
label.html("Choose a file or drag and drop.");
this.fileInput.on("change", function (e) {
if (this.files && this.files.length > 0)
self.loadFile(this.files[0]);
});
this.successDiv = $("", {"class": "success"});
this.errorDiv = $("
", {"class": "error"});
container.append(this.fileInput);
container.append(label);
$("
Supported Versions: ").appendTo(container);
$("
Click name to preview patches ").appendTo(container);
container.append(supportedDlls);
container.append(this.successDiv);
container.append(this.errorDiv);
$("body").append(container);
}
loadFile(file) {
var reader = new FileReader();
var self = this;
reader.onload = function (e) {
var found = false;
// clear logs
self.errorDiv.empty();
self.successDiv.empty();
for (var i = 0; i < self.patchers.length; i++) {
// reset text and buttons
self.forceLoadButtons[i].hide();
self.forceLoadTexts[i].text('');
self.matchSuccessText[i].text('');
var patcher = self.patchers[i];
// remove the previous UI to clear the page
patcher.destroyUI();
// patcher UI elements have to exist to load the file
patcher.createUI();
patcher.container.hide();
patcher.loadBuffer(e.target.result);
if (patcher.validatePatches()) {
found = true;
loadPatch(this, self, patcher);
// show patches matched for 100% - helps identify which version is loaded
var valid = patcher.validPatches;
self.matchSuccessText[i].text(' ' + valid + ' of ' + valid + ' patches matched (100%) ');
}
}
if (!found) {
// let the user force a match
for (var i = 0; i < self.patchers.length; i++) {
var patcher = self.patchers[i];
var valid = patcher.validPatches;
var percent = (valid / patcher.totalPatches * 100).toFixed(1);
self.forceLoadTexts[i].text(' ' + valid + ' of ' + patcher.totalPatches + ' patches matched (' + percent + '%) ');
self.forceLoadButtons[i].show();
self.forceLoadButtons[i].off('click');
self.forceLoadButtons[i].click(function(i) {
// reset old text
for(var j = 0; j < self.patchers.length; j++) {
self.forceLoadButtons[j].hide();
self.forceLoadTexts[j].text('');
}
loadPatch(this, self, self.patchers[i]);
}.bind(this, i));
}
self.errorDiv.html("No patch set was a 100% match.");
}
};
reader.readAsArrayBuffer(file);
}
}
class Patcher {
constructor(fname, description, args) {
this.mods = [];
for(var i = 0; i < args.length; i++) {
var mod = args[i];
if(mod.type) {
if(mod.type === "union") {
this.mods.push(new UnionPatch(mod));
}
if(mod.type === "number") {
this.mods.push(new NumberPatch(mod));
}
if(mod.type === "dynamic") {
this.mods.push(new DynamicPatch(mod));
}
} else { // standard patch
this.mods.push(new StandardPatch(mod));
}
}
this.filename = fname;
this.description = description;
this.multiPatcher = true;
if (!this.description) {
// old style patcher, use the old method to generate the UI
this.multiPatcher = false;
this.createUI();
this.loadPatchUI();
}
}
createUI() {
var self = this;
this.container = $("
", {"class": "patchContainer"});
var header = this.filename;
if(this.description === "string") {
header += ' (' + this.description + ')';
}
this.container.html('
' + header + ' ');
this.successDiv = $("
", {"class": "success"});
this.errorDiv = $("
", {"class": "error"});
this.patchDiv = $("
", {"class": "patches"});
var saveButton = $("");
saveButton.text('Load file First');
saveButton.on('click', this.saveDll.bind(this));
this.saveButton = saveButton;
if (!this.multiPatcher) {
$('html').on('dragover dragenter', function() {
self.container.addClass('dragover');
return true;
})
.on('dragleave dragend drop', function() {
self.container.removeClass('dragover');
return true;
})
.on('dragover dragenter dragleave dragend drop', function(e) {
e.preventDefault();
});
this.container.on('drop', function(e) {
var files = e.originalEvent.dataTransfer.files;
if(files && files.length > 0)
self.loadFile(files[0]);
});
var filepickerId = createID();
this.fileInput = $(" ",
{"class": "fileInput",
"id" : filepickerId,
"type" : 'file'});
var label = $("", {"class": "fileLabel", "for": filepickerId});
label.html('Choose a file or drag and drop.');
this.fileInput.on('change', function(e) {
if(this.files && this.files.length > 0)
self.loadFile(this.files[0]);
});
this.container.append(this.fileInput);
this.container.append(label);
}
this.container.append(this.successDiv);
this.container.append(this.errorDiv);
this.container.append(this.patchDiv);
this.container.append(saveButton);
$("body").append(this.container);
}
destroyUI() {
if (this.hasOwnProperty("container"))
this.container.remove();
}
loadBuffer(buffer) {
this.dllFile = new Uint8Array(buffer);
if(this.validatePatches()) {
this.successDiv.removeClass("hidden");
this.successDiv.html("File loaded successfully!");
} else {
this.successDiv.addClass("hidden");
}
// Update save button regardless
this.saveButton.prop('disabled', false);
this.saveButton.text('Save Patched File');
this.errorDiv.html(this.errorLog);
}
loadFile(file) {
var reader = new FileReader();
var self = this;
reader.onload = function(e) {
self.loadBuffer(e.target.result);
self.updatePatchUI();
};
reader.readAsArrayBuffer(file);
}
saveDll() {
if(!this.dllFile || !this.mods || !this.filename)
return;
for(var i = 0; i < this.mods.length; i++) {
this.mods[i].applyPatch(this.dllFile);
}
var blob = new Blob([this.dllFile], {type: "application/octet-stream"});
saveAs(blob, this.filename);
}
loadPatchUI() {
for(var i = 0; i < this.mods.length; i++) {
this.mods[i].createUI(this.patchDiv);
}
}
updatePatchUI() {
for(var i = 0; i < this.mods.length; i++) {
this.mods[i].updateUI(this.dllFile);
}
}
validatePatches() {
this.errorLog = "";
var success = true;
this.validPatches = 0;
this.totalPatches = this.mods.length;
for(var i = 0; i < this.mods.length; i++) {
var error = this.mods[i].validatePatch(this.dllFile);
if(error) {
this.errorLog += error + " ";
success = false;
} else {
this.validPatches++;
}
}
return success;
}
}
window.Patcher = Patcher;
window.PatchContainer = PatchContainer;
})(window, document);