Confirmedusers, editor
348
edits
Installing the game on MacOS: Difference between revisions
From Vintage Story Wiki
→Issues in older game versions
| (17 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
== Introduction == | == Introduction == | ||
From game version 1.19.2 the remaining known macOS issues are fixed, so the time | From game version 1.19.2 the remaining known macOS issues are fixed, so the time has come to be able to say that Vintage Story officially supports macOS once again. \o/ | ||
=== Earlier history === | ==== Earlier history ==== | ||
Back before 2021, Vintage Story worked on Macs, but successive changes in access to mouse and other hardware features in macOS updates then broke it for a while... until from game version 1.18.8, Vintage Story became again generally compatible with most types of hardware running macOS. macOS was not "officially supported" prior to game version 1.19 but it was unofficially supported: the (official!) downloads page offered a macOS build and the game worked reasonably well on a Mac if some additional steps were taken as detailed in the [[#Versions_prior_to_1.19.0:_set_up_using_Homebrew|final section below]]. Since game version 1.19.0, installation on macOS was simplified and those additional steps became no longer necessary, and Vintage Story now works well on a Mac - at least, equally well as the Windows and Linux versions! | |||
Since game version 1.19.0, installation on macOS | |||
== Game data folder == | == Game data folder == | ||
| Line 19: | Line 16: | ||
== Retina displays == | == Retina displays == | ||
Most modern Macs have very high resolution Retina displays, and the desktop resolution is downscaled so that text and graphics do not look too tiny. For example, a Macbook Air can have an actual hardware display resolution of 2560 x 1600, but the desktop resolution by default will be 1680 x 1050. | |||
On a fresh installation of the game on macOS, Vintage Story will make an initial guess at a reasonable scaling factor for the in-game GUI, including the main menu and the Settings menu. From game version 1.19.2 and later, this guess is reasonably good, but if it seems wrong the normal solution is to go to the in-game Settings / Interface menu and change it; the Settings menu can be accessed either from the Main Menu or in-game from the Pause menu. | |||
Occasionally the GUI scaling might initially be so large on some Retina displays that it causes the Settings menu Interface tab to be off-screen, making it impossible to adjust the GUI scaling in-game. To fix this problem, exit the game, find the [[Installing_the_game_on_MacOS#Game_data_folder|data folder]], and edit the <code>clientsettings.json</code> file in a decent text editor. Search for the <code>"guiScale": </code> setting and set it to a lower value, like 1.0 or 0.75. (You need a text editor which can edit a plain text file, such as ''Notepad++'', ''Brackets'', or ''Sublime Text''. Do not use the macOS in-built TextEdit, that one writes in rtf format which can really mess things up!) | |||
== Asian fonts == | |||
If you want to play the game on a Mac with your in-game language set to Chinese (Simplified), Chinese (Traditional), Japanese, Korean or Thai ... or possibly other future languages still to come ... then you may experience invisible text (empty boxes instead of language characters) on first starting the game in those languages. | |||
The solution is to edit the <code>clientsettings.json</code> file (see tips above) to include appropriate font choices for your preferred language. Look for two lines similar to this in the clientsettings file, and edit them to use appropriate font names - choose the names of fonts available on your Mac for your preferred language. (Note, the game may have already set these to different font names, it is attempting to choose fonts which are good for these languages but you may not have these fonts installed on a Mac.) | |||
:::<code>"defaultFontName": "sans-serif",</code> | |||
:::<code>"decorativeFontName": "Lora",</code> | |||
==Known issues generally on macOS:== | |||
===Known current issues=== | |||
* Asian language fonts may require manual configuration, see above | |||
* 1-click mod install from websites does not currently work on macOS, but mods can be installed in the normal way by downloading them and drag and drop to the <code>VintagestoryData/Mods</code> folder | |||
===Issues in older game versions=== | |||
* prior to game version 1.19.2, on Apple silicon (M1/M2/M3) only, the hotbar and other HUD elements became (temporarily) invisible while knapping stone, clayforming clay, or smithing on the anvil | |||
* prior to game version 1.19.2, for some Retina displays, the GUI scaling originally chosen by the game on a clean installation was too large, potentially needing a manual edit to clientsettings.json to fix it | |||
* (minor!) in game version 1.19.1, in the Settings / Graphics menu, for some players the brown menu background was too small in size so that some settings extended slightly beyond it | |||
* prior to game version 1.19.0 (actually technically the immediately prior release candidate 1.19.0-rc.8), all macOS versions required additional manual installation steps, see details in separate section below | |||
* prior to game version 1.19.0-rc.7, if an external monitor with high resolution was used with a MacBook, the game window resolution did not fill the full screen on the monitor; a solution was to manually edit both ''info.plist'' files found in the vintagestory.app folder, to add the following text: <code><key>NSHighResolutionCapable</key><false/></code>; this fix is included in all stable 1.19 releases | |||
* in 1.18 game versions, on certain Mac hardware, the sky was colored red not its correct blue color. This has been fixed in all 1.19 releases \o/ | |||
* prior to game version 1.18.8, if an external trackpad or external mouse was used alongside the primary system mouse, there were past reports that the external controller was not effective; there have been no recent reports and it is possible this has been resolved from game version 1.18.8 | |||
* in older game versions prior to 1.17 and older macOS, crash on startup (NSInvalidArgumentException) could be fixed by disabling AutoHide on your menu bar | |||
* in older game versions (1.15-1.17) and older macOS, it was usually necessary to add <code>sh</code> to Input monitoring setting, in order to fix mouse issues. | |||
== Installation on macOS with Intel silicon == | == Installation on macOS with Intel silicon == | ||
| Line 33: | Line 54: | ||
Then to install Vintage Story, in the [https://account.vintagestory.at/ Client Area] select the '''Mac OS App'''. Download that, then when it has finished, in your Downloads folder, double-click the file you downloaded (normally ending with .tar) to Unarchive it. This creates <code>vintagestory.app</code> in your Downloads folder. If you want, you can drag <code>vintagestory.app</code> to your Applications folder or anywhere else on your Mac, and you can now delete the .tar download file. | Then to install Vintage Story, in the [https://account.vintagestory.at/ Client Area] select the '''Mac OS App'''. Download that, then when it has finished, in your Downloads folder, double-click the file you downloaded (normally ending with .tar) to Unarchive it. This creates <code>vintagestory.app</code> in your Downloads folder. If you want, you can drag <code>vintagestory.app</code> to your Applications folder or anywhere else on your Mac, and you can now delete the .tar download file. | ||
Which game version to download? | Which game version to download? For Macs, we recommend 1.19.2-stable or later, which has been specifically made for easier installation on macOS: the latest (1.19.4-stable as of February 2024) is better still. To see other versions click on [https://account.vintagestory.at/#otherversions (Show all available downloads and mirrors of Vintage Story)] and you can choose between Stable and Unstable tabs. If you want to play multiplayer on a server which is still running game version 1.18.15 (for example) then you would need to install Vintage Story version 1.18.15 of course and follow the additional installation steps described [[Installing_the_game_on_MacOS#Versions_prior_to_1.19.0:_set_up_using_Homebrew|below]] if required. Bear in mind that game versions prior to 1.19.0 may have other issues on some Macs for example the red sky issue. | ||
If you run into any difficulty, do ask for help on Discord (search for macOS to find existing Mac discussions) or on a [https://www.vintagestory.at/forums/topic/11017-mac-users-does-the-net7-build-work-for-you/ suitable Forum thread]. | If you run into any difficulty, do ask for help on Discord (search for macOS to find existing Mac discussions) or on a [https://www.vintagestory.at/forums/topic/11017-mac-users-does-the-net7-build-work-for-you/ suitable Forum thread]. | ||
| Line 39: | Line 60: | ||
To run the game the first time after downloading it, you'll need to [https://www.howtogeek.com/205393/gatekeeper-101-why-your-mac-only-allows-apple-approved-software-by-default/ tell your Mac that it's OK] to run this app from an 'Unidentified developer'. If you simply double-click the app to run it, it will only give you two options, to move it to Bin or to Cancel, so press Cancel. Instead, to tell your Mac it's OK, hold the '''Command key''', click on vintagestory.app, and select '''Open'''. A box will appear asking 'Are you sure you want to open it?' Click the Open button (coloured white), and this security check will be satisfied. You only need to give this security approval once. | To run the game the first time after downloading it, you'll need to [https://www.howtogeek.com/205393/gatekeeper-101-why-your-mac-only-allows-apple-approved-software-by-default/ tell your Mac that it's OK] to run this app from an 'Unidentified developer'. If you simply double-click the app to run it, it will only give you two options, to move it to Bin or to Cancel, so press Cancel. Instead, to tell your Mac it's OK, hold the '''Command key''', click on vintagestory.app, and select '''Open'''. A box will appear asking 'Are you sure you want to open it?' Click the Open button (coloured white), and this security check will be satisfied. You only need to give this security approval once. | ||
== | == Installation on macOS with Apple silicon == | ||
Apple's recently released Mac M1, M2 or M3 computers - all new Macs since June 2023 - use "Apple silicon" (based on ARM) for better performance, better graphics and lower power consumption. | Apple's recently released Mac M1, M2 or M3 computers - all new Macs since June 2023 - use "Apple silicon" (based on ARM) for better performance, better graphics and lower power consumption. | ||
| Line 59: | Line 68: | ||
=== Normal installation === | === Normal installation === | ||
For installation, please follow exactly the same directions as for Intel Macs in the [[Installing_the_game_on_MacOS#Installation_on_macOS_with_Intel_silicon|section above]]. You first need to download and install .NET 7 Runtime (macOS x64 version), see link above, if you do not already have that on your computer: note, it needs to be the x64 version not the arm64 version of the .NET7 Runtime. Then download the macOS version of Vintage Story, version 1.19. | For installation, please follow exactly the same directions as for Intel Macs in the [[Installing_the_game_on_MacOS#Installation_on_macOS_with_Intel_silicon|section above]]. You first need to download and install .NET 7 Runtime (macOS x64 version), see link above, if you do not already have that on your computer: note, it needs to be the x64 version not the arm64 version of the .NET7 Runtime. Then download the macOS version of Vintage Story, version 1.19.4 or later, and it should simply run from <code>vintagestory.app</code> as soon as you have Unarchived it and given it permission to Open. | ||
For most players, the x64 build should "just work" (TM) on Apple silicon as well, this is the magic of Rosetta. If for some reason Rosetta does not work you can use <code>arch</code> in Terminal to run the game manually as detailed in the next two sections below. | For most players, the x64 build should "just work" (TM) on Apple silicon as well, this is the magic of Rosetta. If for some reason Rosetta does not work you can use <code>arch</code> in Terminal to run the game manually as detailed in the next two sections below. | ||
