Feature #1153

Make ryzom_client run completely in an .app bundle

Added by rti about 9 years ago. Updated almost 9 years ago.

Status:Assigned Start date:11/02/2010
Priority:Normal Due date:
Assignee:rti % Done:

80%

Category:OS: Mac
Target version:Version 0.9.0

atys.icns (12.7 kB) Jeru, 02/05/2011 03:52 pm

atys.png - ryzom logo big (1.6 MB) vl, 02/06/2011 09:37 am

atys.icns (627.8 kB) Jeru, 02/06/2011 11:13 am


Related issues

related to Ryzom - Feature #1217: Per user config/logs for OVQT and GEQT app bundles New 12/12/2010

History

#1 Updated by rti about 9 years ago

  • % Done changed from 0 to 50

See MacBinaries for a first test.

#2 Updated by rti about 9 years ago

  • Status changed from New to Resolved
  • % Done changed from 50 to 100

Applied in changeset r1090.

#3 Updated by rti about 9 years ago

  • Assignee set to rti
  • Target version set to Version 0.8.0

#4 Updated by rti about 9 years ago

  • % Done changed from 100 to 80

After starting the .app from one location, that path to client_default.cfg is written into client.cfg.
So if now the .app is moved, it will not start up anymore because the path to client_default.cfg is not valid anymore...
This should be fixed!

#5 Updated by rti about 9 years ago

  • Status changed from Resolved to Assigned

#6 Updated by kervala about 9 years ago

This night I thought about something :)

  • Use the client_default.cfg.in to use a token such as <BundlePath> (that's just a proposition, but you can change this name) in PreDataPath and DataPath
  • Copy the generated client_default.cfg to Bundle
  • In CClientConfig::init, when creating client.cfg, put the real path to client_default.cfg (in Bundle) for RootConfigFilename, if the client.cfg is already created, update the RootConfigFilename variable to client_default.cfg (in Bundle), so when you launch Ryzom, it will always use the right client_default.cfg
  • When adding PreDataPath and DataPath to search paths, replace all <BundlePath> by the Bundle real path, so absolute, relative and relative from Bundle paths should be working :)

#7 Updated by vl about 9 years ago

Seems quite complex.

Another solution:
By default, the code move the working directory to the bundle/Contents/Resources/ where we have the client_default.cfg data/ directory and so on.
So all the code is working without any modification.
Be sure the client.cfg RootConfigFile contains "client_default.cfg" without any path.

And voila, no need of special case like "preDataPath = getAppBundlePath() + "/Contents/Resources/" + preDataPath;" or "defaultConfigFileName = getAppBundlePath() + "/Contents/Resources/" + defaultConfigFileName;"

#8 Updated by rti about 9 years ago

The goal was to split client.cfg, screenshot etc stuff from data and client_default.cfg. This way, every user on the machine has it's own config and the ryzom_client.app bundle does not need to be writable (in case of non-admin users).

#9 Updated by rti about 9 years ago

So the working directory is set to ~/Application Support/Ryzom atm.

#10 Updated by vl about 9 years ago

It's not a problem.

You can set the working dir to bundle/Contents/Resources/ and write client.cfg, screenshot and other user files in your ~/Application Support/Ryzom atm.

#11 Updated by sfb about 9 years ago

Just a quick question out of curiosity... CPack generates .app, .framework, etc. Are you considering letting it build the .app for you? I understand the config file work has to happen outside of it. But it would be nice if we could harness that.

#12 Updated by rti about 9 years ago

@ace: How could that be done? As I understood the code, lots of stuff is created in / written to working directory. E.g.

init.cpp:742

        // create the save dir.
        if (!CFile::isExists("save")) CFile::createDirectory("save");

        // create the user dir.
        if (!CFile::isExists("user")) CFile::createDirectory("user");

client_cfg.cpp:251

const string ConfigFileName = "client.cfg";

client_cfg.cpp:1892

