Author Topic: Glest Manual Project  (Read 3639 times)

hailstone

  • GAE Team
  • Battle Machine
  • ********
  • Posts: 1,568
    • View Profile
Glest Manual Project
« on: 12 June 2008, 13:31:44 »
I think it would be good to make these manuals for Glest:
Glest Coding Manual - Information on compiling, style guidelines, naming conventions, programming tips, design tips, processes, code explanations and tools.
Glest Media Creation Manual - Modelling and Animation, textures, tilesets, other images and audio and video.
Glest Scripting Manual - XML files, Lua and Scenarios.
Glest User Manual - Tips about playing the game, installing and community.

Resources
Writing a Software Technical Reference Manual
Writing a User Manual

I would like to be in charge of the Glest Coding Manual. Daniel Santos sent me an email saying, "I want to get as much of the code within the "Effective C++" guidelines as possible". I have the book called "Effective C++ (third edition): 55 ways to improve your programs and designs" by Scott Meyers. I think this is the book he mentioned. I also have the book called "Industrial Strength C++" by Henricson and Nyquist.

Since there is already information on compiling I will move on to style guidelines and programming tips. As well as reading the books I will be looking at the existing style of the Glest code and probably websites I come across.

Each manual will be in pdf and html format. As always people are encouraged to contribute and provide feedback.

I hope to have a basic draft by the end of the month.
« Last Edit: 1 January 1970, 00:00:00 by hailstone »
Glest Advanced Engine - Admin/Programmer
https://sourceforge.net/projects/glestae/

wciow

  • Behemoth
  • *******
  • Posts: 968
    • View Profile
(No subject)
« Reply #1 on: 13 June 2008, 13:35:30 »
Good idea. I will try to help out if I get some time.
« Last Edit: 1 January 1970, 00:00:00 by wciow »
Check out my new Goblin faction - https://forum.megaglest.org/index.php?topic=9658.0

hailstone

  • GAE Team
  • Battle Machine
  • ********
  • Posts: 1,568
    • View Profile
(No subject)
« Reply #2 on: 29 June 2008, 11:27:14 »
Over the last couple of weeks I have made a very early draft of the Glest Coding Manual v0.1.3
« Last Edit: 1 January 1970, 00:00:00 by hailstone »
Glest Advanced Engine - Admin/Programmer
https://sourceforge.net/projects/glestae/

Jamesgamer

  • Guest
(No subject)
« Reply #3 on: 30 June 2008, 03:15:56 »
In my opinion, the only one of these that has to be very official is the User Manual. It would have the most impact in making Glest look 'official.' The rest would require much less work.

I WOULD like to contribute, though.
« Last Edit: 1 January 1970, 00:00:00 by Jamesgamer »

hailstone

  • GAE Team
  • Battle Machine
  • ********
  • Posts: 1,568
    • View Profile
(No subject)
« Reply #4 on: 30 June 2008, 11:24:29 »
What do you mean by official: professional appearence or made by the original Glest team? As long as they serve the purpose of instructing people how to use and develop for Glest I don't think it really matters.
« Last Edit: 1 January 1970, 00:00:00 by hailstone »
Glest Advanced Engine - Admin/Programmer
https://sourceforge.net/projects/glestae/

Omega

  • MegaGlest Team
  • Dragon
  • ********
  • Posts: 6,167
  • Professional bug writer
    • View Profile
    • Personal site
(No subject)
« Reply #5 on: 1 July 2008, 15:27:30 »
I wrote manuals for making xmls for all types of things (units, factions, resources, techtrees) where should I post them?
« Last Edit: 1 January 1970, 00:00:00 by omega »
Edit the MegaGlest wiki: http://docs.megaglest.org/

My personal projects: http://github.com/KatrinaHoffert

hailstone

  • GAE Team
  • Battle Machine
  • ********
  • Posts: 1,568
    • View Profile
(No subject)
« Reply #6 on: 4 July 2008, 13:40:17 »
You could add it to the wikia or upload it and post a link to it here. Then it might be made into the Glest Scripting Manual.

Thanks.
« Last Edit: 1 January 1970, 00:00:00 by hailstone »
Glest Advanced Engine - Admin/Programmer
https://sourceforge.net/projects/glestae/

 

anything