UltraStar Deluxe development

development:c_header_conversion

Sun, 18 Jan 2009 10:57:12 -0700

UltraStar Deluxe uses a lot of external libraries. Most of them are written in C. To use such libraries in a Pascal program you have to get Pascal headers for them. 1. Search for existing headers 1.1 FPC headers FPC comes with a huge collection of headers for standard libs like zlib or libpng.

development:coding_guidelines

Sun, 22 Feb 2009 05:03:17 -0700

WORK IN PROGRESS All names should be PascalCase (also known as UpperCamelCase). That means that all identifier should start with a capital letter. Additionally, the first letter of each word or any acronym that is embeded in the identifier should also be capital. Words should not be separated by underscores.

development:coding_guidelines_examples

Tue, 26 Aug 2008 10:29:52 -0700

// CORRECT { TMyObject.MyMethod This routine allows you to execute code. } procedure TMyObject.MyMethod; begin end; // INCORRECT procedure TMyObject.MyMethod; {****************************************************** TMyObject.MyMethod This routine allows you to execute code. *******************************************************} begin end;

development:compile

Sat, 10 Apr 2010 05:03:50 -0700

Building UltraStar Deluxe From Scratch This page will help you to build UltraStar Deluxe from scratch, and give you all the information that is needed to do that without flaws. If you still encounter any problem don't hesitate to post that problem to our board. We will try to help you there and also add solutions here.

development:config

Mon, 29 Dec 2008 11:04:02 -0700

:!: Bold marked settings are standard Game settings Players = 1,2,3,4,6 Amount of players Difficulty = Easy, Medium, Hard Difficulty setting for the sing screen Language = English, other available translations Language that is used in UltraStar Deluxe Tabs = Off, On Song folders Sorting = Edition, Genre, Language, Folder, Title, Artist, Title2, Artist2 Sorting of songs Debug = On, Off Debug output Graphic settings

development:development_guide

Sun, 13 Jun 2010 05:09:57 -0700

If you want to participate in UltraStar Deluxe development, here are some resources that might help you. Application specific * Code organization * Coding styleguide ( Beginner task ) * Platform compatibility issues * Menus General coding * Using external libraries * Makefile * Pascal tips

development:devmain

Wed, 27 Aug 2008 06:41:20 -0700

Folder structure For the upcoming 1.1 it's planned to tidy up the folder structure of the svn, as some sort of playground we use this wiki page to edit / add ideas. A ticket for this task can be found here: Ticket #19 New structure proposal (trunk) This is just an example how we could design the folder structure in the future. I am not really satisfied with this at the moment, so feel to add comments, change the structure or add your own proposal. The build directory is present in many dis…

development:how_to_compile_installer_using_nsis

Sun, 18 Jan 2009 10:57:12 -0700

1. The Tool 1.1 NSIS Download NSIS2, which is freely available at: 2. Fetch the source See Compile USDX using Delphi for more details. 3. DLLs and more To compile USDX Installer you'll need some DLLs, and the visualization presets for projectM.

development:how_to_compile_usdx_using_delphi

Sat, 16 Jan 2010 07:17:47 -0700

You will only need this tutorial when either no package for your system is available or you want to set up everything so you can easily follow the progress that is made by the developers. So this page documents the whole process how to compile the source from scratch, means we start by obtaining the source and end up with a with not configured but working UltraStar Deluxe.

development:how_to_compile_usdx_using_lazarus

Tue, 13 Apr 2010 02:13:01 -0700

development:how_to_compile_usdx_using_the_makefile

Fri, 29 May 2009 04:44:47 -0700

development:how_to_compile_usdx_using_the_makefile_on_mac_os_x

Thu, 17 Jun 2010 11:27:13 -0700

The status now (summer 2010) is that you have to install the FreePascal compiler and a number of libraries and download the sources of UltraStar Deluxe with svn. After this you can build the double-clickable application with some terminal commands.

development:how_to_compile_usdx_using_the_makefile_quick

Wed, 13 Jan 2010 01:52:24 -0700

You want to play? Right now? Don't have time to read the instructions? Then this one is for you! 1. The necessary packages Open a shell, and fetch the packages with apt. If you have the AMD64 version of ubuntu you'll probably get an error on the fp-units-i386. But as it turns out, you don't need it

development:how_to_compile_usdx_using_xcode

Sun, 22 Feb 2009 03:04:26 -0700

:!: Please note that the XCode project files are broken at the moment. This is due to some changes in the source files and the folder layout since the XCode project was updated the last time. If you are interested in fixing the project-files (or finishing this wiki-page) we would really appreciate this. You may join our IRC channel for support on the USDX internals and consult our Mac OS X developers mischi on Mac OS X specific problems. The working alternative is building USDX with Makefile and…

development:internationalization

Mon, 10 Nov 2008 05:30:22 -0700

Pascal string types FPC and Delphi support several string types: ShortString, AnsiString, WideString, PAnsiChar, PWideChar, Utf8String and UnicodeString. See for a comparison of the types. In short:

development:irc

Tue, 26 Aug 2008 10:35:28 -0700