void CClientConfig::init(const string &configFileName)
{
    // if the users client config does not exist
    if(!CFile::fileExists(configFileName))
    {
        // create the basic .cfg
        FILE *fp = fopen(configFileName.c_str(), "w");

All those parts would need adjustments then, don't they?


@sfb: Even ADD_EXECUTABLE can create .app bundles. To be honest, I never looked into CPack. Should have a look into it to see what is possible using that.

#13 Updated by vl about 9 years ago

Indeed but the rework is just to append a userDirectory() function that get the ~/.ryzom on linux ~/Application Support/Ryzom on mac.

#14 Updated by rti about 9 years ago

Ok, so you'd suggest to have the working path where data is (not necessarily writable), and the writable user path somewhere else (platform dependent), so the code handles the prefixes for this. Hm. Well, yes, thats the other way around and makes the custom client_default.cfg unnecessary... Might be a cleaner solution...

#15 Updated by kervala about 9 years ago

I already did that for all debug/log/temporary stuff, it's using getLogDirectory(), which is the one passed to createDebug(logpath); :)

#16 Updated by rti about 9 years ago

ok, finally we agreed on:

  • working path is writable
  • working path is per user and platform specific (e.g. ~/.ryzom or ~/Application Support/Ryzom)
  • data and client_default.cfg may be read only
  • on mac, they are in ryzom_client.app/Contents/Resources/
  • client.cfg's path to client_default.cfg must only be "client_default.cfg", even it is not in the working dir but in the app bundle
  • client_default.cfg's data path must be only "data" if ryzom_client.app/Contents/Resources/data is meant

#17 Updated by vl about 9 years ago

Perfect!

#18 Updated by rti almost 10 years ago

I am thinking about moving this functionality to NLMISC::CPath, because if we want to make CConfigFile able to load RootConfigFilename (even if it is just the plain file name) from the app bundle (or in general, the "(write only) resource path"), then NLMISC needs to know about app bundles. So it is not enough to have the app_bundle_utils in ryzom client anymore.

NLMISC::CPath already provides a similar functionality; it is possible to get:

  • a temp path using NLMISC::CPath::getTemporaryDirectory()
  • the user specific writable path using NLMISC::CPath::getApplicationDirectory() (the name is badly choosen imho)
  • the windows system path using NLMISC::CPath::getWindowsDirectory() (which is not useful in this context)

So I though about adding the possibility to get:

  • the resource path using NLMISC::CPath::getResourceDirectory() which is
    • SOME_NAME.app/Contents/Resources/ on Mac OS X
    • the path the executable is in on Windows, (e.g. C:/Programs Files/Ryzom/)
    • RYZOM_SHARE_PREFIX on e.g. linux (e.g. /usr/local/share/ryzom/)

And I thought about renaming getApplicationDirectory() to something like getUserDirectory() since getApplicationDirectory() sounds like it is the path containing the executable in my opinion.

Another thing is getLogDirectory() which is defined in nel/misc/debug.h. This functionality could be provided by CPath as well to keep the structure.

I would really like to see the path handling work the same way on all platforms. It does not feel right to just add another #ifdef NL_OS_MAC in the client to make it run. If CPath would return the paths to all necessary directories, this could be achieved quite easily.

And, if this would be implemented across all platforms equally, the windows implementation would gain per user configurations. Isn't that nice? :) But: There should be some way then to automatically migrate the current system wide configuration to the per user directories though.

What do you guys think?

#19 Updated by rti almost 9 years ago

  • Target version changed from Version 0.8.0 to Version 0.9.0

#20 Updated by Jeru almost 9 years ago

For those who wants, I made a low resolution icon for Mac by converting the ryzom.png file. Just copy it in the .../ryzom_client/Contents/Resources folder.

If someone knows hwo to edit the make install procedure to copy automatically the file, it should be great.

PS : If you have a higher resolution of the ryzom.png file, i'll make a better icon. Thx

#21 Updated by vl almost 9 years ago

Jeru you can find the big version (1000x1000 pixels) of the ryzom logo on the attachement.

#22 Updated by Jeru almost 9 years ago

Here's the high res icon file for mac :) (From 512*512 to 8*8)

Also available in: Atom PDF