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

0 Members and 1 Guest are viewing this topic.

Offline Setekh

  • Jar of Clay
  • 215
    • Hard Light Productions
Proper Documentation For All Commands / Changes Made?
:yes: Good on ya redmenace, keep me posted on how much progress you make, this'll make the news once it gets a certain distance. :)
- 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?
REAL progress won't happen till Christmas break. But I will start writing the getting started section of the readme. But i need to research the Visual C++ project properties as well as build a new system.
Government is the great fiction through which everybody endeavors to live at the expense of everybody else.
              -Frederic Bastiat

 

Offline Bobboau

  • Just a MODern kinda guy
    Just MODerately cool
    And MODest too
  • 213
Proper Documentation For All Commands / Changes Made?
I'm hopeing we get 3.6 done by christmas, we've come a long way, but there is still a lot of work to be done
Bobboau, bringing you products that work... in theory
learn to use PCS
creator of the ProXimus Procedural Texture and Effect Generator
My latest build of PCS2, get it while it's hot!
PCS 2.0.3


DEUTERONOMY 22:11
Thou shalt not wear a garment of diverse sorts, [as] of woollen and linen together

 

Offline übermetroid

  • Current Father Of Samus
  • 28
  • He who dares wins.
Proper Documentation For All Commands / Changes Made?
What new is going to be in 3.6?  I will be like a XMAS gift!!!
"This is your life and it's ending one minute at a time."

 

Offline redmenace

  • 211
Proper Documentation For All Commands / Changes Made?
turrets postions other than straight up. Ok there will be alot of info we will need to write for the multi player code.oh ya to get ahold of my email my [email protected]
« Last Edit: November 02, 2003, 01:59:14 am by 887 »
Government is the great fiction through which everybody endeavors to live at the expense of everybody else.
              -Frederic Bastiat

 

Offline Goober5000

  • HLP Loremaster
  • Moderator
  • 214
    • Goober5000 Productions
Proper Documentation For All Commands / Changes Made?
Setekh, what would you think of giving us another sub-forum dedicated specifically toward developing the readme?  If bottomfan, Flipside, redmenace, and whoever else wanted to work on something, that might be a good base of operations.

 

Offline übermetroid

  • Current Father Of Samus
  • 28
  • He who dares wins.
Proper Documentation For All Commands / Changes Made?
Now that is a good idea.  That way HLPers can poke at it and ask questions about the read me before it is done.  Kinda like a Beta readme.
"This is your life and it's ending one minute at a time."

 

Offline Flipside

  • əp!sd!l£
  • 212
Proper Documentation For All Commands / Changes Made?
Sounds like a good idea! I'll have to get a look at this Wiki thing and try to get my head around it though ;)

Flipside :D

 

Offline redmenace

  • 211
Proper Documentation For All Commands / Changes Made?
Now 4 comments:
We should concentrate on the SCP readme. This readme should contain, info on using new table entries, obviously new features, such as glowpoints, explain the new SEXPs, and so on. Also I think we should handle a subject at a time. Such as the Multiplayer stuff kazan added, then say a section on glowmaps, then a section for the new sexps, then a section for how to create shine maps and so on. Each section should include all information such as, warnings, trouble shooting common problems with that feature, sample of a the feature and so on.

2. We need to as well update the FRED2 Help html.

3. Is there some software that we could use to keep track of changes. or maybe we could just submit sections of the readme in sections. People could download the section they want.

4. I think this should be done in full disclosure. I think out forum needs differ greatly than that of the SCP.
Government is the great fiction through which everybody endeavors to live at the expense of everybody else.
              -Frederic Bastiat

 
Proper Documentation For All Commands / Changes Made?
redmenace, check your PM.
« Last Edit: November 02, 2003, 07:23:08 pm by 1109 »
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 redmenace

  • 211
Proper Documentation For All Commands / Changes Made?
ok for a start we need to nominate a project head. I think bottom fan for one. Second we need an email list. Third we need to start listing all the current list of topics we need to include.
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?
I think the best bet would be to subdivide into :-

