aboutsummaryrefslogtreecommitdiffstats
path: root/README.txt
blob: 579c82ec9e398947b26e2a62e34956372b5b622d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ->8 - -
                   _______  _________
            ___   /       \/         \_______
           /   \  \      _/    /\____/       \__________
          /   _/  /     / \______             \         \___    _____
         /   |___/      \     \_/             /          \  \  /     \
         \              /\                   /   |\       \  \/      /
          \            /  \_ultrastardeluxe_/    |/       /         /
           \______www_/                 |____________org_/          \
                                                      /      /\  ~=~ \
                                                      \_____/  \ mog /
                                                                 ~=~
- - 8<- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ultrastar Deluxe 1.0 Readme.txt
----------------------------
  ============================
 = 1. Authors                 =
 = 2. Release Notes           =
 = 3. Command-Line Parameters =
 = 4. Controls                =
 = 5. License                 =
  ============================

SF.Net Page: http://sourceforge.net/projects/ultrastardx/

This is just a little introduction, for more information open documentation.pdf

 ==============
 = 1. Authors =
 ==============
This game was introduced by Corvus5 who has written most of the code by himself.
Basing on the official release 0.5.0 Mota and Whiteshark started to write little
patches and modifications, and released this package named ultra-star.dl.am Mod.
This modification was continued at Sourceforge.net by the Ultrastar Deluxe Team:

~=[ DevTeam 1.1 - Harakirioke ]=~     
    Tobi
    Mischi
    Mog
    Whiteshark
  
~=[ Retired project developers / admins ]=~
    Alex
    Blindy  
    fifth
    Jay
    Mota
    Sawyer

~=[ Thanks ]=~
    Corvus5
    Songmakers
    CC People <3
    Translators
    
And this piece of software is the Result!


 ====================
 = 2. Release Notes =
 ====================
- To change the path to the song directory add to config.ini:
  [Path]
  Songs=[SongFolder] (e.g. C:\Program Files\Ultrastar\Songs)

- To take a screenshot press "PrintScreen" Key
  Screenshots are saved in the directory "Screenshots".

- To enable joypad support change config.ini:

  [Controller]
  Joypad=Off

  to

  [Controller]
  Joypad=On

- To Enable 4 to 6 Playermode 2 Screens are needed.
  Disable the fullscreen mode, extend your desktop horizontaly, set the
  resolution to fill one screen. 
  Add to Config.ini:
  [Graphics]
  Screens=2

- Press Alt + F[1..12] in NameScreen to Save a Playername
  Press F[1..12] to Load a Playername

- To enable benchmark run the game with -benchmark parameter


 ==============================
 = 3. Command-Line Parameters =
 ==============================
Command-Line Parameters are passed to the game adding it to the Path of a
Shortcut or starting the game within the console.

The following parameters are possible. They can be joined in any possible way.

- Benchmark         : Create a benchmark.log file with start timings.

- NoLog    	        : Do not create any .log files

- Joypad            : Start with Joypad support

- Language [ID]     : Load Language [ID] on startup.
                      Example: -Language german

- Songpath [Path]   : Some as config Songpath.
                      Example: -SongPath "C:\Ultrastar Songs"

- ConfigFile [File] : Load Configfile [File] instead of config.ini. 
                      Path to the file have to exist.
                      Example: -ConfigFile config.SongCreation.ini

- ScoreFile [File]  : Use [File] instead of Ultrastar.db
                      Path to the file have to exist.
                      Example: -ScoreFile HouseParty.db

- FullScreen        : Start the game in Fullscreen Mode

- Depth [16/32]     : Force Depth 16 or 32. Example: -Depth 16

- Resolution [ID]   : Force resolution. Example: -Resolution 800x600

- Screens [1/2]     : Force 1 or 2 Screen Mode. Example: -Screens 2

Some Examples:

Start with Resolution 1024x768 32 Bit Depth and Fullscreen:
ultrastar.exe -Resolution 1024x768 -Depth 32 -Fullscreen

Start without logging and polish Language
ultrastar.exe -NoLog -Language german

Start with custom config File and Score DB:
ultrastar.exe -ConfigFile C:\Ultrastar\Configs\PartyConfig.ini -ScoreFile C:\Ultrastar\Scores\PartyScores.db


 ===============
 = 4. Controls =
 ===============
[J]      to open the "Search for a Song" Interface
[Cursor] to navigate through the screens.
[Enter]  to confirm 
[Escape] to go to the previous screen.

In Songscreen
[R],
  [Shift] + [R],
  [Strg]  + [R]            select a random song/category
[Alt] + [Letter]           jump to a artist with the first letter [Letter]
[Alt] + [Shift] + [Letter] jump to a title with the first letter [Letter]


Editor Controls are described in documentation.pdf


 ==============
 = 5. License =
 ==============
Ultrastar Deluxe is licensed under the terms of the GNU General Public License 2.0
See License.txt for more Information.