A Smart reference guide ?

[CH4NDL3R]

I was searching the web to see real good q3map2 manuals. I’ve found some excellent guides, but there were a bit outdated. I thought I could find an updated manual but days after days it was obvious that it was really difficult to keep any guide about Ydnar’s great tool updated I’ve even tried to make a manual by myself, but very soon I understood it was very difficult. You can have the link here, but I seriously doubt that someone can understand it

So I imagined a simple system working using PHP/SQL. A simple web site of only two pages, where on the first page you can search for a description of a switch/shader keyword/worldspawn key/… by using the embedded search tool. You can also on the second page, if you are correctly logged in, add/delete/modify existing descriptions, add a new q3map2 version, etc…

The main advantage of this is that it requires few time to update it. Simply add the new descriptions once the new q3map2 is out, and you are up-to-date

I think Ydnar can handle the update of the website alone, because he perfectly knows the behaviour of the new switches.
The first times it will be long to manually enter data into the database, and I will be ready to gave him a hand, and I’m sure some of you are ready too

Now, the bad point. I have simply no sufficient spare time and knowledge in php/sql to develop and release this ‘smart’ reference guide. So I give you the idea and perhaps if you like it you’ll develop it, you or some friends of yours
I am sure that if we keep it simple, in one week we can have a workable website.

I’ve wrote a text describing the website, here it is :

Q3MAP2 REFERENCE GUIDE

PHP/SQL Website, 2 parts

Part 1 : Public Access

Visualization of all entries (switches, surfaceparm, shader keywords…)

.Search/Filter system

-Search : Text Field

-Version Number : List of choices (i can’t remember the ‘formal’ name)
+version number filter : list of choices
-+before
-+after
-+equal

-Entry type : checkboxes
+BSP switches
+VIS switches
+LIGHT switches
+surfaceparms
+shaderkeywords
+worldspawn keys

-game supported : List of Choices (currently searching a better implementation for games list)

-“Search” Button

.Search Results System

Show searched entrie(s) :

-Version number
-Games Supported
-Entry description

.“Blah!1” System

Current Q3Map2 Version is :
Number of entries :
Last Updated on :

Part 2 : Restricted Access

Add/Modify/Delete Entries

.login System

htaccess to log in, or php/sql system
only one access for everybody (no access levels)

.Add System

+Adding a version
Version number
Date
Changelog (optionnal ? - Not sure about the usefulness)
“Add” button

+Adding a game
Game name
Website
“Add” Button

+Adding an entry
Version number : list of choice
Entry type : list of choice
Game(s) supported : list of multiple choices
Entry Description : Text Field
“Add” Button

There is a possibility to insert images by using HTML (image hosting possible with ftp account)

.Edit System

Search the entry to edit from search tool and filters
Select one entry from the results and we get the same “Adding an entry” subsystem filled with previous data

.Delete System

Search the entry to edit from search tool and filters
Select one entry from the results and there is a dialog asking you to confirm delete.

That’s all
I sincerely hope that someone can achieve the work, as it seems to be clear that we absolutely need an up-to-date reference manual

[HairyPlums]

If someone want’s to develop this great idea, I’d be willing to host the PHP & MySQL stuff. I know a fair bit of PHP/MySQL myself, but no time to develop this…PM me or talk more to CH4NDL3R to expand his ideas.

[michi.be]

try this:
http://shaderlab.com/q3map2/shader_manual/

[CH4NDL3R]

Nice work, Obsidian
The problem with an updated shader manual is that it doesn’t mention compilation switches at all.
But i suppose this is not the purpose of the q3map2 shader manual to tell about switches. i’ll try to talk to Obsidian about it.

[_skOre]

http://www.quake3world.com/ubb/Forum6/HTML/027126.html?

[obsidian]

There’s also a Q3Map2 Compiler Reference Card by Eraser, dealing with all the compile switches.
http://www.xs4all.nl/~lamanj/webstuff/files/reference.html

The entities.def file (the one that ships with the latest version of GtkRadiant) has also been updated by ydnar fairly recently. You can open it up in Notepad to read or just read it from the Entity Inspector.

[ratty_redemption]

@obsidian, Ive been reading a lot of your version of the shader manual, last couple of days, and its very helpful, not only cus its more up to date, but its clearer and easier to understand… please keep up the excellent work

and where would a good thread be, for asking clarification on the shader commands, or should we just post them in any thread we`re participating in, within reason?

perhaps there could be a sticky thread for your manual?

[Hybridesque]

I’ve been working on some Q3Map2 Tutorials, still far from complete but I’ve been adding sections as soon as I complete them.

http://www.ut-mapdepot.com/tutorials/index.php

I would greatly appreciate some assistance on this… the list of topics to cover is massive.

Hybridesque.

[obsidian]

Hmmm… a sticky thread would be nice, but that would be up to the mods here. As a mod at Q3W LEM, we’re trying to limit the number of sticky threads that we have, so I don’t want to add another one there.

For the time being, either post comments/suggestions in this thread:
http://www.quake3world.com/ubb/Forum6/HTML/027126.html?

or e-mail me:
obsidianlordz [at] hotmail [dot] com

For those of you who map for any non-Quake III Arena type games, RTCW, ET, JKII, JA, STEF, etc. I need your participation in helping me write Chapter 7 Quake 3 Engine Game Specific Shader Keywords. Just a list of game specific shader keywords and what they do.

[ratty_redemption]

I actually ment, if were not sure how to use certain shader commands which thread in this forum should we ask in? ....rather then report errors in your manual, but its good to know how we can report those if found.

[obsidian]

In that case…

just post them in any thread we`re participating in, within reason

.

Either Quake3World.com Level Editing and Modeling forum or here on the Q3Map2 Support forum. I check both, though I post more at Q3W - over here I mostly lurk in the shadows.

Certainly, if there’s anything that you need more clarification on, I’m interested - because it means that I probably need to go into more detail on the subject.

[ratty_redemption]

great, thanx a lot