Installing the game on MacOS: Difference between revisions

From Vintage Story Wiki
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 18: Line 18:
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.
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 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.
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 (especially with game versions prior to 1.19.2) 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!)
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 ==
== Asian fonts ==
Line 32: Line 32:
==Known issues generally on macOS:==
==Known issues generally on macOS:==
===Known current issues===
===Known current issues===
* (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 extend slightly beyond it  (may be fixed in 1.19.2+, needs verification...)
* Asian language fonts may require manual configuration, see above
* 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
* 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
Line 39: Line 38:
* 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, 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
* 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 (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
* 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
Line 54: 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?  When it comes, 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.
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].
Confirmedusers, editor
348

edits