Pages: [1]
Author Topic: OpenArena Game Manual  (Read 7290 times)

Cakes 18
Posts: 375

This space intentionally left blank.

« on: November 26, 2008, 08:54:27 AM »

I'm thinking that it would be good to have a manual that comes with the game. I would like to have a go at helping to develop it, considering the slow progress of the manual on the wiki.

The manual I want to make would be a .pdf or .doc or .html document (or whatever) with images that is installed along with the game, and probably copied to the wiki. I don't know everything, so other contributors can supply chunks of information and I will proofread/edit, compile it and fill in the rest.

I've taken a few ideas from the wiki already and come up with a general layout for the manual:
Welcome message / introduction
  • License

System Requirements

Program Installation and Executon
  • Windows
  • Linux
  • Mac
  • Legacy Version

User Interface
  • Game Menus
  • Head-up Display

The Basics
  • Game Types
  • Movement
  • Weapons
  • Item Pick-ups
  • Map Objects and Events
  • Medals
  • Bots

Setup and Configuration
  • Player Setup
  • System
  • Controls
  • Game Options

Single Player Campaign

  • Starting or Joining a LAN Game
  • Joining an Online Game (+ info on favourites list)
  • Filters

Game Strategies and Tactics
  • Strategies and Tactics
  • Advanced Movement

Advanced Features
  • Console Commands
  • Performance Tweaks
  • Running a Dedicated Server

FAQ / Troubleshooting

It's not a comprehensive list - especially the last few categories - but I plan to start near the top and work down through each topic that way. I also think each topic should have its own introduction.

I can post updates here periodically for feedback and scrutiny and with any luck it'll get done efficiently Smiley

fromhell, just say the word and I'll get started on it.


Cakes 0
Posts: 58

« Reply #1 on: December 09, 2008, 04:35:23 PM »

Why dont do this in the wiki? so that it can evolve more freely.
The manual from the wiki could later be exported to a pdf if it gets to a mature state.

It was the original idea of this: (DO NOT LINK) h t t p s : / / openarena . wikia . com/wiki/Manual/Print_version

sorry for my english

Cakes 18
Posts: 375

This space intentionally left blank.

« Reply #2 on: December 10, 2008, 02:30:26 AM »

I don't like the wiki for a few reasons. Also, many of the pages on that thing haven't been touched in ages. Whether I put my stuff on the wiki, or create a manual independently, I feel I would still be doing about the same amount of work in most parts. So I'd rather do it in the way I find easiest Wink

I've actually started working on the manual already. It is in HTML format. (I've attached it to this post if anyone wants to take a look. Feedback is greatly appreciated). Only a few pages are written so far, but more are already in the works.

Even if the manual is not accepted for whatever reason, somebody would be able to at least salvage the text and add it to the wiki anyway.


Cakes 1
Posts: 63

« Reply #3 on: December 10, 2008, 09:33:33 AM »

it looks like a good start, and you have alot of work ahead of you.  As I said before I can answer pretty much any of your technical questions.  Just let me know, you can pm me anytime with a question and i'll do my best to get an answer to you by the end of that day.

Looks Good so far.

*should add a porting demos to avidemo
and a config howto in there as well i think.

Cakes 24
Posts: 584

« Reply #4 on: December 11, 2008, 02:38:07 AM »

Would be nice if the HTML could work at various screen widths, I'm personally stuck with 800x600.
Pages: [1]
Jump to: