= CortUI =

== What is CortUI? ==

[[Image(/site/screenshot_Map2Small.png, align=right, link=http://cortui.rtsquad.org/site/screenshot_Map2.png)]]

It is two things, actually. It started out as a modification of the heads-up display (HUD) for the game [http://www.freeallegiance.org/ Allegiance]. Over time, this was extended to some more modifications, e.g. for the game lobby, the in-game map and the menus. Other players contributed more HUDs later on, and therefore CortUI now usually refers to the installer package and the non-HUD modifications. To reflect this change, the original HUD modification was renamed to '[HudCortuiClassic CortUI classic]'.

== More information ==

[wiki:Features Features] lists all the changes CortUI applies to your Allegiance game experience.

[wiki:Screenshots Screenshots] shows you what CortUI and all the HUDs look like.

[wiki:DownloadAndInstallation Download and installation] tells you how to download and install CortUI.

[wiki:Internals Internals] documents how CortUI does what it does.

== How to contribute ==

[[Image(/site/screenshot_LobbySmall.png, align=right, link=http://cortui.rtsquad.org/site/screenshot_Lobby.png)]]

You're very welcome to improve the documentation of CortUI by editing this wiki, even if it's just correcting a typo or spelling mistake.

If you find a bug in CortUI or any HUD, you may open a new ticket on this page. Please make sure to [/search search] for it first, to avoid creating duplicate tickets. Your bug report should always contain the essential Three Things, as for example outlined in Joel Spolsky's excellent article [http://www.joelonsoftware.com/articles/fog0000000029.html Painless Bug Tracking]:

 1. '''Steps to reproduce''',
 1. '''What you expected to see''', and
 1. '''What you saw instead'''.

You may (and should) also create a new ticket to suggest a feature you would like to see added. Additionally, do not hesitate to open a ticket for requesting improved documentation on anything!

When creating new tickets, please leave all fields empty that you don't understand or are not sure what to select. I will add them in later. In particular, leave the component on ''[untriaged]'' and the milestone empty if you're not absolutely sure where it belongs. That way, the ticket query function can be used properly.

Note that the list of tickets is everything that is being worked on. Please do not PM me to report a bug. These tickets are exactly what I have on my list. If it is not here, I do not know about it. Whatever is marked as ''accepted'' is currently in the process of being implemented.

To modify the wiki or create/modify tickets, you will need to create an account by clicking ''Register''. That should be low friction though, you don't even have to enter an e-mail address, although you won't get notifications then when tickets change you are involved in.

Currently, no new HUDs are accepted, but that is definitely planned for the 2.x release branch. If you have created a HUD that you would like to see added to the CortUI installer, please create a new ticket and set the milestone to [milestone:2.0 2.0]. Please describe what your HUD does and also attach or link to some screenshots.

== Contributors ==

Based on Ksero's HUD modification, making use of his excellent documentation of the .mdl files.

Original logo design by Newtype, logo modifications by Sp4wn, favicon by Loriana.

HUD contributions by Parcival, Raveen and !FlingPu.

Special thanks to all testers who have reported bugs.

== How to use Trac ==

 * TracGuide --  Built-in Documentation
 * [http://trac.edgewall.org/ The Trac project] -- Trac Open Source Project
 * [http://trac.edgewall.org/wiki/TracFaq Trac FAQ] -- Frequently Asked Questions
 * TracSupport --  Trac Support