Provides automatic installation scripts for OpenRA with Tiberian Sun & Red Alert 2 + Dune 2 (Windows, Linux)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

262 lines
11 KiB

8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
  1. Welcoming you to Texas...
  2. Receiving thoughts...
  3. [![OpenRA/RA2](https://img.youtube.com/vi/QrL8m48TePY/mqdefault.jpg)](http://www.youtube.com/watch?v=QrL8m48TePY) [![OpenRA/RA2](https://img.youtube.com/vi/RgJyFMpCA7M/mqdefault.jpg)](http://www.youtube.com/watch?v=RgJyFMpCA7M)
  4. Introduction
  5. ==============
  6. **What is this all about?**
  7. This Github repository provides a bunch of scripts for installing Tiberian Sun & RA2 on [OpenRA](http://www.openra.net/ "OpenRA homepage"), an open source implementation of classic Westwood RTS games.
  8. Tiberian Sun & Red Alert 2 are still officially "unfinished titles" in OpenRA, and thus not yet provided by official OpenRA sites as an easy download option. Their current gameplay status is considered as "pre-alpha", "not ready" or "only accessible to OpenRA developers".
  9. Still, a lot of people want to play or try Tiberian Sun & Red Alert 2 mods in OpenRA. It is possible. As automatic steps to achieve this goal are not yet officially provided by OpenRA development team, this Github repository was created.
  10. Manual installation from source code suggested by the official OpenRA wiki is a major roadblock for many players. This repository is here to help on the installation process as much as possible by automating the process. No step-by-step wiki instructions or any understanding about compilation processes needed at all.
  11. **Sounds cool! How to use it?**
  12. 1. Click green "Clone or download" button (top-right on this page) -> Download ZIP
  13. 2. Unzip the contents on your computer
  14. 3. Check [Installation instructions](https://github.com/Fincer/openra-tibsunra2#installation-instructions)
  15. 4. Then...
  16. ..* Just launch the script, follow instructions, take a cup of coffee or whatever and wait for compiled game.
  17. 5. Click and play
  18. Sounds good? Yes. Works? Likely.
  19. P.S. FAQ about the script at the bottom of this page.
  20. **NOTE:** As the development of OpenRA & Red Alert 2 continues, this script will likely become unusable or needless some day. For example, if RA2 gets merged into official OpenRA Github repository OR/AND disabling RA2/TS gameplay will be removed from OpenRA.
  21. **Operating Systems**
  22. --------------
  23. ![alt text](https://i.ytimg.com/vi/5AjReRMoG3Y/default.jpg "Operating Systems")
  24. OS specific script working status listed below.
  25. **Last update:** 15th November 2016
  26. **Works.** The following operating systems are currently supported:
  27. - Windows 10
  28. - Windows 7
  29. - Ubuntu (16.10, 16.04 LTS, 15.04 LTS)
  30. - Linux Mint (18, 17.3, 17.2 & 17.1)
  31. - Debian (8.3.0)
  32. - OpenSUSE (Tumbleweed, 42.1, 13.2)
  33. - Fedora (24, 23, 22)
  34. - Arch Linux
  35. **May work.** Expect missing dependencies (see NOTE 2 below):
  36. - Ubuntu (15.10, 14.10, 14.04 LTS)
  37. **Doesn't work.** Missing dependencies (see NOTE 2 below):
  38. - Linux Mint (16)
  39. - OpenSUSE (13.1)
  40. **NOTE 2:** As package manager updates have been dropped from some old Linux operating systems, not all required packages to compile OpenRA may be available via internet anymore. However, if you have dependencies already installed on your system, the game may compile as expected (unless these packages are too old?). Optionally, you may be able to get missing dependencies from internet sources but get ready to spend hours for solving dependency hell issues & possible corrupted database headache.
  41. **Installation instructions**
  42. --------------
  43. **Windows**
  44. 1) Make sure you have .NET Framework 4.5 installed on your computer
  45. (Read *WINDOWS-BEFORE-INSTALLATION.txt* if needed)
  46. 2) Double click *windows-install.bat*
  47. 3) Follow the instructions
  48. **Linux (All distributions)**
  49. 1) Open terminal window. In terminal, run:
  50. ```
  51. bash linux-install.sh
  52. ```
  53. 2) Follow the instructions
  54. **Tiberian Sun & Red Alert 2 - Post-installation instructions**
  55. --------------
  56. **Tiberian Sun**
  57. ![alt text](https://i.ytimg.com/vi/R8U0kPfAWp8/default.jpg "Tiberian Sun")
  58. Launch the game and download the required asset files from the web when the game asks you to do so.
  59. **Red Alert 2**
  60. ![alt text](https://i.ytimg.com/vi/ENyxseq59YQ/default.jpg "Red Alert 2")
  61. You must install language.mix, multi.mix, ra2.mix and theme.mix into
  62. ```
  63. \My Documents\OpenRA\Content\ra2\ (Windows)
  64. ```
  65. ```
  66. .openra/Content/ra2/ (linux)
  67. ```
  68. You find these files from original RA2 installation media (CD's):
  69. - theme.mix, multi.mix = RA2 CD Root folder
  70. - ra2.mix, language.mix = RA2 CD Root/INSTALL/Game1.CAB (inside that archive file)
  71. **Multiplayer**
  72. It's recommended to build OpenRA using exactly same GIT source files for multiplayer usage to minimize possible version differences/conflicts between players. Please make sure all players have exactly same git versions of their in-game mods (RA, CNC, D2K, TS, RA2). Version numbers are formatted like 'git-e0d7445' etc. and can be found in each mod description in the mod selection menu.
  73. **Uninstallation**
  74. --------------
  75. For uninstallation, please see specific instructions for your Operating System below.
  76. **Windows**
  77. Since the game has been compiled from source and no additional setup programs are provided, all you need to do is to delete the contents of 'OpenRA-tibsunra2-Windows' folder and \My Documents\OpenRA\.
  78. **Ubuntu/Linux Mint/Debian**
  79. If you want to remove OpenRA, just run
  80. ```
  81. sudo apt-get purge --remove openra-bleed-tibsunra2
  82. ```
  83. in your terminal window.
  84. **OpenSUSE**
  85. Run
  86. ```
  87. sudo zypper remove openra-bleed-tibsunra2
  88. ```
  89. in your terminal window.
  90. **Fedora**
  91. Run
  92. ```
  93. sudo dnf remove openra-bleed-tibsunra2
  94. ```
  95. in your terminal window.
  96. **Arch Linux**
  97. Run
  98. ```
  99. sudo pacman -Rs openra-bleed-tibsunra2
  100. ```
  101. in your terminal window.
  102. **About patches & hotfixes**
  103. --------------
  104. **Patches**
  105. Patches are files that are being used for patching the main game (OpenRA) so that it compiles successfully with Tiberian Sun & Red Alert 2 added.
  106. Basically, Red Alert 2 locates in a different Github repository so patches are needed in order to merge it successfully with the OpenRA codebase. Additionally, some minor patch codes have been added for compilation of Tiberian Sun.
  107. Patches do not affect any bugs or features existing in the game.
  108. ```
  109. Location: /data/patches/
  110. ```
  111. Usage: add new patch file into the /data/patches/linux/ directory (Linux) or \data\patches\windows\ (Windows)
  112. **Hotfixes**
  113. Hotfixes are considered as patches as well (yes, they are patch files, too). The main difference between patches and hotfixes is that hotfixes are meant to be used to fix bugs or add features in the game codebase whereas patches just make OpenRA compilation process with Tiberian Sun & Red Alert 2 possible.
  114. Hotfixes are unofficial in nature. They've not officially been applied by OpenRA developers or any other party and thus playing the game with them may make your version of openra-tibsunra2 incompatible with the official 'openra-bleed' and RA2 mod, even if git version numbers match with other players you see in the lobby.
  115. Hotfixes can be used with other players. However, the hotfixes must have been applied into openra-tibsunra2 versions of any players you want to play with (not forgetting compatibility of git version numbers).
  116. Hotfixes are optional and they've been disabled by default.
  117. ```
  118. Location: /data/hotfixes/
  119. ```
  120. Usage: add new hotfix patch file into the /data/hotfixes/linux/ directory (Linux) or \data\hotfixes\windows\ (Windows)
  121. **Why are Windows & Linux separated (patches/hotfixes)?**
  122. The main reason for this is because Windows & Linux use different line endings in patch files. Different end of lines may make patch files incompatible in various OSes so consider this more or less as a precaution.
  123. **How do I create new hotfixes?**
  124. You need a Unix tool 'diff' to create new hotfixes (patch files). For additional information, please see, for example,
  125. [Apply patch file using patch command - Cyberciti.biz](http://www.cyberciti.biz/faq/appy-patch-file-using-patch-command/)
  126. Remember to check "end of line" (Windows or Unix) for every hotfix patch file you create.
  127. **FAQ**
  128. --------------
  129. ![alt text](https://i.ytimg.com/vi/fnd0qg4I_MM/mqdefault.jpg "Mr. President, I'm afraid we have a heck of a situation down here...")
  130. Mr. President, I'm afraid we have a heck of a situation down here...
  131. *-General Ben Carville*
  132. **Missing support for my OS, please help!**
  133. Consider contributing the script development. It's not too hard if you have enough motivation and spare time. The question is, have you?
  134. - The most requested OS support: Mac OS X (yes, yes and yes. I know it)
  135. Nice to know when considering to add support for various Linux distributions:
  136. Main differences between various linux distributions are
  137. - variety of dependency package names in OS repositories
  138. - specific package manager commands
  139. **You provide outdated/wrong information here!**
  140. Please open a new issue on Github repository page:
  141. [Issues - Fincer/openra-tibsunra2 script](https://github.com/Fincer/openra-tibsunra2/issues "Script issues")
  142. **The script doesn't work! This sucks, you suck!**
  143. On script related errors, please open a new issue on Github repository page:
  144. [Issues - Fincer/openra-tibsunra2 script](https://github.com/Fincer/openra-tibsunra2/issues "Script issues")
  145. If you are 100% sure the failure you've encountered is not caused by the script but happens even if OpenRA is manually compiled, please open a new issue or look for an existing issue here:
  146. [Issues - OpenRA: main game](https://github.com/OpenRA/OpenRA/issues "OpenRA main game issues")
  147. or
  148. [Issues - Red Alert 2: OpenRA mod](https://github.com/OpenRA/ra2/issues "OpenRA RA2 mod issues")
  149. **NOTE 3:** If you don't open a new issue or decide to be silent, the error may never be fixed. Errors rarely get fixed by being passive or just hoping them to be suddenly fixed by a miracle. I may not even know the issue you have. You've been informed and warned.
  150. **I demand you to add or fix feature X! I surely won't do it but you will because I say so!**
  151. First at all, as this repository is open source in nature, no one gets paid $$$ by making a new script or improving the existing one. Thus you can hardly demand contributors to do something about any issues unless they have will to fix or create things for you. You can't force people to spend their spare time for your requests unless they themselves decide to do so. Money is a good motivator for people, but the concept of money doesn't exist here.
  152. Welcome to the world of open source software where things move forward slowly if at all. Sometimes the development stops even completely and codes get abandoned for eternity. The question is, do you have time or patience for this all?
  153. If you lose your patience and if you have motivation to improve things here, please consider contributing the script development. That's the most certain way you get the things done as you want, though you may need to learn a lot of new stuff yourself and get some headache as well.