OpenClonk Wiki - User contributions [en]

Controls

2012-04-24T20:30:25Z

Boni:

OpenClonk features all new controls and a new UI. Both have been and will be changed in the development process. This page serves to show the current controls and interaction methods.

=== The UI ===

==== Inventory ====
[[File:Inventory.png|thumb|upright=0.17|right]]
On the left side of the screen, you see your clonks inventory. It has several slots, of which 2 can be selected as active. Left-clicking maps the slot onto the left hand (left mouse button), right-clicking onto the right. You can see which one is mapped to which by the hand on the left/right side of the slot.

You can drag'n'drop to switch items around in the inventory. Dropping onto the landscape drops the item.

Selecting a slot that already is selected by the other hand, will switch them.

==== Crew ====
[[File:Crew.png|thumb|right]]
At the top left of the screen you see your crew. It gives info about each clonks health and breath, the latter only beeing shown when underwater.

Health-Changes like damage and healing are also displayed.

Clicking on a clonk will select him.

==== Actionbar ====
[[File:Actionbar.png|thumb|right]]
The actionbar is a row of buttons at the bottom screen. They appear and disappear dynamically depending on the situation. They display objects you can interact with at the moment.

Clicking on a button will cause the clonk to interact with that object.

==== Contents-Menu ====
[[File:Contentmenu.png|thumb|right]]
Shows the contents of the selected clonk and nearby crewmembers and containers/structures.

Every entitiy has its own ring. The rightmost clonk always is the currently controlled one. Leftclicking on an item moves it to the next ring to the right, rightclicking moves it to the next ring to the left. You can also directly drag'n'drop from one ring to another.
Some containers only allow certain items to be put in. The foundry doesn't accept firestones, for example.

=== Keys ===
All keys refer to the german keyboard layout.

==== Basic Keys ====
{| class="wikitable"
|-
! Key !! Action
|-
| Left/Right Mousebutton || Use item in left/right hand slot
|-
| W A S D || Movement, picking up if no action to perform (e.g. S while standing)
|-
| E || Contents menu. Used for moving items from/to Containers and Crewmember
|-
| 1 2 3 4 5 6 7 8 9 || Selects corresponding inventory slot into left hand (on key release)
|-
| Space || Interact/Grab with first item in Actionbar (on key-release), Ungrab
|-
| < Y X C V B N M , || Interact with the corresponding item in the Actionbar (leftmost = first)
|-
| F || Menu
|-
| Tab || Show Scoreboard
|}

==== Modifiers ====
{| class="wikitable"
|-
! Key !! Action
|-
| Shift || Drop
|-
| Alt || Right Hand
|-
| Space || Interact
|-
| Ctrl || Crew
|}

==== Combinations ====
The keys 1-9 are referred to as Num# here.

{| class="wikitable"
|-
! Key !! Action
|-
| Shift + Left/Right Mousebutton || Throw item in left/right hand slot
|-
| Shift + Num# || Drop item in corresponding inventory slot
|-
| Alt + Num# || Selects corresponding inventory slot into right hand
|-
| Space + Num# || Interact with the corresponding item in the Actionbar
|-
| Ctrl + Num# || Select corresponding Clonk
|-
| Num# + Left/Right Mousebutton || Selects corresponding inventory slot into left/right hand
|}

File:Crew.png

2012-04-24T20:29:43Z

Boni: uploaded a new version of "File:Crew.png": Updated to newest UI

UI: Crew selector

Controls

2012-03-30T19:00:55Z

Boni: Added pictures

OpenClonk features all new controls and a new UI. Both have been and will be changed in the development process. This page serves to show the current controls and interaction methods.

=== The UI ===

==== Inventory ====
[[File:Inventory.png|thumb|upright=0.17|right]]
On the left side of the screen, you see your clonks inventory. It has several slots, of which 2 can be selected as active. Left-clicking maps the slot onto the left hand (left mouse button), right-clicking onto the right. You can see which one is mapped to which by the hand on the left/right side of the slot.

You can drag'n'drop to switch items around in the inventory. Dropping onto the landscape drops the item.

Selecting a slot that already is selected by the other hand, will switch them.

==== Crew ====
[[File:Crew.png|thumb|right]]
At the top left of the screen you see your crew. It gives info about each clonks health and breath, the latter only beeing shown when underwater.

Clicking on a clonk will select him.

==== Actionbar ====
[[File:Actionbar.png|thumb|right]]
The actionbar is a row of buttons at the bottom screen. They appear and disappear dynamically depending on the situation. They display objects you can interact with at the moment.

Clicking on a button will cause the clonk to interact with that object.

==== Contents-Menu ====
[[File:Contentmenu.png|thumb|right]]
Shows the contents of the selected clonk and nearby crewmembers and containers/structures.

Every entitiy has its own ring. The rightmost clonk always is the currently controlled one. Leftclicking on an item moves it to the next ring to the right, rightclicking moves it to the next ring to the left. You can also directly drag'n'drop from one ring to another.
Some containers only allow certain items to be put in. The foundry doesn't accept firestones, for example.

=== Keys ===
All keys refer to the german keyboard layout.

==== Basic Keys ====
{| class="wikitable"
|-
! Key !! Action
|-
| Left/Right Mousebutton || Use item in left/right hand slot
|-
| W A S D || Movement, picking up if no action to perform (e.g. S while standing)
|-
| E || Contents menu. Used for moving items from/to Containers and Crewmember
|-
| 1 2 3 4 5 6 7 8 9 || Selects corresponding inventory slot into left hand (on key release)
|-
| Space || Interact/Grab with first item in Actionbar (on key-release), Ungrab
|-
| < Y X C V B N M , || Interact with the corresponding item in the Actionbar (leftmost = first)
|-
| F || Menu
|-
| Tab || Show Scoreboard
|}

==== Modifiers ====
{| class="wikitable"
|-
! Key !! Action
|-
| Shift || Drop
|-
| Alt || Right Hand
|-
| Space || Interact
|-
| Ctrl || Crew
|}

==== Combinations ====
The keys 1-9 are referred to as Num# here.

{| class="wikitable"
|-
! Key !! Action
|-
| Shift + Left/Right Mousebutton || Throw item in left/right hand slot
|-
| Shift + Num# || Drop item in corresponding inventory slot
|-
| Alt + Num# || Selects corresponding inventory slot into right hand
|-
| Space + Num# || Interact with the corresponding item in the Actionbar
|-
| Ctrl + Num# || Select corresponding Clonk
|-
| Num# + Left/Right Mousebutton || Selects corresponding inventory slot into left/right hand
|}

File:Inventory.png

2012-03-30T18:48:42Z

Boni: UI: Inventory

UI: Inventory

File:Crew.png

2012-03-30T18:48:30Z

Boni: UI: Crew selector

UI: Crew selector

File:Contentmenu.png

2012-03-30T18:48:12Z

Boni: UI: Content Menu

UI: Content Menu

File:Actionbar.png

2012-03-30T18:47:41Z

Boni: UI: Actionbar

UI: Actionbar

Controls

2012-03-30T18:46:27Z

Boni: First draft

OpenClonk features all new controls and a new UI. Both have been and will be changed in the development process. This page serves to show the current controls and interaction methods.

=== The UI ===

==== Inventory ====
On the left side of the screen, you see your clonks inventory. It has several slots, of which 2 can be selected as active. Left-clicking maps the slot onto the left hand (left mouse button), right-clicking onto the right. You can see which one is mapped to which by the hand on the left/right side of the slot.

You can drag'n'drop to switch items around in the inventory. Dropping onto the landscape drops the item.

Selecting a slot that already is selected by the other hand, will switch them.

==== Crew ====
At the top left of the screen you see your crew. It gives info about each clonks health and breath, the latter only beeing shown when underwater.

Clicking on a clonk will select him.

==== Actionbar ====
The actionbar is a row of buttons at the bottom screen. They appear and disappear dynamically depending on the situation. They display objects you can interact with at the moment.

Clicking on a button will cause the clonk to interact with that object.

==== Contents-Menu ====
Shows the contents of the selected clonk and nearby crewmembers and containers/structures.

Every entitiy has its own ring. The rightmost clonk always is the currently controlled one. Leftclicking on an item moves it to the next ring to the right, rightclicking moves it to the next ring to the left. You can also directly drag'n'drop from one ring to another.
Some containers only allow certain items to be put in. The foundry doesn't accept firestones, for example.

