Jump to content

Recommended Posts

image.png.c8e6e625f39cd4f17e59fa388b4a6da7.png

Tequila User Guide

By GM_Tahquitz, who does not drink alcohol in the first place.

 

No, it's not that kind of user guide.  Operating a shot glass is outside of the scope of this website.

 

It's funny, I've spent three years of my life being the unofficial tech support for this program in one way or another, and I'm not a programmer.  I've come this far, let's see if I can spend another three more. 😛

 

Tequila is described as follows on GitHub:

Quote

"Tequila is a general purpose patcher that can keep software up to date and launch it."

 

(Pretty terse, I know.)

 

In short, Tequila was made after the game shutdown occured to get Issue 24 client files out to as many people as possible (the basis of various projects... and the history of Tequila isn't the subject of this post).  In that, Tequila is a definite success. 

 

As this is a guide on the Homecoming Servers, Tequila is one of the supported ways to launch City of Heroes with the Homecoming Servers shards for Windows computers.  It can launch the game for any compatible manifest, so it can launch servers from other COH communities if you like.  (Homecoming Servers is not responsible for their tech support.  We'll show you how to enter a new manifest below, but from there it's between you and them.)

 

741517846_HomecomingIcon.png.31b9c80a40148d0cd5a040a4eb8d5790.thumb.png.715e88c28b22d9d02ed7b4a7e6d2485b.png

BEFORE YOU PROCEED...
The Homecoming Launcher is now the primary recommended method to launch Homecoming: City of Heroes for Windows and Mac users.  On newer Linux builds, it also launches under Wine as well.  It's built and maintained by HC Team 100%.

 

If you haven't tried it already, give it a shot.

 

Tequila will continue to receive manifest updates indefinitely.  Homecoming Launcher does not have Titan Icon or Paragon Chat, so if you wish to keep those utilities, you're welcome to keep using Tequila as long as you like.

 

How it Works

Behind the scenes, Tequila's magic is accomplished by a manifest file, or a list that is updated by a programmer on locations and instructions where to find files to update a program.  It uses a checksum to verify that the file downloaded is the one expected by the programmer, and overwrites the prior ones, so you have an updated program when a new version of City of Heroes is finished.  This is all done in Tequila's startup process:

 

  1. Collecting Info: Fetching the updated Manifest File.  The launch definitions are updated if necessary, changing the launch commands visible.
  2. Validation: Tequila begins Validating the files present in the folder and comparing their checksums against the Manifest.
  3. Download Updates: If the files do not match, they are downloaded one after another.  If there are files that do match, they are left as they are.  (Files not in the manifest such as config files and player mods are ignored.)
  4. Report: Once the downloading is finished, Tequila reports "Done." if no issues occured.  If it didn't complete, a list of "Errors" in the main window show certain files that did not download.  At that point, you can close and reopen Tequila to try again.

 

Tip: You don't always have to wait for the patcher to finish before starting the game.  At ANY point in this process, you are free to double click a Launcher name to try to start the client.  Remember, though -- the launch definitions are always updated first, so if the game does not get updated files the launch command will not align with the current game version and you'll get an error when signing in.

 

If you login and the game says you have the wrong version, close the client, reopen Tequila if you closed it, and wait for the patch to finish before trying again.  (When ready to start, the bar will be fully green and "Done..." will be visible, like below.)

 

User Interface

image.png.98db036ff6f5880066085e8d9848a121.png

 

Tequila has three main areas: 

 

 

Launchers:

image.png.f8a7399049d15184472d5f462eeb4ced.png

Program Launchers are on the left hand side.  These are updated FIRST by the Tequila Manifest file.  You can launch one immediately, even while patching files, by double clicking on a program name.

 

As of April 2020, the current manifest has the following:

  • Homecoming (64-Bit) - Launches the 64-bit client.
  • Homecoming (32-Bit) - Launches the 32-bit client.
  • Paragon Chat - Opens Titan Network's Paragon Chat, which is included with Issue 24 as a chat program based in City of Heroes.  It does badges, mini-games, and base editing, but is intended for RP group usage.  This DOES NOT connect to the Homecoming Servers, and is a different service altogether.  Requires a forum account on Titan Network to login.
  • Titan Icon v1.71 - Opens Titan Network's Icon, which is a machinima tool to let users place, animate and use NPCs as well as experiment with  costumes, among other features.  No Internet or user account required, but it's "single player" only, so you won't see anyone except yourself.

 

Controls:

image.png.ed524d029104895ff92a73cd6fb28c21.png

The following controls for the patcher are available:

 

PLAY -- Does the same as double-clicking on a program.  While patching, PLAY will show dashes until patching is complete.

 

MANIFEST (Unlabeled) -- Shows the current manifest being processed.  When patching is through, you can change manifest by clicking on the drop down list.  While patching, this list will be grayed out.  You can edit these entries in OPTIONS (below). 

 

SCREENSHOTS -- Opens the Screenshot folder for the game, allowing you quick access to pictures taken with the Print Screen function (actual button depends on your key binds.)

 

OPTIONS -- Shows the Tequila Options panel:

image.png.c8ea2e5361123e92ea8203d3cbede7d1.png

 

Launch Parameters -- This allows you to add command line arguments to City of Heroes BEFORE launching the client.  Useful for Demoediting playback, troubleshooting or advanced uses.  You can find command line arguments in Paragon Wiki.

 

Close Tequila after starting the game. -- Tequila operates at 15MB in RAM, but if you like keeping resources as clean as possible, check this box to close Tequila once the game is started successfully.  Unchecking this means Tequila stays open, which can be useful for "multiboxing" (opening multiple clients.)

 

Install Path -- This is where you want Tequila to install the files.  When Tequila is ran for the first time, a folder selection box will appear asking for this path before it gets the first manifest update.  This is the same path, which you can change at any time.  (Changing the path to an empty folder means redownloading all of the Issue 24 files again, which can take a long time.)

 

Colors -- You can recolor Tequila to fit your preferences.  Default is your system colors.

 

Manifests -- You can enter a custom manifest to open the Beta Client, or other servers out there.  Homecoming's manifests are as follows:

http://patch.savecoh.com/manifest.xml

http://patch.savecoh.com/beta.xml

 

Re-Validate -- Touching this button causes Tequila to restart the manifest validation process.  Useful when correcting an address and you don't want to restart Tequila.

 

Information

image.png.b22c059c8a51bca5a06b6e54c1f0aafd.png

The last segment of the screen is the Information window.  This shows information chosen by the Manifest author that is useful to the players.  Clicking on this box opens an Internet Explorer window with further info.

 

This area also shows errors during patching.  If the Information window turns white and lists an error, Tequila has stopped patching and cannot launch a game until you either go to Options and click "Re-Validate" or close and reopen the app.  The most common causes of errors:

  • Make sure you have enough hard drive space for Tequila and the game client.  A simple number to keep in mind when installing for the first time is around 6GB, which is plenty of room for saved costumes, screenshots and other saved files.  Less than 6GB, Tequila will have problems finishing it's first run.  (There is no "minimum client" available for devices with low storage space.)
  • Make sure Tequila as well as the directory it is installed in are set as exceptions in your Antivirus Application of choice.  You'll need to refer to your documentation.
  • City of Heroes is an online game, which requires an active Internet connection to update and connect.  In most cases, if your Internet is working, Tequila should be able to do what it needs to do.  Some possibilities:
    • Check your network cabling and router if you're using Ethernet. 
    • Check your Wi-Fi Network if you are having difficulties on a laptop or other wireless device.  If you're on a Public Wi-Fi connection, such as at a Starbucks, restaurant, school, workplace, hotel, etc., you might be prohibited from playing games on their service.  Check the Usage Policies if this is the case.  (In the case of a Hotel, there may be a fee for "Standard Internet" access vs. "Basic Internet" where only websites and email work but no videos, streaming media, or gaming.)
    • If you are able to reach another website or start another online game and Homecoming will not login, you can check the Server Status page and see if Homecoming is down for a maintenance window (this does happen on occasion.)

 

Prerequisites

As with any program, Tequila and Homecoming Servers has requirements before you can run it for the first time on a computer that has never run it.  These requirements are:

 

Both of these are available for free, but may need explanation:

 

Microsoft .NET 3.5 Framework

.NET Framework has been notoriously slow and difficult to install for a program runtime.  The traditional method is to download the above installer and let the installer handle it.  But I've seen systems on Fiber Internet sit there for hours and not progress, or give vague errors and cancel.  There's a way we install it in tech circles that is faster, but requires a Windows Installation CD or USB.  (If you are on Windows 10, one can be made at anytime.  Click here, and choose "Download Tool Now".  You'll need a 8GB Flash Drive that you won't miss giving up.  For bonus tech points: create an ISO with the tool, and mount the ISO as a pseudo-DVD drive.)

 

You'll need to open an elevated command prompt.  To do this, press START (Win key on the keyboard, or the Windows Logo in the corner of the taskbar) and type "cmd" but DON'T PRESS ENTER.  Instead, hold down CTRL+SHIFT and press ENTER.

 

If it worked, you'll get a challenge window.

 

command-prompt-admin-uac.png.8b7ba97754e2443eb25296cbfe62bf36.png

 

Answer yes, and you'll see this:

 

image.png.24604ca4721c9d085ff2587bbb2e3dbc.png

 

(Mine's transparent, yours may look different.)  You'll see "Administrator: Command Prompt" in the title if you're successful.  If you see "Command Prompt" and no challenge box opened, you're on a standard account and cannot open an elevated prompt.

 

Once this is open type the following.  You'll need to adapt it to your Windows install location:

Quote

DISM /Online /Enable-Feature /FeatureName:NetFx3 /All /LimitAccess /Source:X:\sources\sxs

...where X: is your USB or CD Drive containing the Windows Installer.  You MIGHT need a different path on the /Source part of the command if the Windows Installer is a dual-architecture one.  (Use X:\Sources\x86\sxs or X:\Sources\x64\sxs accordingly.)

 

Enter this, and you'll see the following:

NET-CMD.png.108ee9c788e5dd9872db55754d2484b0.png

 

If the command succeeds, your .Net 3.5 Framework will be installed in minutes.  No internet connection even necessary to finish it!  If it doesn't succeed, check the syntax (what you typed) and make sure the Sources address is correct on your system.  USB Drives can take any drive letter, so it's up to you to find it on your computer (G: isn't going to be the answer above.)

 

Install the .NET Framework here.

 

If strange errors happen in Tequila such as below:
image.png.017999ec13cae2a338a05ced2f013c14.png

 

... check Windows Update and make sure .NET Framework isn't waiting to be updated.  If it is, allow Windows to finish updating, and restart your computer if needed.  Then launch Tequila and see if it clears up.

 

Visual C++ 2015 Runtime

This isn't needed for Tequila specifically, but City of Heroes itself.  If you launch the game client, and see this pop up over Tequila...

0EM3A0000008GQD.jpeg.1a6b25ed8ea1c95af0309704f845df5b.jpeg

(Not this SPECIFIC window, as programname.exe isn't going to match the client, but you get the picture.)

 

...this tells you that the Visual C++ 2015 Runtime is not present on your system.  This is needed to launch the game. 
 

IMPORTANT: On a 64-bit system the runtime you select will be the version of Homecoming that will work.  (If you're on a 64-bit system and install 32-bit runtimes, you're playing Homecoming 32-bit.)  If you're on a 32-bit system, your only choice is the 32-bit runtime.  64-bit won't run at all.

 

Visual C++ 2015 comes in two flavors: x86 (the 32-bit version) and x64 (natch, the 64-bit version.)   WE RECOMMEND MOST USERS TO INSTALL THE 64-BIT RUNTIMES unless you're on 32-bit Windows.

 

image.png.9808eb72bc9d22413761615d5b8d56d8.png

Sounds confusing?  Here's an easy way to find out which system you have:  press WIN-BREAK.  This opens the System Control Panel (above photo) on ANY WINDOWS system.  You'll look for the "System type:" line, which will list what operating system and processor architecture is installed.  If you see 32-bit ANYWHERE in that line, you need to install the 32-bit runtimes. 

 

Once installed, reopen Tequila and select the appropriate client (32-bit if you installed Visual C++ Runtimes for x86, otherwise, 64-bit). 

 

This time the System Error box should not show and instead, you'll see this:

 

image.png.77fb23c13977eaa961822464ccf023c6.png

 

...and you'll be ready to go.

 

Install the Visual C++ Runtime here.

 

Frequently Asked Questions about Tequila

Tequila has a popup box telling me it can't save a file.  The green bar is stopped until I click OK.

This is a sign your anti-virus program is blocking the file from being saved.  This happens if your program uses a "Quarantine" location to stop files from running before you can review them, or for endpoint protection apps, it either deletes or sends a copy of the file to an administrator (or IT Dept.) before deletion.

 

While some files are not needed to run City of Heroes (like Icon.exe and ParagonChat.exe, both of which are projects from Titan Network), if this is happening you need to add Tequila.exe and the Tequila Install Path (see above in Settings) to your anti-virus app for exclusion. 

 

I know anti-virus is blocking my ability to play.  Can you help me find a workaround?

If you are using a school or work PC to play Homecoming, we cannot support you in what you need to do to play the game on a system that you do not legally own.  Please don't get into trouble over us, and wait until you come home to play games.

 

If you are at home, you'll need to find out how to make an exclusion for your game.  As there are numerous anti-virus apps out there, you'll need to look up the documentation for how to do this for your system.  Homecoming staff isn't able to assist you in operating your Anti-Virus application.  You can, however, ask in Help and Support in the forums, or in the Discord server under #client-issues, if other users have an antivirus app like yours, and they can point you in the right direction.

 

The green bar doesn't move (or it barely moves at all), and/or Tequila crashes out before it finishes.

Your network isn't allowing any of our patching servers through, but does allow Tequila to download and patch.savecoh.com to connect to get the manifest in the first place.  Two ideas come to mind:

  1. Try using the Beta Manifest, which has a different list of patching servers: https://manifest.cohhc.gg/testing.xml
  2. Put simply, you are being blocked from downloading the game.  Either a software filter, a network device or appliance, or your ISP isn't allowing connections to our patching servers.  Contact your ISP or Network Administrator to see if this is the case.  Again, if you're at work or school, please don't install the game on computers you don't own.

 

Isn't it unsafe to make exclusions?  Can't your team work on make Tequila and the game client safe?

Codewalker on Titan Network had a great writeup on why this isn't likely to happen with "homebrew devs" & community supported development groups. 

 

The Cliff Notes: Antivirus stopped being about stopping specific threats years ago.  There's 10s to 100s of new threats being written per day, so even if the news cycle only focuses on the latest Ransomware Threat and ignores all other news about it, viruses and other malware are still being made.   What modern computer safety looks like today: you can take two routes to be recognized as safe by an anti-virus company.

  • Assertion.  Corporations sign their software with certificates that are validated with identity providers.  If a corporation asserts to the anti-virus provider the code is safe, they agree and that's that.  (I'm grossly oversimplifying this process.  There's safety checks, internal audits and ISO compliance that a corporation needs to prove to the Anti-Virus agency that they follow that reinforces this assertion.)  This is the most assured solution to being recognized as safe, with a huge downside...
  • Heuristics.  It takes a lot of money to go the Assertion route.  Enough that most independent, non-profit and homebrew groups who dare try it would be out of business before they even reach Beta.  So most software developers try to write software that is as safe as possible without the blessing of Assertion.  Garbage collection, finding memory leaks, and testing for malicious use is at the forefront of this method.  The problem with the Heuristics route is that there is no playbook that works 100% of the time.  If there was one, virus authors would use it to find loopholes for detection faster than they already do.

 

In the Rogue Server era, City of Heroes (in it's current form) is impossible to offer on a plate to an anti-virus company to assert that it is safe.  And the stories of City of Heroes being a spaghetti knot of code are not exaggerations, so the heuristic route is the only path we have.  (No blessings, hope for most AV providers to not actively block us, which is currently the plan we're following.)  Put simply, you'll have to evaluate whether you trust Homecoming Servers, L.L.C. to tell you if the client is safe to run or not, against your Antivirus Solution.

 

If you want to play the game, you'll need to make the exclusions in your Anti-Virus application.  If you trust your anti-virus over all else, doubt our assertion telling you the game is safe and not a virus, or work in a place with "endpoint protection" that blocks Tequila from working in the first place, then the decision is already made.

 

Tequila says "Error reaching manifest" and doesn't even start checking files.  I can't launch any games.

Make sure your Internet connection is working.  As City of Heroes is an online title, Tequila cannot start without a manifest loaded.  No Internet, no manifest, no game.  They all go together.

 

I can't login once the login screen comes up.

This isn't related to Tequila, but check your account credentials, and change them here if you need to.  (Beta Server, check here instead.)

 

I can't reach any of the servers; they're all grayed out or there's red dots.

This isn't related to Tequila, but you can see the server status here.  Tequila and the client are working as intended and your computer is fine; there's other technical problems afoot away from your house and Internet Service Provider.

 

I heard there's a version of Island Rum for Windows, made by Manga.  Can I use that?  Is there a Tequila for Mac in the works?

Island Rum has a version for PC, but the purpose of Island Rum's existence is to support the Mac community first.  There are no plans to create Tequila for Mac users, as Island Rum also handles Wine and Mac-specific issues that Tequila isn't written for.

 

I heard there are other launchers out there, or I don't like Tequila.  Can I use another launcher?

Tequila and Island Rum are the only launchers supported by the Homecoming Servers team.  There are other launchers out there, but we cannot assist with technical issues or problems if they crop up.  Please stick to Tequila if you're on Windows.

 

I read somewhere that Tequila isn't safe, that it can delete files.  Is this true?

Tequila can overwrite and delete files according to the instructions given in the manifest, and nothing further.  Therefore it is IMPORTANT to only use the manifest files addresses provided by Homecoming in playing the game.  If someone tells you to use a different manifest to enter into Tequila to play Homecoming, check the Announcements in these forums to make sure it's official first (GM Jimmy, Cipher, and The Curator are authoritative members of the Homecoming Staff who will make such announcements.)

 

EXTRA CREDIT: All those folders inside your client...

So, you've been playing for awhile, and noticed there's a boatload of folders all over your Client.  Which ones are part of City of Heroes, which ones belong to Homecoming, and which ones are safe to delete?  Glad you asked!

 

Silver - Deleting this means the game (or Beta/Staging servers, if you use those parts of Homecoming) won't start until you patch up again.  Okay to save space in a pinch, but generally not advised.

Red - Deleting this means permanent data loss for your player info.  These folders are a great idea to back up somewhere else before messing with them.

Yellow - Safe to delete, but there are considerations to think about first.

Green - Delete without a twinge of guilt.


Current Client Folders

/hc-bin32 - Homecoming's Modern 32-bit client, with beta and pre-staging launchers if you're using the Beta Manifest.

/hc-bin64 - Homecoming's Modern 64-bit client, with beta and pre-staging launchers if you're using the Beta Manifest.

/homecoming - Contains resources specific to Homecoming Servers.  The .piggs in this folder are for the current production version of the game. (a.k.a.: Live.)

Please Note: trying to launch the game directly (using Explorer) will NOT work.  You need Tequila or a properly typed Command Line statement with the current revision info to start the game client.

 

Other Client Folders you May Have (Don't worry if they're not there)

/hc-beta - Piggs used in the Beta Client (Slower testing cycle, used for major releases.)

/hc-pre - Piggs used in the Staging Client (Faster testing cycle, used for minor releases and revision patching.)

/paragon - Client for another COH game server, may have other names.  If you play on other servers apart from Homecoming, it's probably for that server.  Or, if you use a Server at home this could exist if you stick with the provided settings that come with the installation procedure (the default shard is named Paragon, and so is the client).  There may be other client folders for other manifests out there with different names, so keep that in mind if this describes your playing habits.

 

Game Client Use Only - Regardless of Server/Manifest:

/piggs - Resources for in-game clients.  Leave it be.

/qt_plugins - Client resources.  Leave it be.

 

User Data Folders:

The following folders are Client-Side User Data and should not be deleted without reviewing the contents first.  If these folders are deleted, you cannot get the information back:

/costumes - .costume files you've saved.  Used both in Character Creator and AE.

/powercust - PowerCustomization files from character creator.  Used both in Character Creator and AE.

/screenshots - Pics saved while in game.  For most players, this will be the 2nd largest waste of hard drive space behind .pigg files that the client needs to work.  Don't be afraid of visiting this folder and deleting any 'misfires' or bad shots you don't need.

/"YourUsernameHere" - Your user folder.  Useful for personal info, character launch order, etc.

 

Mission Architect data: All three folders are part of AE.  Deleting impacts unpublished AE missions.

/custom_critter

/customvillaingroup

/missions

 

Semi-Safe to delete:

/Crash - Crash logs.  These are very helpful to Homecoming Servers developers if you're having problems.

/data - Custom Client Modifications - Allows you to add local client modifications without impacting the patched game in full.  Examples include font/texture/sound replacements, as well as Vidiot Maps.  If the folder is renamed or removed, the client goes back to normal.

/logs - Chat logs from the game.  If you have turned chat logging on, they land in here.

 

Safe to Purge

/score - Initial build from April 2019. 

 

Any other folder in your client not listed above is unneeded by City of Heroes to run.

 

APPENDIX: Uninstalling or Reinstalling Tequila

Tequila does not have an Uninstall Utility.  To remove Tequila from your system, after backing up any data from the above folders (listed in EXTRA CREDIT) that you want to keep, you can simply delete the Tequila folder as a whole.  Reinstallation is one step: rerun the program.  This has the effect of erasing and redownloading everything from the manifest again.

 

If you're a completionist and unafraid of RegEdit, there's one last place to look:  the registry.  Navigate to Computer\HKEY_CURRENT_USER\Software\Tequila.  Delete the entire Key and Tequila won't know where the Install Folder or manifests are.  (This is unnecessary for the most part.)  Then you can delete the Tequila folder and run 100% from scratch.

Edited by GM Tahquitz
Linked to HC Launcher.

Homecoming: City of Heroes -- Want to play now? Get started here. - Got an issue?  File a Support ticket. - Enjoy helping others? Consider joining us as a GM.

Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
×
×
  • Create New...