UltraStar Deluxe has an #ultrastardx chat channel at QuakeNet. Feel free to join at * Server: irc.quakenet.org * Port: 6667 * Channel: #ultrastardx Client People without an wp>IRC Client available, can use the web interface at :

development:makefile

Sun, 18 Jan 2009 10:57:13 -0700

TODO: Some info about our Makefile ... 1. Notes on Make * see Recursive Make Considered Harmful () * use := and ?= instead of = * make sure that the Makefile works with multiple jobs (-jn) * FreeBSD users have to use gmake instead of make * delete rst-files (created by FPC containing resource-strings for localization -> po-files)

development:menus

Sat, 29 Nov 2008 10:16:41 -0700

Menus The menus are structured as screen with widgets. The code for screens goes into separate Files named src/screens/UScreenScreenName.pas and as theme in src/base/UThemes.pas. The screens are classes declared as TScreenScreenName = class(TMenu) and the elements of the screen are added in the Create constructor of the screen class. The events are defined in the function TScreenScreenName.ParseInput.

development:pascal_tips

Tue, 29 Dec 2009 03:15:55 -0700

Classes and Objects Constructors/Destructors * Constructoren als auch Destructoren sollten “inherited” aufrufen. Ansonsten wird ein geerbter constructor/destructor nicht aufgerufen, wenn er in einer Unterklasse überschrieben wurde. In C oder Java ist dies jedoch der Fall. Falls die Klasse direkt von TObjekt abgeleitet ist, ist dies nicht unbedingt nötig, man sollte jedoch trotzdem inherited aufrufen, für den Fall das sich die Oberklasse von TObject in eine andere Klasse ändert (dabei wird…

development:pitch_detection

Sun, 18 Jan 2009 10:57:14 -0700

Pitch detection Vocal ranges The human vocal range is approx. between C2 (65.4064Hz) and A5 (880.000Hz) (See ). Resources on notes and vocal ranges: * *

development:pitch_shifting

Wed, 18 Feb 2009 15:30:01 -0700

By the same authors of the ADRess voice removal algorithm, here is an interesting paper about real-time pitch scale modification which could be useful in the game : * Paper : * Demo (bottom of the page) :

development:platform_compatibility

Sun, 15 Feb 2009 04:23:07 -0700

UltraStar Deluxe has been ported to several platforms by now. It runs on Windows, Linux, FreeBSD, Mac OS X and maybe others. In addition several CPUs are supported such as x86, x86_64 and PPC. To maintain compatibility with those platforms keep the following issues in mind:

development:polish_translation

Sun, 22 Feb 2009 05:12:25 -0700

Polish translation Most Polish comments have been removed. Places still in need of translation: Translation needed The following translators have proved to be helpful: * PolTran * Pons * InterTran * SysTran Some frequently used Polish words in Ultrastar:

development:releases

Sun, 13 Jun 2010 05:29:03 -0700

For stable releases the trunk should be copied to a branch folder. For alpha, beta or RC previews the trunk should be copied to a tags folder instead. Create a source distribution: * Checkout a clean working copy of the branch or tags folder * Note: Do not use sourceforge's “Download GNU tarball” function as it ignores svn:executable SVN properties. Hence configure or other shell scripts won't be executable on linux.

development:synchronization

Sun, 18 Jan 2009 10:57:15 -0700

Synchronization As the timers of the lyrics, audio and video do not share a common clock they will drift apart from each other. Depending on the client's hardware/software configuration (CPU, OS, used media libs, played media files, ...) this might either happen slowly or fast. In some cases it is not noticeable during the short play period of about 3 minutes of an average song. But in many cases it is, e.g. in form of a lip sync problems (audio <-> video sync) or the lyrics not matching the cu…

development:themes

Tue, 26 Aug 2008 10:36:07 -0700

Some info for people who want to do their own skins and themes.. Select Slide This is used in the Options, Party and the Song Select (Jump To.. - Dialog) screens. It consists of two elements, the description in the left and the selectable content in the right.

development:translation

Tue, 14 Apr 2009 05:37:47 -0700

We are always keen to see how much UltraStar Deluxe spreads all over the world, with users from all over the world it's also important to speak their languages too. To achieve this we need your help, so if there is no file available for your language yet just take the English one (or any other that is finished) and start to translate it. Don't worry about the length, if you don't want to do the whole translation, then just do as much as you can - hopefully someone else might pick it up and finis…

development:translation_needed

Sun, 22 Feb 2009 04:06:45 -0700

File, linenumber, copy

development:usdx_on_snow_leopard

Sat, 10 Apr 2010 05:01:47 -0700

UltraStarDeluxe on Snow Leopard (Mac OS X 10.6) The last problem is that portaudio2 does not build with fink on 10.6. There is a workaround, but it takes too much hackery to give it to the public. Mischi. gfavato: I solved the problem opening itunes and letting it open while using UltraStar DX. Someone else get results with this solution?

development:voice_removal

Wed, 18 Feb 2009 16:32:22 -0700

General information Voice removal techniques should be able to remove the voice of singers in songs played by UltraStar Deluxe. There is no silver-bullet solution for this task yet, so I've compiled a list of interesting references on the subject.