=== Keys ===
All keys refer to the german keyboard layout.

==== Basic Keys ====
{| class="wikitable"
|-
! Key !! Action
|-
| Left/Right Mousebutton || Use item in left/right hand slot
|-
| W A S D || Movement, picking up if no action to perform (e.g. S while standing)
|-
| E || Contents menu. Used for moving items from/to Containers and Crewmember
|-
| 1 2 3 4 5 6 7 8 9 || Selects corresponding inventory slot into left hand (on key release)
|-
| Space || Interact/Grab with first item in Actionbar (on key-release), Ungrab
|-
| < Y X C V B N M , || Interact with the corresponding item in the Actionbar (leftmost = first)
|-
| F || Menu
|-
| Tab || Show Scoreboard
|}

==== Modifiers ====
{| class="wikitable"
|-
! Key !! Action
|-
| Shift || Drop
|-
| Alt || Right Hand
|-
| Space || Interact
|-
| Ctrl || Crew
|}

==== Combinations ====
The keys 1-9 are referred to as Num# here.

{| class="wikitable"
|-
! Key !! Action
|-
| Shift + Left/Right Mousebutton || Throw item in left/right hand slot
|-
| Shift + Num# || Drop item in corresponding inventory slot
|-
| Alt + Num# || Selects corresponding inventory slot into right hand
|-
| Space + Num# || Interact with the corresponding item in the Actionbar
|-
| Ctrl + Num# || Select corresponding Clonk
|-
| Num# + Left/Right Mousebutton || Selects corresponding inventory slot into left/right hand
|}

Building with Windows

2011-10-16T14:19:06Z

Boni: Added some additional info to calm people who aren't familiar with cmake.

= Get the sources =

The source of OpenClonk is hold in a so-called version control system. Put simply, this is something that allows programmers to coordinate their work. For the moment, it's just a couple of files you want to download.

== Install TortoiseHg ==

