City of Heroes on Linux: Difference between revisions

From Homecoming Wiki
Jump to navigation Jump to search
m (→‎System Requirements: Breaking out unsupported options lower in the page.)
Line 116: Line 116:
:A kernel module is a compiled piece of software that "hooks" between the Linux kernel itself and the hardware system calls. Kernel Modules can be compiled when a system updates a hardware driver OR Linux Kernel.  This causes the Kernel Module to recompile to handle the new instructions on either side.  The focus on Free Software and Open Source code means that when a problem is found with hardware the community has the ability to handle it on their own; when proprietary drivers are used issues with Linux are 100% up to the hardware manufacturer to solve. Proprietary driver improvements have had middling to low results for Linux users historically. (Intel and AMD have had a far better track record of open sourcing their firmware code; NVidia since 2012 is improving gradually.)
:A kernel module is a compiled piece of software that "hooks" between the Linux kernel itself and the hardware system calls. Kernel Modules can be compiled when a system updates a hardware driver OR Linux Kernel.  This causes the Kernel Module to recompile to handle the new instructions on either side.  The focus on Free Software and Open Source code means that when a problem is found with hardware the community has the ability to handle it on their own; when proprietary drivers are used issues with Linux are 100% up to the hardware manufacturer to solve. Proprietary driver improvements have had middling to low results for Linux users historically. (Intel and AMD have had a far better track record of open sourcing their firmware code; NVidia since 2012 is improving gradually.)
}}
}}
== Unsupported Linux Hardware ==
The following Linux systems will not have the resources to play City of Heroes.
=== ARM Linux ===
Homecoming Launcher (and more importantly the City of Heroes client) is not compiled for ARM.  Wine will not run HCLauncher on an ARM system without a Software Emulator for X86 apps.  Single-Board Computers (Raspberry Pi and variants) will not run City of Heroes with Wine alone.
This also applies to Chromebooks with ARM chips (Rockchip, Qualcomm, Exynos, Tegra, etc.)  A possible basis to start with would be QEMU, Box64, or a premade setup such as TwisterOS, but the broad swath of ARM systems available will not have sufficient hardware capability to expect useable performance to begin with.
=== Chromebooks ===
As any Chromebook with an ARM chip is a non starter (see "ARM Linux" above this section), Chromebooks generally cannor run City of Heroes for the following reasons.
*Chromebooks under $500 typically come with minimal storage (16-32GB) which makes it difficult to maintain sufficient free space even under Linux or Dual-Boot.
*Linux support is only present on newer devices: used Chromebooks without Crostini support cannot install any Linux apps, including Wine.  (Android App support is irrelevant.)
**This will add considerable weight to the Linux partition, which is a minimal Debian/Gnome installation.  You will need at least an additional 6GB free for libraries to support Wine such as missing X11 and Gnome components, as well as the game client, totalling 12GB minimum.
**The Linux partition (Crostini) is still using emulation to run under ChromeOS which is a Virtual Machine.  This will mean a considerable performance hit in game play.
*Chromebooks released after 2018 no longer permit a dual-boot or ChromeOS replacement scenario with Intel/AMD processor support to avoid virtualization.<ref>[https://mrchromebox.tech/#faq The MrChromebox website] advises not to use Chromebooks as a low-cost Linux device.  Starting with Intel Apollo Lake models (from 2016) and AMD Zen Chromebooks, firmware support is minimal and quirks vary by model.</ref>  Users seeking hardware to play Homecoming: City of Heroes for under $400 are better served with Windows laptops at that price range.


== Paid Support ==
== Paid Support ==

Revision as of 21:52, 25 July 2023

See also City of Heroes on Mac

Editor's Note:

Homecoming Developers do not support any client bugs on Linux. If an issue cannot be reproduced in a Windows client, Linux specific bugs will be given a form response and closed without resolution. Please use the Homecoming Forums for Linux client support from other users.

Overview

It is possible to run City of Heroes on Linux through a technology called WINE (WINE Is Not an Emulator). By porting the Windows API libraries that City of Heroes uses to Linux, WINE effectively "fools" City of Heroes into thinking that it is actually running on Windows.

Instructions (Homecoming Launcher)

If you can only see Desktop, Images, Documents and similar folders in your home folder, make sure "Show hidden files" is checked in your File Manager first. ".wine" should appear normally.
NVidia users: higher numbers will support newer features, lower and older numbers are more stable if the higher numbered ones have problems. Don't use server drivers or "Nouveau", they won't allow City of Heroes to launch.

For sake of brevity, we'll assume you have a working Linux installation that is fully patched. The distro does not matter. Also assuming a 64-bit system and you can replace "usernameGoesHere" below with your Linux username where needed.

  • Install Wine Stable using this download page -- https://wiki.winehq.org/Download -- Once there, pick Binaries, and your distribution. Follow the instructions for the Stable branch.
  • Once installed the default Wine Prefix (/home/usernameGoesHere/.wine) will be made. It will prompt to install Gecko and Mono. Note that NEITHER library is necessary to run Homecoming: City of Heroes (although Mono will be useful if you wish to use Mids Reborn or other .NET apps later.) Another note worthy of mention -- it is not prompted during setup but you do NOT need to install Visual C++ Runtime at all. Wine handles this requirement automatically.
  • Do one of the following (optional):
  • Any Graphic Cards new from 2016 onward: Install either Lutris (GUI Launcher, check your package manager) or DXVK (Vulkan Library - https://github.com/doitsujin/dxvk - follow the instructions in the GitHub page using a terminal.) Lutris prepacks the DXVK library and is easier for new users if you don't want to touch terminal too much. Installing DXVK yourself takes up less overhead.
  • Ubuntu and NVidia: Open "Additional Drivers" and make sure "Nouveau" is NOT selected. The NVIDIA 440 driver and newer will run City of Heroes (The NVIDIA 340 driver will work if you're on an older card.) For most users this is automatically handled (Pop_OS, etc.) but if the game performs terribly, please check this area before you give up.
  • Run the Homecoming Installer. Choose your location on Drive C same as you would in Windows (C:\Games\Homecoming).

As with any file or folder starting with a period, ".wine" is hidden from directory results. (See upper right photo and caption.) Once installation finishes you can run the game from /home/usernameGoesHere/.wine/drive_C/Games/Homecoming/bin/win64/launcher.exe using either Lutris or making a shortcut to the location. (For a Gnome-based distro, for example, it could be as easy as visiting ~/.local/share/applications, then copying an existing shortcut and naming it Homecoming.desktop, and finally edit the new shortcut in a text editor with correct values.)

It is also important to note this procedure is sufficient for a single-user Linux system alone. For a multiuser system, either you need to repeat the procedure for each user (and sufficient disk space is required: 6-12GB per user), or configure permissions to allow multiple users access to the same WinePrefix.

System Requirements

Linux has different system requirements than Windows. For binary video card driver releases City of Heroes will only run on a current video driver that compiles with a Linux Kernel. When NVidia, AMD, or Intel drop driver support for a video card and the kernel fails to compile with the legacy driver in-place, you can no longer play City of Heroes on that system.

There is no specific date when this support ends; it will not be announced publicly when a software upgrade fails. The day that the video driver fails to recompile kernel modules for your current OS is when you need to decide. Possible fixes include:

  • Run COH on an older OS instead of on the bleeding edge (ex. choosing Ubuntu LTS over the twice-a-year update distro) so older drivers continue to compile normally,
  • Upgrade your hardware (baselines provided below to help in replacement), or
  • set up your system to dual-boot to Windows and move your game files to Windows to continue play.

Linux Driver Support

  • AMD: Cards older than RX 300 no longer have active driver development. (Current baseline: AMD RX 400/500 and newer.)
  • NVidia: Cards older than GTX 500 no longer have active driver development. (Current baseline: NVidia GTX 600/700 and newer.)
  • Intel: IGPs with GMA3000 or older are no longer patched. (Current baseline: Intel HD Graphics and newer.)

The above does not mean your older card will not work today. It means if it stops working in the distant future, this may be why.

Must Meet Game System Requirements

System Requirements are the same for a Linux system as they would be for a Windows system: 1 GHz Dual Core processor, 2GB of RAM, a video card capable of OpenGL 2.0/3.0, and 6-12GB free hard drive space. As a generality, if a system would not be able to play City of Heroes using Windows because of the hardware in use there's a good chance Linux won't work either.

Steam Deck (GUI-Only Install)

To play Homecoming: City of Heroes on a Steam Deck, you can take the following steps instead. Use of Flatpak is recommended to ensure that your Homecoming installation survives updates from SteamOS Holo, which overwrites any packages installed by Pacman such as Wine. This list is assuming a user does not want to use a Terminal to enter commands in BASH, nor edit configuration files for the setup.

  1. On the Steam Deck, press the STEAM button, Power, then "Exit to Desktop." You may need to enter your PIN.
  2. At the Desktop, click on Discover app. Use the search box to find Lutris. Install it.
  3. In Lutris, press + in the top left to add a Game. Choose "Search the Lutris website for installers".
  4. Type in the Search Box "City of Heroes". Choose the entry dated 2004.
  5. You'll see four results: Homecoming 32-Bit, Homecoming 64-bit (both use Tequila), Homecoming Launcher, and another launcher not supported by Homecoming (Sweet Tea). Use of the Homecoming Launcher is advised. Click Install next to it.
  6. Wait until the Homecoming Launcher reaches the install wizard after Wine is set up. When asked for an Install directory, click OK to accept the default. ("Z:\Games\Homecoming")
  7. When completed, City of Heroes will appear in your Lutris launcher screen. To add it to the Steam Deck Gaming Mode App Menu, right click and choose "Create Steam Shortcut".
  8. You can close Lutris and head back to the Gaming Mode launcher. Enter your PIN to return to the Home Screen if it is set.
  9. OPTIONAL: At this time, picking the Bluetooth peripherals you wish to use is a good idea. (While technically you can use the On-Screen Keyboard and Controller Configuration to play, it is far easier to use a separate Bluetooth Keyboard and Mouse instead.) To add Bluetooth accessories, press STEAM and select Bluetooth. Make sure Bluetooth is turned on. (Steam Decks in Gaming Mode have it off by default to conserve battery.)
  10. Press the STEAM button, choose Library. Navigate to "Non-Steam" in the top row, find City of Heroes and press the Options button (next to Y, looks like a Hamburger Menu icon). Select "Add to Favorites" to list the game in the Home Screen along other titles.

You should now see City of Heroes on the home screen launcher when ready to play. The Start button loads the Homecoming Launcher, which now resembles the Windows Install instructions. Closing HC Launcher returns to the Home Screen.

Changes to the HC Launcher startup should be done on Desktop Mode by the Lutris Launcher. (Right click "City of Heroes", choose "Configure...") Changing Properties for City of Heroes in the Gaming Mode launcher may prevent your game from starting, although you can rename the title here if you wish ("Homecoming" works if you use other servers and want to keep launcher shortcuts separate.) This does not write-back to Lutris, it'll still remain "City of Heroes" there.

Using a Custom Wine library

You may wish to use GE-Proton (GloriousEggroll Proton) with your installation, which can be done by installing "ProtonUp-Qt" in the Discover app. Install it then follow these instructions:

  1. Run ProtonUp-Qt in the Gaming menu, then click "Add Version" to find a GE-Proton release. (The numbering matches the major releases of Wine: GE-Proton 8.12 is Wine 8 equivalent, for example.) Click OK and let the app download the library.
  2. Once installed, return to Lutris, right click "City of Heroes", choose "Configure" then click "Runner Options". Change the Wine Version to use GE-Proton instead and Save.
  3. Restart the Steam Deck.

Troubleshooting

Game doesn't launch. I press Start in Gaming Mode, the Steam logo appears then returns to the launcher.
Head to Desktop Mode, open Lutris and wait for any updates to finish. Also, if you use a custom Wine Library, launch ProtonUp-Qt and check for new versions of Proton/GEProton to switch to. Update the Lutris launcher configuration as well to point to the new library and restart the Steam Deck.
I can't find City of Heroes in Gaming Mode.
Be sure in Lutris you right clicked "City of Heroes" and chose "Create Steam Shortcut" instead of "Create App Menu Shortcut" (which only affects Desktop Mode.)
HC Launcher doesn't fill the screen, then when launching the game, I see "LOADING" in a tiny rectangle.
This is normal behavior in Gaming Mode. HC Launcher at 100% scaling doesn't fill the 1280x800 display. It is not advised to increase the launcher size as it'll hide UI choices if it runs off the edge of the display. (Mouse dragging does not move the window in Gaming Mode.)

How It Works

Programs that run on Windows do not directly access the hardware in the machine. For example, if a program needs a file from the hard drive, it does not talk directly to the hard drive, but it calls a function in the kernel, which in turn talks directly to the hard drive.

The primary advantage of this type of abstraction is that programs do not have to worry about the hardware-specific details of every device that is installed. Before this level of abstraction was achieved, every program had to have special drivers for every device that might be used. Now, only one set of drivers must be installed on Windows, which can be shared through a common set of functions that Windows provides (called the Application Programming Interface, or API).

A special set of functions may be grouped into a programming library. Such libraries typically handle some specific functionality. For example, there are two primary graphics libraries in use today to program games: Microsoft's DirectX, and OpenGL, an industry-standard graphics library. Since DirectX is a proprietary software library, programs that use it will typically only run on Windows. Since OpenGL has Windows and Linux versions, however, programs that run using this library are much more easily converted between Windows and Linux.

The open source community developed an application called WINE that provides a layer of abstraction between Windows programs and the system they're running on by taking the place of the Windows kernel and API. Among other things, it implements much of the DirectX library (converting the 3D parts to OpenGL). When WINE is installed on Linux, programs that use DirectX may be able to run, because they believe they are calling DirectX functions, and those functions work similarly under Linux and Windows.

City of Heroes in particular already uses OpenGL for its 3D graphics (while using DirectX primarily for input), which gives it a performance advantage when running through WINE.

Unsupported Linux Hardware

The following Linux systems will not have the resources to play City of Heroes.

ARM Linux

Homecoming Launcher (and more importantly the City of Heroes client) is not compiled for ARM. Wine will not run HCLauncher on an ARM system without a Software Emulator for X86 apps. Single-Board Computers (Raspberry Pi and variants) will not run City of Heroes with Wine alone.

This also applies to Chromebooks with ARM chips (Rockchip, Qualcomm, Exynos, Tegra, etc.) A possible basis to start with would be QEMU, Box64, or a premade setup such as TwisterOS, but the broad swath of ARM systems available will not have sufficient hardware capability to expect useable performance to begin with.

Chromebooks

As any Chromebook with an ARM chip is a non starter (see "ARM Linux" above this section), Chromebooks generally cannor run City of Heroes for the following reasons.

  • Chromebooks under $500 typically come with minimal storage (16-32GB) which makes it difficult to maintain sufficient free space even under Linux or Dual-Boot.
  • Linux support is only present on newer devices: used Chromebooks without Crostini support cannot install any Linux apps, including Wine. (Android App support is irrelevant.)
    • This will add considerable weight to the Linux partition, which is a minimal Debian/Gnome installation. You will need at least an additional 6GB free for libraries to support Wine such as missing X11 and Gnome components, as well as the game client, totalling 12GB minimum.
    • The Linux partition (Crostini) is still using emulation to run under ChromeOS which is a Virtual Machine. This will mean a considerable performance hit in game play.
  • Chromebooks released after 2018 no longer permit a dual-boot or ChromeOS replacement scenario with Intel/AMD processor support to avoid virtualization.[1] Users seeking hardware to play Homecoming: City of Heroes for under $400 are better served with Windows laptops at that price range.

Codeweavers

The main sponsor of the Wine Project, Codeweavers, maintains a paid license of Crossover as a Prosumer Wine distribution offering tech support for use. It is important to note two things:

  1. Paying for Crossover is not required to play Homecoming if you can install Wine on your own, however, it will work if you require paid Tech Support assistance instead of a Community-led forum.
  2. Crossover's main customer base is business-class users. (They will support gaming, but a lot of what Cedega did in the past to simplify gaming use is not built into the application.)

External Links

  1. The MrChromebox website advises not to use Chromebooks as a low-cost Linux device. Starting with Intel Apollo Lake models (from 2016) and AMD Zen Chromebooks, firmware support is minimal and quirks vary by model.