Integration of Xnfo
Process to use Xnfo in a party
09/02/2003
0.01
Sanx
Initialisation
Subject
This document is here to illustrate possible use of Xnfo and Xnfo examples tools,
it can be seen as a user manual. But as Xnfo is only a data model, feel free
to use Xnfo the way you want.
Disclamer
(note that all is currently draft, and not fully working at this time)
These scenarios are under work and helps writing the specification
How do I integrate Xnfo in my software ?
Demoparty Organizer
How do I use Xnfo in my Launcher ?
To integrate it, you should use an already existing XML parser. Here is a selection.
MSXML : Microsoft XML parser, used in Internet Explorer, should be the fastest parser, but you should be a COM Hacker, or just forget about it :
on msdn.
libxml : You can get another XML parser, you can get here :
http://xmlsoft.org/.
How do I integrate Xnfo to my party Website ?
You can start from scratch, or use already existing code.
Php : A php editor have is available
online, you can set a configuration ($xnfo_config) to only make appear what you want people to edit. And you can add a simple check function to check the fields have been well filled. Just download the source code.
ASP.NET : C# library can be integrated with in an ASP.NET website, it's really easy to integrate because of the .NET component model. But there is no ready-to-use webpage for the moment.
How do I create/edit my Xnfo ?
Online : The safe and easy way to create it, you don't have to know a thing about XML. And follow the instructions given on the page.
With a notepad : If you want you've got the Quick Guide.
Present
Demoparty Organizer
You have several means to use Xnfo in your party, it depends on what you already have, and what you are ready to do for yourself. This method can stand as a basis, propose anything you think usefull.
Integrate into entry system
Transparent : Make it transparent for users (people that will release productions), it can be easy, make a web submitter like there is in most parties. Just had a generated Xnfo file near the release and/or add it into the archive. Adding Xnfo output is just a quick modification of the Online editor.
In the first days of Xnfo it may be a good choice. Just oblige people to give the right information on submission, plus ask them to insert competition specific elements with strict filename (steps, wireframe, cover, screenshots, ...).
Advanced : You think people can write their own xnfo files, and can do valid releases. Put only the Standard online editor on the web site.
Let them upload it to an FTP, or submit it with their web browser.
Check productions
You should run a xnfo-validator on any uploaded release to check if the archive is valid (see xnfo-validator).
Read the compo/"message to orgas" (with your hands for the moment) and see what you can do.
Test it, for that use the Launcher on the compo machine, and run the productions demos, if rejected this report the reason to the scener. For that refer to compo/"message to orgas" tag.
Show party productions
Put all validated releases in a directory.
Use your own launcher full of amazing effects (this is very good :)) or use the example tool : Xnfo Launcher. Don't forget to check that all releases submitted are in your playlist.
Replay productions
During the party, people missing (or not) the competition would be happy to see entries again. It's a cool way to show again graphics or demos (only showing screenshots) for people to remember titles of entries, and do a good vote.
Use your launcher (or example Xnfo Launcher) to do that, use Replay Mode.
Create results
You can write results doing an output of your vote system. It should be the best way to do it (see results in the specification).
You can write it using your little hands ;) (this is not great, we will soon see for a result editor that is parsing directories, and showing you a table that you can fill with the correct information (points/rank), and output as a .results.xnfo file)
Present results
Use your launcher (show the, say, ten first prods, and show the top 3 progressively) for more details of what can be done, read the specification, at the results chapter.
In an other way you can look at the Xnfo Launcher specification to see what scenarios have been chosen.
You can also use the Xnfo Launcher in the Results play mode.
Upload demos on scene.org
You should modify xnfo files in any archive and add the release tag with the correct inscription (party name, url, date, and rank). (for the moment no tool has been done for that but it may be a feature of the results editor)
You must have classed every compo, in a scene.org compliant directory tree. It is suggested to add .xnfo in and out of the archives.
Demoscener
Create Xnfos : have a look at the Quick Guide, it presents quickly the most important information to add.
Check your release : use the Xnfo Validator to check that the xnfo il well written, and later add it to your archive and check again the archive (only zip archives are supported).