111 lines
3.1 KiB
ReStructuredText
111 lines
3.1 KiB
ReStructuredText
.. _doc_configuring_an_ide:
|
|
|
|
Configuring an IDE
|
|
==================
|
|
|
|
We assume that you already `cloned <https://github.com/godotengine/godot>`_
|
|
and :ref:`compiled <toc-compiling>` Godot.
|
|
|
|
Kdevelop
|
|
--------
|
|
|
|
It is a free, open source IDE (Integrated Development Environment)
|
|
for Linux, Solaris, FreeBSD, Mac OS X and other Unix flavors.
|
|
|
|
You can find a video tutorial `here <https://www.youtube.com/watch?v=yNVoWQi9TJA>`_.
|
|
Or you may follow this text version tutorial.
|
|
|
|
Start by opening Kdevelop and choosing "open project".
|
|
|
|
.. image:: /img/kdevelop_newproject.png
|
|
|
|
Choose the directory where you cloned Godot.
|
|
|
|
.. image:: /img/kdevelop_openproject.png
|
|
|
|
For the build system, choose "custom build system".
|
|
|
|
.. image:: /img/kdevelop_custombuild.png
|
|
|
|
Now that the project has been imported, open the project configuration.
|
|
|
|
.. image:: /img/kdevelop_openconfig.png
|
|
|
|
Add the following includes/imports:
|
|
|
|
::
|
|
|
|
. // a dot to indicate the root of the Godot project
|
|
core/
|
|
core/os/
|
|
core/math/
|
|
tools/
|
|
drivers/
|
|
platform/x11/ // make that platform/osx/ is you're using OS X
|
|
|
|
.. image:: /img/kdevelop_addincludes.png
|
|
|
|
Apply the changes then switch to the "Custom Buildsystem" tab.
|
|
Leave the build directory blank. Enable build tools and add ``scons``
|
|
as the executable and add ``platform=x11 target=debug`` (``platform=osx``
|
|
if you're on OS X).
|
|
|
|
.. image:: /img/kdevelop_buildconfig.png
|
|
|
|
Next we need to tell KDevelop where to find the binary.
|
|
From the "run" menu, choose "Configure Launches".
|
|
|
|
.. image:: /img/kdevelop_configlaunches.png
|
|
|
|
Click "Add new" if no launcher exists. Then add the path to your
|
|
executable in the executable section. Your executable should be located
|
|
in the ``bin/`` sub-directory and should be named something like
|
|
``godot.x11.tools.64`` (the name could be different depending on your
|
|
platform and depending on your build options).
|
|
|
|
.. image:: /img/kdevelop_configlaunches2.png
|
|
|
|
That's it! Now you should be good to go :)
|
|
|
|
|
|
Eclipse
|
|
-------
|
|
|
|
TODO.
|
|
|
|
QtCreator
|
|
---------
|
|
|
|
Importing the project
|
|
^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
- Choose *New Project* -> *Import Project* -> *Import Existing Project*.
|
|
- Set the path to your Godot root directory and enter the project name.
|
|
- Here you can choose which folders and files will be visible to the project. C/C++ files
|
|
are added automatically. Potentially useful additions: \*.py for buildsystem files, \*.java for Android development,
|
|
\*.mm for OSX. Click "Next".
|
|
- Click *Finish*.
|
|
|
|
Build and run
|
|
^^^^^^^^^^^^^
|
|
|
|
Build configuration:
|
|
|
|
- Click on *Projects* and open the *Build* tab.
|
|
- Delete the pre-defined ``make`` build step.
|
|
- Click *Add Build Step* -> *Custom Process Step*.
|
|
- Type ``scons`` in the *Command* field.
|
|
- Fill the *Arguments* field with your compilation options. (e.g.: ``p=x11 target=debug -j 4``)
|
|
|
|
Run configuration:
|
|
|
|
- Open the *Run* tab.
|
|
- Point the *Executable* to your compiled Godot binary.
|
|
- If you want to run a specific game or project, point *Working directory* to the game directory.
|
|
- If you want to run the editor, add ``-e`` to the *Command line arguments* field.
|
|
|
|
Other editors (vim, emacs, Atom...)
|
|
-----------------------------------
|
|
|
|
TODO.
|