From b1c4a957c15fbc6fe6efec47bfe55d3eb019f347 Mon Sep 17 00:00:00 2001 From: Dino Date: Sat, 24 Dec 2022 22:51:30 -0500 Subject: [PATCH] Ticket #46262 adding new file README.MacInstall --- doc/Makefile.am | 1 + doc/README.MacInstall | 75 +++++++++++++++++++++++++++++++++++++++++++ meson.build | 1 + 3 files changed, 77 insertions(+) create mode 100755 doc/README.MacInstall diff --git a/doc/Makefile.am b/doc/Makefile.am index cbdecb10d6..af14fe78c8 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -22,6 +22,7 @@ docs = \ README.fcdb \ README.governor \ README.graphics \ + README.MacInstall \ README.modpack_installer \ README.msys2 \ README.nations \ diff --git a/doc/README.MacInstall b/doc/README.MacInstall new file mode 100755 index 0000000000..c61be4cedd --- /dev/null +++ b/doc/README.MacInstall @@ -0,0 +1,75 @@ +To build and install freeciv on your Mac from the release tarball, first you +must un-zip the tarball, which you must have already done to see this file. +Next launch the Terminal app, which lives in the Utilities folder inside the +Applications folder. This gets you access to the command line, where you need +to enter some commands. + +You will need the Command Line Tools (CLT) for Xcode. If you have XCode +installed, you're all set. Otherwise enter this command on the command line - + +> xcode-select --install + +First command is to "change directory" to the path which is the source +folder. If you un-zipped the tarball, for example "freeciv-3.1.0.zip", in +your Downloads folder, you would have the source folder "freeciv-3.1.0", also +in your Downloads folder. The path would then be "~/Downloads/freeciv-3.1.0". +If you put it somewhere else, or the name is different (maybe a different +version) then adjust the path accordingly. Assuming it's in the Downloads +folder then the commands are + +> cd ~/Downloads/freeciv-3.1.0 +> zsh platforms/macos/homebrew-install-packages.sh +> zsh platforms/macos/homebrew-appbundle.sh + +These commands will take awhile to run. When successful, you will have a +"freeciv.app" in your Applications folder. It needs to be there, and not +re-named, in order to work. You can delete the zip file and source folder +when done. + +Because Macs are so paranoid, you may have a hard time running it the first +time. When you get the dlog that says it cannot be opened because the +developer cannot be verified, click cancel, then open System Preferences, go +to Security & Privacy and click the Open Anyway button. That will save it as +an exception to your security settings, and you can open it in the future by +double-clicking it. + +Tip - the save game files are in a folder named ".freeciv/saves" within your +home folder, AKA "/Users/{username}/.freeciv/saves". Your home folder is the +one with the house icon next to it in the favorites. In Unix-speak, it's +"~/.freeciv/saves". The finder won't normally show you folders that start +with ".", but you can toggle that by entering CMD+Shift+. while in a finder +window. While the hidden stuff is visible you can make an alias to the +".freeciv" folder which will always be visible. + +The default graphics client is qt. The gtk3.22 client is also included, they +look quite different but have mostly the same functionality. The qt client +has more zoom levels, and they both have their own little bugs. You can +switch clients by doing a little work. The Mac Finder shows apps like +freeciv.app as if it were a file, but once the drugs wear off it is actually +a folder. To peak inside, control+click (or right mouse button click) on the +app icon to get the pop-up menu and choose the menu item "Show Package +Contents". You will see a folder called "Contents", inside that is a file +called "Info.plist", which is a plain text file that controls what gets +executed. You can edit this file with the TextEdit app. There is a pair of +lines like this - + + CFBundleExecutable + ../bin/freeciv-qt + +Replace the string "../bin/freeciv-qt" with "../bin/freeciv-gtk3.22", and +save the file. The last step is to get the Finder to update its internal +database. Rename the "freeciv.app" to anything different (I like to add 'x' +to the end) and then rename it back to "freeciv.app". + +While you're in there, inside the "Contents" folder there's a folder called +"bin", which contains another executable file called "freeciv-mp-qt". This is +the modpack installer. You can double click on it and run it to install +modpacks. There is also a file "freeciv-server", which you can also double +click on and run if you want to set up a server for multi-player games. The +server does not have a GUI, it opens a terminal window where you can type in +interactive commands. For more details, see the wiki page +https://www.freeciv.org/wiki/Server_Manual +The "bin" folder also contains a file "freeciv-ruleup", which can be used to +update a ruleset from the format of the previous freeciv version to the +current version. For more details, see the wiki page +https://freeciv.org/wiki/Freeciv-ruleup diff --git a/meson.build b/meson.build index 53442a705b..f5008c22b0 100644 --- a/meson.build +++ b/meson.build @@ -3542,6 +3542,7 @@ install_data( 'doc/README.fcdb', 'doc/README.governor', 'doc/README.graphics', + 'doc/README.MacInstall', 'doc/README.modpack_installer', 'doc/README.msys2', 'doc/README.nations', -- 2.31.0