Tool TML GOG Patcher [Beta]

Discussion in 'Released' started by Jeckel, Oct 18, 2016.

  1. Jeckel

    Jeckel Moderator Staff Member Moderator

    THIS SOFTWARE IS IN BETA. PLEASE LET ME KNOW IF YOU HAVE ANY ISSUES WITH THE APPLICATION.

    TmlGogInstaller.png The TML GOG Patcher provides a simple cross-platform method for applying tModLoader (TML) patches to the Good Old Games (GOG) versions of Terraria.


    This application provides an easy way to install the client and server patches, as well as required dependency files, to allow those who own the GOG version of Terraria to create and utilize tModLoader mods. The process is straight forward: enter or browse for the directory containing the Terraria.exe and TerrariaServer.exe files, select the desired options, click the Install button, and wait for the installation process to complete. The actions taken during installation are displayed in the text box at the bottom of the application as well as written to a log file that can be accessed via the View Log button at the top left.

    Additionally, several buttons are provided at the top right which allow quick access to various TMLGOGPatcher, Terraria, and tModLoader folders (such as Patches, Mods, Players, and Worlds) and web pages, as well as the application About dialog which contains information about the application and licenses associated with it and the libraries and assets it makes use of. Additionally, next to the View Log button, there is a Patch Tools dropdown menu that allows the user to download a TML GOG Patch files. Lastly, on Windows, there are two buttons next to the Patch Tools menu that will allow the user to start Terraria (either from the unpatched client file or the backup client file) and tModLoader (either from the patched client file or the generated TML client file).

    TMLGOGPatcher_Windows_Screenshot.png TMLGOGPatcher_Mac_Screenshot.png TMLGOGPatcher_Linux_Screenshot.png

    [​IMG]

    Known Bugs
    • On Linux, the logging text box does not always update properly when resizing or scrolling, resulting in black lines being drawn across the box at weird positions and obscuring the text. A solution is being looked into, but for now use the View Log button and read the log file to determine success or failure of installation.
    • On Linux, occasionally the application will lock up when patch files are added or removed from the patches folder. There is currently no solution to this issue, so for now if it happens, then restart the application.
    • As of 2016/12/17 v1.1.1.0, this dialog has been disabled on Mac. -- On Mac, the Patch Tools Download dialog does not work. A solution has not been found yet, so for now please manually download patch files from the TML GOG Patcher Website or Wiki, which can be found through the Visit Webpages menu, with your browser and manually place them in the patches folder, which can be found through the Open Folders menu.
    • The Linux and Mac interfaces don't look great. This will be solved at some point in the future, but for now they are acceptable.

    [​IMG]

    Application Features
    • Control which aspects of TML is installed: client, server, and/or dependency files.
    • Control if the Terraria client and/or server is overwritten by TML or if new exe files are created.
    • Keeps a log of installation attempts to help with trouble shooting should problems occur.
    • Provides easy access to TML GOG Patcher, Terraria, and tModLoader folders and websites.
    • Most important of all, the Terraria files are verified before and after installation to ensure that the proper patch is applied and that it is applied successfully.

    [​IMG]

    Installation Options
    • Terraria and TML version selection dropdowns allow the user to select which version of Terraria is to be patched and which version of tModLoader it is to be patched with. These options will be automatically updated when patches are added or removed from the patches directory and will be set to the best matching patched if one is found. The ability to set non-matching values is allowed in case the version number of the Terraria files is not updated appropriately, which has happened occasionally with past updates to the game.
    • Overwrite Client and Overwrite Server check boxes control whether the Terraria.exe and TerrariaServer.exe files are patched directly or if tModLoader.exe and tModLoaderServer.exe files are generated instead. The default on Windows is to overwrite Terraria.exe and to generate tModLoaderServer.exe. On Linux and Mac, the default is to overwrite both the client and server and it is recommended to leave both selected as there is currently no mechanism to launch TML if the original files are not overwritten.
    • Install Client, Install Server, and Install Dependencies check boxes allow the user to install all or specific pieces of TML. This is useful if the user needs to reinstall lost dependency files, is just patching a server, or in other similar situations, though generally one will want all three boxes checked.

    [​IMG]

    Usage Guide
    • The first step is to download the TML GOG Patcher application for your operating system from the download links below: Downloads
    • After downloading the application, you will need to download the patch for the version of Terraria that you are currently using from the links below: Patch Files
      If you don't know what version you are using, then you can start Terraria and find the version in the bottom left corner of the main menu screen or you can start the TML GOG Patcher, browse to the location of the Terraria.exe file, and you will see the version number in the status bar at the bottom of the application.
    • Once the patch file is downloaded, it needs to be placed in the TML GOG Patcher's patches folder. The patches folder is located in the TMLGOGPatcher folder which is located along side Terraria's players and worlds folders. The patches folder can also be opened from the Open Folders menu in the TML GOG Patcher's toolbar.
    • Once the patch file is in the patches folder, TML GOG Patcher will see it if the application is already running, otherwise start the application.
    • Lastly, select the Installation Options and click the Install button and the application will patch up Terraria with TML and then you should be ready to enjoy Terraria with mods.

    [​IMG]

    Windows Installation Instructions
    1. Download and unzip Windows TMLGOGPatcher_WindowsRelease.zip from below.
    2. The TMLGOGPatcher.exe should now be ready to run by double-clicking.

    [​IMG]

    Mac Installation Instructions
    1. Download and unzip Mac TMLGOGPatcher_MacRelease.zip from below.
    2. Download and install the mono package (Instructions): Download
    3. TMLGOGPatcher.exe should now be ready to run through the terminal:
      Code:
      mono <location>/TMLGOGPatcher.exe

    [​IMG]

    Linux (Ubuntu) Installation Instructions
    1. Download and unzip Linux TMLGOGPatcher_LinuxRelease.zip from below.
    2. Install mono package through the terminal (Instructions):
      Code:
      sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF
      echo "deb http://download.mono-project.com/repo/debian wheezy main" | sudo tee /etc/apt/sources.list.d/mono-xamarin.list
      sudo apt-get update
      echo "deb http://download.mono-project.com/repo/debian wheezy-apache24-compat main" | sudo tee -a /etc/apt/sources.list.d/mono-xamarin.list
    3. TMLGOGPatcher.exe should now be ready to run through the terminal:
      Code:
      mono <location>/TMLGOGPatcher.exe

    [​IMG]

    Publishing Mods

    UPDATE: As of tModloader version 0.9.2.0, the TML gui will prompt GOG users to visit the TML Registration web page and to enter both their TML Passphrase and Steam ID, greatly simplifying the process of setting your installation up to publish mods to the ModBrowser.

    As of tModLoader version 0.9.x.x for Terraria 1.3.4.4, it is now possible for modders who use GOG TML to publish mods to TML's ModBrowser. To set up your TML installation to make mod publishing possible, follow the below steps:
    1. Visit http://javid.ddns.net/tModLoader/register.php in your browser and log in using your Steam Account.
    2. That web page will display your Steam ID and your TML Passphrase, take note of both of these.
    3. Open TML's /Terraria/ModLoader/config.json file in a text editor.
    4. Find the SteamID64 element in the config.json and enter your Steam ID from the web page.
      Code:
      "SteamID64": "00000000000000000"
    5. Find the ModBrowserPassphrase element in the config.json and enter your Passphrase from the web page.
      Code:
      "ModBrowserPassphrase": "a0000a0000000a00000a0000a0000a00"
    6. Save the config.json file and you are all set to publish, manage, and unpublish your mods.

    [​IMG]

    Downloads
    • Version: 1.1.1.0 (2016/12/17)
    • Tested On: Windows 7 | Mac 10.7 Lion | Linux Ubuntu 16.04
    • Download: Windows | Mac | Linux
    Patch Files
    [​IMG]

    Future Plans
    • Write up a proper usage guide with images and step by step instructions.
    • Implement better looking interfaces for Linux and Mac versions.
    • Provide standalone versions for Linux and Mac that don't require installation of Mono.
    • Provide the Mac version as a bundled .app package.
    • Provide Windows, Linux, and Mac installers instead of or perhaps in addition to the zips.

    [​IMG]

    [​IMG] This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. Utilised assets are released under various licenses, see the included Lincenses.txt file for details.
     
    Last edited: Apr 18, 2017
  2. Jeckel

    Jeckel Moderator Staff Member Moderator

  3. Jofairden

    Jofairden Terrarian

    You're a beast, Jeckel.. A beast............... and a beaut.
     
    Jeckel likes this.
  4. the king (lol)

    the king (lol) Terrarian

    oh so its a mod application. i dont need it. not with bug anymore
     
  5. Jeckel

    Jeckel Moderator Staff Member Moderator

    Added a basic Usage Guide to the opening post. It isn't super detailed, but should suffice until I can write up a proper guide with images and full step by step instructions.
     
  6. ManaUser

    ManaUser The Destroyer

    Great to see the GOG version getting some attention. I haven't been using mods recently, but I'll definitely give this a try next time i do.
     
    Jeckel likes this.
  7. John Bernard

    John Bernard Terrarian

    One thing i noticed on the Mac side is to instal it under your Documents and not under applications. The tool cant find Applications

    Also once I was able to get it detected the drop down boxes for ver and such never populated
     

    Attached Files:

  8. Jeckel

    Jeckel Moderator Staff Member Moderator

    I am not very familiar with Mac and wasn't aware that it couldn't locate the Applications area. I assume it is because it isn't yet bundled as a .app package. I will put this on my list of Mac issues and investigate a solution. Thank you for reporting this.

    To the drop downs. Have you downloaded any patch zip files and placed them in the application's patches directory? The drop downs won't populate until there are patch files to populate it from, see the Usage Guide section of the opening post: http://forums.terraria.org/index.php?threads/x.50413/#usage

    If have placed patch file in the patches directory, then perhaps there is some permissions issues when it is installed into Applications that I will need to look into.

    EDIT: Oh, wait, I misunderstood part of that. You were saying that it couldn't locate Terraria when Terraria is installed in the Applications directory. I had been testing it with Terraria installed to the Documents directory as that is the default location that the Terraria installer offered to place it and assumed that was correct practice. I will investigate the issue and switch over to using Applications as the default Terraria installation location. Thank you very much for the heads up on that. :)
     
    Last edited: Oct 26, 2016
  9. NuclearPhoenix

    NuclearPhoenix Terrarian

    I got the same problem as john were i don't get the drop downs, do I have to place the patch file contents or the whole folder inside the patches directory? I've have done both and nothing changes..., I'm on windows by the way.
     
  10. Jeckel

    Jeckel Moderator Staff Member Moderator

    Place the zip file itself in the patches directory, ie without unzipping it. I will make a note of that in the usage guide section of the opening post and perhaps in the next version of the application I will change the files to use an extension other than .zip to avoid the confusion.
     
  11. NuclearPhoenix

    NuclearPhoenix Terrarian

    It worked, Thanks for the help.
     
    Jeckel likes this.
  12. John Bernard

    John Bernard Terrarian

    Ahh place the zip file. i didn't catch that either. ok trying it again



    Update: I have copied the zip file in to the folder and it still does not bring it up in the drop down list


    Update 2: Upon rereading the Usage guide id like to have the following explained a little better:

    1. The patcher - Should it have a Patches folder in it or.....?
    2. Does the Patcher program need to be in the same directory as Terraria?


    Keep up the great work!!!
     
    Last edited: Oct 27, 2016
  13. Jeckel

    Jeckel Moderator Staff Member Moderator

    On Mac, the patch zip files should be placed in your "~/Library/Application Support/Terraria/TMLGOGPatcher/Patches" folder. Basically all the application's data, log, and patch files will be inside the TMLGOGPatcher folder that is along side the Terraria Players and Worlds folders. Not sure if that is what you were asking, if not please rephrase your question and I'll try to answer it better.

    Nope, you should be able to place patcher application anywhere.

    Thanks. :) I'm going to try to get some free time over the next couple weeks and write up a much better usage guide with images and whatnot. Hopefully over the same timeframe I can get an update out to have it default to finding Terraria in the Applications folder and changing the extension of the patch files from .zip to something else.
     
  14. John Bernard

    John Bernard Terrarian

    --- Double Post Merged, Oct 28, 2016, Original Post Date: Oct 28, 2016 ---
    Ahh thats perfect. I didnt realize where that was. I will try that and see what happens

    Update # 1 Perfect. that did the trick. its patched
     
    Last edited: Oct 28, 2016
    Jeckel likes this.
  15. John Bernard

    John Bernard Terrarian

    Update # 2 Ran Terraria and check it out!!!

    Update# 3 So when i go to browse the mods the list is black. getting closer
     

    Attached Files:

  16. Jeckel

    Jeckel Moderator Staff Member Moderator

    As I understand it, the mod browser currently only works on Windows systems. Mac and Linux have to download mods manually and put them into the "~/Library/Application Support/Terraria/ModLoader/Mods" folder yourself.

    Glad you got your game patched and running. :)

    EDIT: You can either download the mods from their thread here on the forum if they have a thread and a download link, or you can download them from the mod browser server through this page: http://javid.ddns.net/tModLoader/DirectModDownloadListing.php
     
  17. Hacker0k20001

    Hacker0k20001 Terrarian

    People,I have a problem
    When i try to install TML,installation stops and write this
     

    Attached Files:

  18. Jeckel

    Jeckel Moderator Staff Member Moderator

    Just to check, you have the GOG version of Terraria and not the Steam version, correct?
    If yes, then have you used any other tools that modify the exe?

    If you have the GOG version and haven't modified the exe with any other tools, then my suggestion would be to reinstall Terraria and try again with that fresh install. You won't lose any of your players or worlds by reinstalling.

    If that doesn't work, then I have to assume that it is because you seem to be using a Russian version of the game. I wasn't even aware there was a Russian GOG version.
     
  19. Hacker0k20001

    Hacker0k20001 Terrarian

    Ok,I will try to install English version and write later.
     
    Jeckel and diekonradish like this.
  20. Hacker0k20001

    Hacker0k20001 Terrarian

    The same situation
    --- Double Post Merged, Oct 30, 2016, Original Post Date: Oct 30, 2016 ---
    Wait a minute
    So,i download a steam veriosn of terraria and install tml in steam's terraria folder and its working!
    --- Double Post Merged, Oct 30, 2016 ---
    But i still need a way to play with TML on russian version of Terraria
    I think,after few experiments i will find it(I hope)
     

    Attached Files: