Author Topic: Proper Documentation For All Commands / Changes Made?  (Read 7798 times)

0 Members and 1 Guest are viewing this topic.

Offline redmenace

  • 211
Proper Documentation For All Commands / Changes Made?
erm well that is one thing that should be done immediatly but we still need some structure to this little subproject. But we need to start a running list of subjects I will start this list tonite in this thread.
Government is the great fiction through which everybody endeavors to live at the expense of everybody else.
              -Frederic Bastiat

 

Offline redmenace

  • 211
Proper Documentation For All Commands / Changes Made?
here is the link to the current Readme file
http://fs2source.warpcore.org/readme/readme_3.6.txt

first we need to update this for H T&L
  Part One

1. System Requirements
The original Freespace 2  required DirectX® 5. FS2: SCP requires Directx® 8.
It will probably work with later DirectX® versions (such as DirectX® 9) but its highly
recommended to use DirectX® 8. DirectX® is avalible at <http://www.microsoft.com/directx>.

Minimum Configuration for Freespace 2: Source Code Project
• Windows® XP, Windows Me®, Windows 2000®, or Windows 98 SE®
  Windows® 95 is reported not to work with this version of FS2:SCP.
• 300 – 400MHZ CPU (Depending on additional preformance factors).
• 128 MB RAM, at least, 256 MB RAM is highly recommended.
• 4x CD-ROM/DVD-ROM drive (CD-Rom drive only need for cutscenes).
• 1.3 GB free HD space for the original install and a minimum of 3 MB for the FS2:SCP files.
• 16 MB video card with DirectX 5 compatible driver. Recommend atleast 32 MB TNT2.
• DirectX 5 compatible sound card.
• Keyboard and Mouse.

Safe Configuration for Freespace 2: Source Code Project
• 700 Mhz Pentium 3 or faster processor.
• 256 MB SDRAM.
• 8x or faster CD-ROM/DVD-ROM drive.
• 64 MB GeForce 2 or greater video card with DirectX 8 compatible driver.

Recommended for Serving Multiplayer Games
• A Broadband Type Internet Connection or LAN Network: DSL, Cable, T1, T3, etc.

secondly this mess needs to be updated with the H T&L command line options in addition to such other command lines as -cell and I think there are some others involving multi player.
-standalone      Starts FS2:SCP as a Standalone server. Not acctualy starting the game, a server
         for multiplayer games.
-nosound      All sound effects will be turned off.
-nomusic      Music will be turned off.
-startgame
-gamename #      Name of multiplayer game.
-password #      Password requierd to join the game.
-closed         
-restricted
-port #         Forces FreeSpace 2 yo use a specific port on local games. # can be anything between
         1 - 65556 as long as its not used by something else.
-connect #      Connect to a host, # being the host IP number.
-multilog
-oldfire
-clientdamage
-pofspew
-32bit         Run in 32-bit mode.
-coords
-timeout #      How many seconds before network timeout. Default if 30.
-window         Run in Window Mode.
-almission #       Auto loads multiplayer mission #, where # is the mission file name without the extension.
-GF4FIX         Enables the Geforce 4 fix for ani files.
-ALLSLEV      Gives access to all singleplayer missions.
-phreak         Gives access to Phreaks targeting-code and options
-mod #         Switches on the mod system, where # is a subdirectory found in ../freespace2/
         in case # = mymod, then the game will look in these directories for extra/replacement files:
         freespace2/mymod/
         freespace2/mymod/data/
         freespace2/mymod/missions/
         freespace2/mymod/tables/
         and so on, all valid subdirectories in the mod directory will be read from.
         In case of the mod flag, you must manually in some way create the mod directories player
         sub-directories, you must do this before you run the game with the mod flag.
         these are in case # = mymod
         freespace2/mymod/players/
         freespace2/mymod/players/single
         freespace2/mymod/players/multi
         freespace2/mymod/players/squad (This shouldend be needed, but be safe and create it anyway)
         freespace2/mymod/players/images (Same as above)
         So the mod directory if # = mymod would be freespace2/mymod
         all valid subdirectories like data/missions found in the mod directory will be used
         to be looked for files. If a file is found, and if a matching file exists in the normal
         locations then the file found in the mod directory will be used.
         VP files should be fully supported.
         If a .VP file is found in the Mod directory then files found in that .VP file will be used
         instead of the files found in VP files in other locations than the mod directory.
         Should there be more than 1 .VP file in the mod directory containing matching files, then the file
         found in the VP file that lexicographically comes first be used.
         
         Plain files not packed(in both the mod directroy and the default directories) will be used instead of
         matching files found in any .Vp file
   
         Player directories in the Mod directory must at the present time, be created, manually
         Those directories must exist or the game cannot write the pilot info when the player is being forced
         To create a new pilot when running the game for the first time.
         
         The game will ask for CD # 2 when you run the game with the mod-flag for a mod
         if there is not any pilot (.plr) files present.

         Do not use invalid signs such as "#¤%&/()=? `@£$€{[]}~|'*¨^ in your mod directory name

         # must match the directory name to the point. Dont worry about directory seperators, the game adds them if needed.
Government is the great fiction through which everybody endeavors to live at the expense of everybody else.
              -Frederic Bastiat

 

Offline Kazan

  • PCS2 Wizard
  • 212
  • Soul lives in the Mountains
    • http://alliance.sourceforge.net
Proper Documentation For All Commands / Changes Made?
Wait until i have to unleash the documentation dogs on FS Dev Studio .. right now some of the **** is bloody ugly until i get a lot more implementation done then I'll go about making it more friendly and pretty :D
PCS2 2.0.3 | POF CS2 wiki page | Important PCS2 Threads | PCS2 Mantis

"The Mountains are calling, and I must go" - John Muir

 

Offline Setekh

  • Jar of Clay
  • 215
    • Hard Light Productions
Proper Documentation For All Commands / Changes Made?
Quote
Originally posted by Flipside
Thanks Setekh, we don't want to tread on peoples toes :D

I suppose the logical start point is doing a small user manual for RT's Launcher, explaining selecting your graphics settings, the '-' extensions etc and what they do. This is the first part of the SCP anyone encounters, so it makes sense to me :)

Flipside :D


That sounds pretty good to me - then build upwards and onwards. Right now the staff are chewing over a few options. :)
- Eddie Kent Woo, Setekh, Steak (of Steaks), AWACS. Seriously, just pick one.
HARD LIGHT PRODUCTIONS, now V3.0. Bringing Modders Together since January 2001.
THE HARD LIGHT ARRAY. Always makes you say wow.

 

Offline redmenace

  • 211
Proper Documentation For All Commands / Changes Made?
Code: [Select]

[B]
// here are the command line parameters that we will be using for FreeSpace
cmdline_parm standalone_arg("-standalone", NULL);
cmdline_parm nosound_arg("-nosound", NULL);
cmdline_parm nomusic_arg("-nomusic", NULL);
cmdline_parm startgame_arg("-startgame", NULL);
cmdline_parm gamename_arg("-gamename", NULL);
cmdline_parm gamepassword_arg("-password", NULL);
cmdline_parm gameclosed_arg("-closed", NULL);
cmdline_parm gamerestricted_arg("-restricted", NULL);
cmdline_parm allowabove_arg("-allowabove", NULL);
cmdline_parm allowbelow_arg("-allowbelow", NULL);
cmdline_parm port_arg("-port", NULL);
cmdline_parm connect_arg("-connect", NULL);
cmdline_parm multilog_arg("-multilog", NULL);
cmdline_parm server_firing_arg("-oldfire", NULL);
cmdline_parm client_dodamage("-clientdamage", NULL);
cmdline_parm pof_spew("-pofspew", NULL);
cmdline_parm mouse_coords("-coords", NULL);
cmdline_parm timeout("-timeout", NULL);
cmdline_parm d3d_window("-window", NULL);
cmdline_parm almission_arg("-almission", NULL); //DTP for autoload Multi mission
cmdline_parm gf4fix_arg("-gf4fix", NULL); //DTP for random tigers GF4fix
cmdline_parm allslev_arg("-allslev", NULL); //Give access to all single player missions
cmdline_parm phreak_arg("-phreak", NULL); // Change to phreaks options including new targetting code
cmdline_parm dnoshowvid_arg("-dnoshowvid", NULL); // Allows video streaming
cmdline_parm mod_arg("-mod", NULL); //DTP modsupport
cmdline_parm fps_arg("-fps", NULL);
cmdline_parm d3dlowmem_arg("-d3dlowmem", NULL); //DTP for random tigers GF4fix
cmdline_parm d3dmipmap_arg("-d3dmipmap", NULL);
cmdline_parm beams_no_pierce_shields_arg("-nobeampierce", NULL); // beams do not pierce shields - Goober5000
cmdline_parm fov_arg("-fov", NULL); // comand line FOV -Bobboau
cmdline_parm spec_exp_arg("-spec_exp", NULL); // comand line FOV -Bobboau
cmdline_parm spec_point_arg("-spec_point", NULL); // comand line FOV -Bobboau
cmdline_parm spec_static_arg("-spec_static", NULL); // comand line FOV -Bobboau
cmdline_parm spec_tube_arg("-spec_tube", NULL); // comand line FOV -Bobboau
cmdline_parm safeloading_arg("-safeloading", NULL); //Uses old loading method -C
cmdline_parm nospec_arg("-nospec", NULL); // skip specular highlighting -Sticks
cmdline_parm MissionCRCs("-missioncrcs", NULL);
cmdline_parm TableCRCs("-tablecrcs", NULL);
cmdline_parm nohtl_arg("-htl", NULL); //Use software HT&L  
cmdline_parm cell_arg("-cell", NULL);
cmdline_parm textures_32bit("-t32",NULL);
cmdline_parm no_set_gamma("-no_set_gamma",NULL);
cmdline_parm d3d_no_vsync("-d3d_no_vsync", NULL);
[/B]