The notable difference to a simple download is that you need a special program to do it. Our version control system is Mercurial, and we will use the [http://bitbucket.org/tortoisehg/stable/wiki/Home TortoiseHg] client. Follow that link and click "Download".

[[File:build_windows_thg2.png]]

We pick the most current version for Windows available, in this case version 0.8. Note there might be a newer version available when you visit the page.

[[File:build_windows_thg3.png]]

After the file has finished downloading and we have managed to get through all the warning boxes, we finally arrive in the installer. Nothing interesting to see here, just install it somewhere.

[[File:build_windows_thg4.png]]

I won't lie, I never restart my computer when I'm asked to. You might do so, but from what I know you only get a few colorful icons as a reward.

== Clone ==

Okay, now we are going to download the sources. Mercurial calls this "cloning" because it's actually a lot more than just the sources you get. We will later see what we can do with this extra stuff.

For now, just find a place where you want the source to be, open the context menu by right-click and select "Clone a repository" from the "TortoiseHg" menu:

[[File:build_windows_thg5.png]]

A dialog will appear asking for the source and destination paths. In our case, we want the source to be the OpenClonk repository. The URL you need is [http://hg.openclonk.org/ http://hg.openclonk.org/]". Put it into the "Source Path" field and click the "Clone" button:

[[File:build_windows_thg6.png]]

A log window will open and TortoiseHg will work for a while. Eventually, it should look like this:

[[File:build_windows_thg7.png]]

Congratulations, you now have the bleeding edge of OpenClonk development on your hard drive!

[[File:build_windows_thg8.png]]

At first glance, this a lot of stuff and most likely you won't understand much of it. The good news is that you don't need to pay attention to most of it. The interesting parts are:
* "docs" - the sources of the documentation you might know from the Clonk Homepage
* "planet" - game resources. If you have used Clonk's development mode, the contents will probably look familiar.
* "src" - the source code of the engine

= Get it to Compile =

This is nice, but we are interested in seeing the game run, aren't we? For this, we need a program that will take all those C++ files and make an executable file out of it. Unfortunately, programming is complicated stuff so even setting up the tools and the environment has become a bit of science. But this won't stop us.

== Get Microsoft Visual Studio ==

You can say what you want about Microsoft, but they sure make nice development environments. And they are even giving a lot of it away for free. We will use [http://www.microsoft.com/express/vc/#webInstall Visual Studio C++ 2008], but MSVC 2010 also works. Follow that link, select your language and select "Download".

[[File:build_windows_msvc1.png]]

The installer will offer us a lot of stuff we don't really need for OpenClonk. You should uncheck it to make the installation faster.

[[File:build_windows_msvc2.png]]

You will most likely stare at the following screen for a bit. It won't take that long, and for me didn't even restart the computer like it suggested it would.

[[File:build_windows_msvc3.png]]

== Get Dependencies ==

Like most big programs, OpenClonk doesn't stand on its own. Some things (like opening PNG images) were already programmed by other programers far better than we could ever do. This is why we have to get a few so-called "libraries" before Clonk can be built.

You could try to search and download all those libraries by hand, but that would be pretty boring. Instead, just download [http://www.openclonk.org/openclonk-deps-vc90.zip this package] that contains everything you need to build Clonk.

[[File:build_windows_deps.png]]

Unpack both directories into the same path you put all the other files. Don't worry, nothing will get overwritten in "planet".

== Get CMake ==

Before all this becomes useful, we still need something that tells the compiler ''how'' all those sources and libraries should be compiled together.

For this, Visual C++ needs a project file. But there is none - we have to consult ''another'' program to generate it for us. This might seem confusing - but the point is that there are a lot of build environments besides Visual Studio, and having all those project files next to each other would become a problem in the long run.

What we need is [http://www.cmake.org/cmake/resources/software.html#latest CMake]. Follow that link and download the installer:

[[File:build_windows_cmake1.png]]

You know what to do.

[[File:build_windows_cmake2.png]]

After the installation, start the CMake GUI from the start menu. Put the path you cloned the repository into the source code path field.

[[File:build_windows_cmake3.png]]

Now click the "Configure" button in the lower left. It will ask what compiler we want to use. Select the compiler you want to use, for example "Visual Studio 9 2008". Do ''not'' pick the Win64 option, as the precompiled libraries are 32 bit.

[[File:build_windows_cmake4.png]]

If you get some error messages (in red), you're probably missing some dependencies. Don't worry if cmake complains about some missing paths, it shouldn't affect you.

The last step is to click the "Generate" button.

== Your First Build ==

Okay, now we have everything needed to make OpenClonk run for the first time. Go into the source directory and double-click on the "openclonk.sln" file that should now have appeared:

[[File:build_windows_build1.png]]

Visual C++ should open and look similar to this:

[[File:build_windows_build2.png]]

We only want to build the engine, so select "clonk" from the list, right-click and select "Set as Start-Up project"

[[File:build_windows_build3.png]]

Now select "Build Solution" from the "Build" menu (or just press F7). No, I don't know what "solution" means. Drink a cup of coffee or two while you wait for the compiler to do its job.

Eventually, you will arrive at this screen and probably wonder who taught those coders the kind of shoddy practices that result in more then 600 warnings.

[[File:build_windows_build4.png]]

Nevertheless, you can now select "Start Debugging" from the "Debug" menu (or just press F5) and should be greeted by the startup screen of a fresh OpenClonk build!

[[File:Openclonk_first_start.jpg]]

In case you are wondering why OpenClonk suddenly starts in some kind of pseudo windowed mode: This is because we just built a debug build (note the "dbg" after the version?). This build is a bit slower but allows you to get a better look at the internals of the engine while it's running. Maybe we'll have another article about that soon.

= Enabling sound and DirectX =

So far, the version of OpenClonk you can compile runs with OpenGL only and without sound. Here is how to enable both DirectX and sound:

Download the latest [http://msdn.microsoft.com/en-us/directx/default.aspx DirectX SDK] from the Microsoft website and install it. For sound, download the [http://www.fmod.org/index.php/download#FMOD3ProgrammersAPI FMOD 3 Programmers API] and unpack it somewhere. Now, you need to copy api/fmod.dll into your planet/ directory, all the files that are in api/inc to planet/deps/include and api/lib/fmodvc.lib to planet/deps/lib.

Thats it. Now, you need to re-run CMake and check both USE_DIRECTX and USE_FMOD. Compiling the game with VC++ will now produce a build where you can hear the sound and use direct x.

File:Build windows build1.png

2011-10-16T14:14:16Z

Boni: uploaded a new version of "File:Build windows build1.png": Updated to in-tree build