Need complete info on switches for manpage(s)

Discussion about the game and its default mods.
Post Reply
Iran
Posts: 92
Joined: Wed Sep 08, 2010 3:16 pm

Need complete info on switches for manpage(s)

Post by Iran »

I've not yet begun on creating manpage(s). Uh..the current packages don't include the map editor, but I'd like to do a seperate manpage for those if I also can get info on it.

So basically, I need a list of all the command-line options, additionally a small history and keyboard shortcuts.

I'll make it look like a combination of:

http://pastebin.ca/1937275 (openTTD manpage)

and

http://pastebin.ca/1937278 (mupen64plus manpage)

User avatar
Sleipnir
Posts: 851
Joined: Wed Apr 10, 2002 11:52 pm
Contact:

Post by Sleipnir »

Our current args are `SupportDir=<filepath>` which sets the path to the user support dir where we save settings, logs etc, and overrides for any settings flag that can exist in settings.yaml, in the form `<type>.<flag>=<override>` -- eg `Game.Mods=cnc` or `Player.Name=foobar`. See OpenRA.Game/GameRules/Settings.cs for all of the settings.

The map editor treats its first argument as the mod to load, and ignores any others. This will need to change to support add-on mods for ra or cnc.

Iran
Posts: 92
Joined: Wed Sep 08, 2010 3:16 pm

Post by Iran »

Thanks, I'll take a look at making manpages later this day.

chrisf
Posts: 246
Joined: Mon Sep 06, 2010 4:59 am

Post by chrisf »

Correction: the map editor should treat the first arg as a comma-separated list of mods to load. `ra,ra_perf` works for editing the pathing perf test map, etc.

Iran
Posts: 92
Joined: Wed Sep 08, 2010 3:16 pm

Post by Iran »

Here's my concept version: http://pastebin.ca/1938499

The markup for it is:

Code: Select all

.TH OpenRA 6 "September 2010"
.SH NAME
openra \- Open source RTS engine written in C# that runs early Command & Conquer games
.SH SYNOPSIS
.BI "openra &#91; SupportDir="support_directory
.B &#93;
.BI "&#91; <settingstype>.<flag>="override
.B &#93;

.BI "openra-cnc" " &#91;OPTIONS&#93;"

.BI "openra-ra" " &#91;OPTIONS&#93;"
.SH DESCRIPTION
.I openRA
runs under Mono or any other virtual machine that supports executing CLI applications. The
.B openra-cnc 
command is a simple script that will run the engine with the C&C mod loaded,
.B openra-ra
will do likewise for the Red Alert mod.

.SH OPTIONS
.TP
.BI "SupportDir="support_directory
Set the 
.B SUPPORT_DIR
-- the path that will be used to write and read user-specific files, such as&#58; logs, replays, settings. The directory ~/OpenRA is the default,  but the launcher sets this to ~/.openra.
.TP
.BI "<settingstype>.<flag>="override 
Set an override for a setting defined in the
.I settings.yaml
file located inside the 
.BR SUPPORT_DIR . 
For example, you can run the engine with the options
.BI "Game.Mods="cnc 
or
.BI "Player.Name"=foobar 
etc. This will cause the C&C mod to be run and your in-game name to be changed to 'foobar', in that order. See the EXAMPLES section below for a few useful overrides.
.SH EXAMPLES
The 
.B openra
command runs /usr/share/openra/OpenRA.Game.exe, therefore you can substitute every mention of that command with 
.IR ./OpenRa.Game.exe ,
given that your current path is inside the directory in which this binary resides.
.TP
.B openra Graphics.Mode=Windowed Graphics.Mode=800,600
Will run the game in a 800x600 window.
.TP
.BI "openra Game.Mods="modname
Will run the mod specified with
.IR modname .
This mod will be loaded from /usr/share/openra/mods/modname/, if the directory doesn't exist the game will crash with indescribable gibberish.
.SH FILES
Note that ~/.OpenRA is the default  
.BR SUPPORT_DIR ,
but that the 
.I openra
command launches with this set to ~/.openra. You can change this directory by running the engine with the 
.BI "SupportDir="support_directory
option, where
.I support_directory
is the directory you want to load from and read to these files.
.TP
.I ~/.openra/settings.yaml
The default configuration file that loaded is loaded when the engine starts.
.TP
.I ~/.openra/Logs/server.log
Contains logged events that occured on your server. The "server" referred to is started whenever you host a game through the "Create Game" menu.
.TP
.I ~/.openra/Logs/exception.log
Exceptions that were raised during startup or running the engine will be stored here. This file can give crucial information on fatal bugs or errors keeping the engine from running.
.TP
.I ~/.openra/Logs/debug.log
This file stores debug information, 'nuf said.
.TP
.I ~/.openra/Logs/perf.log
Contained herein is performance information. You can help the developers by posting this file plus hardware specs on our forums.
.TP
.I ~/.openra/Logs/syncreport.log
The whole log of synchronisation info from your last online multiplayer game is stored in this file. This file gets cleared everytime you restart the game.
.TP
.I ~/.openra/Replays
A directory dedicated to storing replays.
.SH BUGS
.B openra
is still in early alpha phase and will therefor contain a plethora of bugs. If you think you found a bug, please report them to our bugtracker. Please try to check whether the bug is unique or not before filing a new ticket.
.SH WEBSITE
.I http&#58;//open-ra.org/
.SH FORUM
.I http&#58;//www.sleipnirstuff.com/forum/viewforum.php?f=80
.SH BUG TRACKER
.I http&#58;//red-bull.ijw.co.nz&#58;3690/OpenRA/
.SH GITHUB PAGE
.I http&#58;//github.com/chrisforbes/OpenRA
.SH "SEE ALSO"
.BR OPENRA-EDITOR-NAME-HERE &#40;6&#41;,
The 'OPENRA-EDITOR-NAME-HERE' part obviously needs to change. To use this save the file as openra.6 and run:

Code: Select all

$ gunzip openra.6
# cp openra.6 /usr/share/man/man6
# mandb

Post Reply