search

bvschaik / julius

An open source re-implementation of Caesar III
GNU Affero General Public License v3.0
2.85k stars 317 forks source link

Manual page #740

Open vv221 opened 3 days ago

vv221 commented 3 days ago

Currently julius does not provide a manual page. But I see there are already some usage instructions:

INFO: Usage: julius [ARGS] [DATA_DIR]
INFO: ARGS may be:
INFO: --display-scale NUMBER
INFO:           Scales the display by a factor of NUMBER. Number can be between 0.5 and 5
INFO: --cursor-scale NUMBER
INFO:           Scales the mouse cursor by a factor of NUMBER. Number can be 1, 1.5 or 2
INFO: --windowed
INFO:           Forces the game to start in windowed mode
INFO: The last argument, if present, is interpreted as data directory for the Caesar 3 installation

I can write basic manual pages based on this, both a default page in English and a localized one in French.

In addition to the command usage and the command-line switches, it could include information on the ~/.local/share/bvschaik/julius/data_dir.txt path used to set the path to Caesar 3 data files. And maybe some information about the need to run julius once from a terminal the first time, so it can prompt for this path, before the .desktop menu entry can be used.

While I can provide these files (and would obviously keep them updated if you add new command-line switches, as long as you give me a ping so I don’t miss them), I don’t really know how to work with CMake so for now I would not know how to include them in the list of files to install. I could provide the manual pages and let you integrate them into the installation process, or if you have some time to explain how it works I would be happy to handle this part too.

crudelios commented 3 days ago

Just a heads-up: it's possible you don't need to run Julius from the command line on your first run.

It should display a folder select dialog.

If it's not working then it's likely a bug of some kind, which I'll be more than happy to help fix.

vv221 commented 3 days ago

It should display a folder select dialog.

I don’t get that, so something might be wrong indeed. I’m going to open another issue about that, so we can keep this one focused on the manual page.

Done, cf. #741.

crudelios commented 3 days ago

Since the #741 bug is not really a bug, I'm guessing the manual could mention that a select folder window should appear and if nothing happens the game should be run from the console so the directory can be picked.

vv221 commented 3 days ago

the manual could mention that a select folder window should appear and if nothing happens the game should be run from the console

Yes, if I had this information I would not have thought the .desktop launcher was broken in some way. So it sounds like an useful piece of information.

Most users would not need this information, but the ones not having a supported GUI dialog alternative available are most probably the ones that are the most likely to read a manual page too.