Welcome to clientdev. I feel safe in saying such because this document is really only useful if you are a member of said group. Now available to members of clientdev is the ability to "register" a client. I thought it might be good to have a database of available clients, and hot damn, we've got ourselves a database right here.

Why would I want to register my client? Two reasons. First off, you'd want to because it gives your client notability. Other members of clientdev should be able to see what is going on with your client, and have the URL, etc. This will allow us to coordinate efforts a little better.

Also, along with the benefit of that is automatic version control. The information you provide with your client is exported through Client Version XML Ticker. This means you can push out updates to your client through E2's resources.. redirect them to the download site or homepage for an update on the client, esp if you keep up with your client versioning, like you should. This makes sense for people to use, as it would be easy to prompt users to update their clients.

What types of clients should register? Basically, clients that you plan on releasing to the public in any sort of way. Mostly binary clients, and clients that you release to the public, although you should feel free to add yourself to the list for any project you are working on. The major help is the export feature, which is important to keep in sync with the ever-shifting sands of E2.

How do I register? On the clientdev usergroup node, if you fill out a name, and click create, it should work fine, then please edit your details when you have then available.

Can I unregister? If you do not plan on updating your client, or if you don't ever get a project to unregister, please message an admin, and we'll wipe your client project from the registry.

What if I have more than one port of my client? If you have a port of a client to a different system, please register a different "e2client" entry for each port. This will allow you to manage versions independantly of each other, or have separate maintainers, etc.

How do the URLs work? They are offsite URLs (or onsite, up to you). The homepage directs the user to a homepage for the url (could be a node or what not, up to you, but please give the full URL), and the download link is the direct web link to a file. You do not have to provide one, but it is for convenience for your client to go and get one (and to show people where all your hard work is located).

What is my client id? The client id is a unique string that you can refer to each client. I'd suggest using a string.platformname (such as juicyclient.win32) but you can use whatever you'd like. It has to be unique and under 255 characters, so you have plenty of leeway. I'd suggest against using a version number, but it's entirely up to you.

How to I change my client's information? If you are the maintainer of the object, then there will be a small edit link for you to change the details.



Hope all of this helps. If any of you have any questions, feel free to message or email a member of the administration. Thanks

--jb