OpenJK icon indicating copy to clipboard operation
OpenJK copied to clipboard

Make clear where to put the executables and what they are for

Open jubalh opened this issue 10 years ago • 13 comments

When unzipping I got two subfolders that were not mentioned in the documentation. I was not aware that the folder structure had to look like this and had to find out on IRC about it. Let's make it more clear for others.

jubalh avatar Jan 01 '16 14:01 jubalh

Under what OS under what conditions? This isn't exactly a release state but yes.

ensiform avatar Jan 01 '16 16:01 ensiform

Under openSUSE Tumbleweed (Linux) extracting with: tar xfv openjk-2015-11-30-c8c64c4b-linux-64.tar.gz

Anyways I think the information added is universal. It's good to know that the binary needs to be directly in the GameData folder.

jubalh avatar Jan 04 '16 09:01 jubalh

+1 I was initially unsure as well where to put the binaries under osx. A short note in the docs would be awesome!

marvinhagemeister avatar Jan 04 '16 10:01 marvinhagemeister

@ensiform anything you are not happy about with that change? :-)

jubalh avatar Jan 07 '16 13:01 jubalh

The subfolder GameData isn't technically necessary for Linux or Mac.

ensiform avatar Jan 10 '16 20:01 ensiform

With no Linux installer, there's no standard/provided GameData folder. I don't think there's a GameData folder with any disc copy or App Store version of JA on Mac? Steam and Windows installers are the only ones to contain GameData AFAIK

Razish avatar Jan 11 '16 02:01 Razish

In fact on linux it should not be used since most servers don't have that directory hierarchy.

ensiform avatar Jan 11 '16 04:01 ensiform

But funny thing about that is that the info about GameData folder was in that README even before I added the additional information. So there clearly should something be changed

jubalh avatar Jan 11 '16 10:01 jubalh

Well two of my friends who wanted to install the game had the some unclarity I had. They called me and I explained them. Would have been easier if this would have been in the readme already..

jubalh avatar Jan 30 '16 08:01 jubalh

I've had issues trying to explain to Mac users where to put things and what GameData is. This issue is bigger than (and not caused by) OpenJK. How do we resolve this? A standardised directory + structure would be best, but we can't make assumptions about user configurations. Most installation targets are different. Maybe the best way is to provide a table listing common paths and describing the agreed-upon "best location" for readable + writable directories. May need some Mac and Linux users; we should cover App Store, Steam and previous installations in the case of no native installers

Razish avatar Jan 30 '16 10:01 Razish

Sounds like a lot to figure out. My setup is like this: I have the CD-Rom Version of the game and run Linux.

With this one I can help, about the others I have no idea.

Still my suggestion is to add the information I proposed already to make it easier for users right now. And have a best-case-solution later.

jubalh avatar Jan 30 '16 15:01 jubalh

Just looked over it again, I don't think that install prefix should be there at all. On Linux with -DCMAKE_INSTALL_PREFIX=/home/tex/games I get:

Install the project...
-- Install configuration: "RelWithDebInfo"
-- Installing: /home/tex/games/JediAcademy/openjk.x86_64

On Mac with -DCMAKE_INSTALL_PREFIX=/Users/tex/games I get:

Install the project...
-- Install configuration: "RelWithDebInfo"
-- Installing: /Users/tex/games/JediAcademy/openjk.x86_64

On Windows I have -DCMAKE_INSTALL_PREFIX=D:/Games and a D:/Games/JediAcademy folder "symlinked" to steamapps/common/Jedi Academy/GameData - but you could just as easily link it to your existing installation's GameData if you don't use Steam. My Windows setup isn't ideal because it involves things most users have never done before. If we change the Windows build output to match common paths on Windows (i.e. GameData) then it's broken again for Steam installations or (some?) Mac installations.

...what I'm saying is, the instructions in this PR mention an install parent folder, which should not exist. ~~It's possible this has already been fixed, it's possible this is just a buildbot misconfiguration where it's zipping and uploading the wrong directory~~ I believe the install folder should exist with the buildbot configuration and contain JediAcademy as-well as JediOutcast in the future. That sounds reasonable.

That being said, how do others feel about this change now?

Razish avatar Jan 30 '16 16:01 Razish

Ping

Razish avatar Mar 15 '16 03:03 Razish

Made renundant with the merge of: https://github.com/JACoders/OpenJK/pull/1171

@Razish @ensiform plz lock

bartrpe avatar Mar 05 '24 02:03 bartrpe