Graphics additions
Sound additions (Nothing yet, but I remain ever hopeful)
Fred 2 Open (Sexp's, Background updates etc)
New Weapons Tags
New Ships Tags
Other stuff (HTL, No poly limits etc etc)

This way we can at least have a reference guide with listings of all the correct Sexp's, tags etc and their various uses.

Each one would have to come with instructions and an example or two, for example, Lens Reflections would require an example of the correct entries in the .tbl files etc.

Flipside :D

 

Offline redmenace

  • 211
Proper Documentation For All Commands / Changes Made?
How detailed should this be? I mean should be also include tutorials on how to use say photoshop with say lense flare(I think you need external artwork). Or like the Fred_open section on name plates. Should we include a tutorial for photoshop of how to create name plates for the hectate and the orion. Maybe stuff like this should go into an long over due modding manual for FS OPEN. But before we start breaking up the manual into sections like that we need to first list all the of the subtopics.
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?
I think the first step will be to create a reference manual for Modders, assume at first that people reading this document are familiar with 'Basic' Freespace Modding. I.e. How to extract files etc, and things like UV Mapping and creating Textures can wait, we will assume people know how to create the material, we just show them how to apply it for now :)
It would be nice to do a full comprehensive Freespace 2 Modding Encyclopedia, but I think we would be biting off more than we could chew at first.

Edit : As for the new features like nameplates, a more detailed description would be required to a degree, but only where it is relevant to the SCP, not standard Fredding, so, for example, Sexp's will have a name and a Description and a short example, that's all, I don't think we should go into how to use Sexp's in mission etc, at least not yet ;)

Flipside :D
« Last Edit: November 03, 2003, 01:41:13 pm by 394 »

 

Offline karajorma

  • King Louie - Jungle VIP
  • Administrator
  • 214
    • Karajorma's Freespace FAQ
Proper Documentation For All Commands / Changes Made?
Quote
Originally posted by Flipside
As for the new features like nameplates, a more detailed description would be required to a degree, but only where it is relevant to the SCP, not standard Fredding, so, for example, Sexp's will have a name and a Description and a short example, that's all, I don't think we should go into how to use Sexp's in mission etc, at least not yet ;)


Goober has already made a tutorial on how to make Orion Nameplates in Photoshop (I even linked to it in my FAQ). I doubt he'd mind contributing it to this project. All you would need to add is telling the user how to find the texture replacement button in FRED2_open :D

As for the FAQ itself I don't have much time to write much but I'm happy to help in any other way I can. Feel free to cut and paste anything you want from any part of my FAQ if it will help.
Karajorma's Freespace FAQ. It's almost like asking me yourself.

[ Diaspora ] - [ Seeds Of Rebellion ] - [ Mind Games ]

 

Offline Flipside

  • əp!sd!l£
  • 212
Proper Documentation For All Commands / Changes Made?
Exactly, we start with just providing info, not tutorials, but we can link to other peoples tutorials, with their permission for more detailed info. Personally I'd like to see that change later, so we have a full 'Modding bible', but that would be a project for the future :D

Flipside :D

 

Offline redmenace

  • 211
Proper Documentation For All Commands / Changes Made?
Number one priority is to get a readme written. basically a referenece manual like Flipside said. What I am saying is immediatly we need a list of topic that need to be written about. Immediatly I think they should be written in word and then transferred to HTML later on.
Government is the great fiction through which everybody endeavors to live at the expense of everybody else.
              -Frederic Bastiat

 

Offline Fineus

  • ...But you *have* heard of me.
  • Administrator
  • 212
    • Hard Light Productions
Proper Documentation For All Commands / Changes Made?
Great guys! Thanks for going with me on this one - it'll be incredibly helpful in the long run :nod:

 

Offline Setekh

  • Jar of Clay
  • 215
    • Hard Light Productions
Proper Documentation For All Commands / Changes Made?
Whoops, missed this thread. :) Sounds quite reasonable (and in line with our goals) to me - I'll put it to the rest of the staff before making a final decision. :nod:
- 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 Flipside

  • əp!sd!l£
  • 212
Proper Documentation For All Commands / Changes Made?
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