here is the most recent list of parameters pulled right from cmdline.cpp. If you don't want people to see this list of parameters then just pull this thread into the internal forum and give the few that are working of this access. Setekh, what did you mean by "Right now the staff are chewing over a few options."
Government is the great fiction through which everybody endeavors to live at the expense of everybody else.
              -Frederic Bastiat

 

Offline Flipside

  • əp!sd!l£
  • 212
Proper Documentation For All Commands / Changes Made?
Excellent list RM! I'm assuming that the non-commented ones are the default [v] ones?
Flipside :D
« Last Edit: November 06, 2003, 05:12:10 pm by 394 »

 
Proper Documentation For All Commands / Changes Made?
I've writen some instructions on how to configure the game in HTML. Its very image friendly and got a simple clean-cut design(there's enough eyecandy in-game :D )...
When will I learn?  The answer to life's problems aren't at the bottom of a bottle, they're on TV! -- Homer,  "There's No Disgrace Like Home''
I sometimes find myself here on this forum, late at night constantly pressing "Reload" over and over again

  
Proper Documentation For All Commands / Changes Made?
Flipside, you want to help out?
When will I learn?  The answer to life's problems aren't at the bottom of a bottle, they're on TV! -- Homer,  "There's No Disgrace Like Home''
I sometimes find myself here on this forum, late at night constantly pressing "Reload" over and over again

 

Offline Sandwich

  • Got Screen?
  • 213
    • Skype
    • Steam
    • Twitter
    • Brainzipper
Proper Documentation For All Commands / Changes Made?
Quote
Originally posted by redmenace
Setekh, what did you mean by "Right now the staff are chewing over a few options."


He meant that we're pondering which method would be best to support the on-going documentation of the SCP. Basically it's a toss-up between forum-based and Wiki.
SERIOUSLY...! | {The Sandvich Bar} - Rhino-FS2 Tutorial | CapShip Turret Upgrade | The Complete FS2 Ship List | System Background Package

"...The quintessential quality of our age is that of dreams coming true. Just think of it. For centuries we have dreamt of flying; recently we made that come true: we have always hankered for speed; now we have speeds greater than we can stand: we wanted to speak to far parts of the Earth; we can: we wanted to explore the sea bottom; we have: and so  on, and so on: and, too, we wanted the power to smash our enemies utterly; we have it. If we had truly wanted peace, we should have had that as well. But true peace has never been one of the genuine dreams - we have got little further than preaching against war in order to appease our consciences. The truly wishful dreams, the many-minded dreams are now irresistible - they become facts." - 'The Outward Urge' by John Wyndham

"The very essence of tolerance rests on the fact that we have to be intolerant of intolerance. Stretching right back to Kant, through the Frankfurt School and up to today, liberalism means that we can do anything we like as long as we don't hurt others. This means that if we are tolerant of others' intolerance - especially when that intolerance is a call for genocide - then all we are doing is allowing that intolerance to flourish, and allowing the violence that will spring from that intolerance to continue unabated." - Bren Carlill

 

Offline Flipside

  • əp!sd!l£
  • 212
Proper Documentation For All Commands / Changes Made?
I'd be happy to help if I can BF, I suppose my 'speciality' would be the texture stuff if anything, but I can use the Search facility etc as well as anyone else :)

Flipside :D