aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: be62daf17d227d8a4d544605a33c5ab06c2d1732 (plain)
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
![logo](http://libgdx.badlogicgames.com/img/logo.png)

[![Build Status](http://144.76.220.132:8080/buildStatus/icon?job=libgdx&.png)](http://144.76.220.132:8080/job/libgdx/)

libGDX is a cross-platform Java game development framework based on 
OpenGL (ES) that works on Windows, Linux, Mac OS X, Android, your
WebGL enabled browser and iOS.

### Getting Started
  * [Setup your development environment (Eclipse, Intellij IDEA, NetBeans)](https://github.com/libgdx/libgdx/wiki/Setting-up-your-Development-Environment-%28Eclipse%2C-Intellij-IDEA%2C-NetBeans%29)
  * [Create a libGDX project](https://github.com/libgdx/libgdx/wiki/Project-Setup-Gradle)
    * Import, Run, Debug and Package your project
      * [Eclipse](https://github.com/libgdx/libgdx/wiki/Gradle-and-Eclipse)
      * [Intellij IDEA](https://github.com/libgdx/libgdx/wiki/Gradle-and-Intellij-IDEA)
      * [NetBeans](https://github.com/libgdx/libgdx/wiki/Gradle-and-NetBeans)
      * [Commandline](https://github.com/libgdx/libgdx/wiki/Gradle-on-the-Commandline)
  * [Read the Wiki](https://github.com/libgdx/libgdx/wiki)

### Downloads
As we switched to Gradle, there's no need to download libGDX itself anymore. For those of you who still prefer the old way of doing things, you can get libGDX from the [official download site](http://libgdx.badlogicgames.com/download.html).

### Documentation
The [Wiki](https://github.com/libgdx/libgdx/wiki) contains all the information you'll need to write a 
libGDX game. You can contribute to the Wiki directly here on GitHub!

We also provide [Javadocs](http://libgdx.badlogicgames.com/nightlies/docs/api/) online. The Javadocs are
also bundled as source Jars with every libGDX distribution for consumption in your favorite IDE.

### News & Community
You can follow the latest news about libGDX on the [blog](http://www.badlogicgames.com). Follow
[@badlogicgames](https://twitter.com/badlogicgames) for real-time updates.

You can get help on our [forum](http://badlogicgames.com/forum/) and talk to other libGDX 
users on our IRC channel #libgdx at irc.freenode.net.

### Reporting Issues
Use the [issue tracker](https://github.com/libgdx/libgdx/issues?page=1&state=open) here on GitHub to report issues. Make sure you read the 
[Getting Help](https://github.com/libgdx/libgdx/wiki/Getting-help) article that walks you through
the process or properly reporting an issue.

### Contributing & Working from Source
libGDX has a strong developer community constantly improving the code base. We love to
get any and all help we can. The [Contributing](https://github.com/libgdx/libgdx/wiki/Contributing) 
article describes the process of helping libGDX to become even better.

To contribute, you need to work with libGDX' sources directly, something normal users do not
have to go through. The [Working with the Source](https://github.com/libgdx/libgdx/wiki/Running-demos-%26-tests)
article will give you directions.

You can also contribute financially to our infrastructure (build server, web server, test devices) via our [Patreon](http://patreon.com/libgdx)!

### License
libGDX is licensed under the [Apache 2 License](http://www.apache.org/licenses/LICENSE-2.0.html), meaning you
can use it free of charge, without strings attached in commercial and non-commercial projects. We love to
get (non-mandatory) credit in case you release a game or app using libgdx!

### Supported By
libGDX is supported by helpful 3rd parties via code contributions, free licenses, test devices and so forth. Make our supporters happy and visit their sites!

<table>
<tr>
<td style="text-align: center;"><a href="http://bit.ly/robovmgdx"><img style="margin-right:20px" src="http://libgdx.badlogicgames.com/img/robovm.png" alt="RoboVM" /></a></td>
<td style="text-align: center;"><a href="http://bit.ly/spinegdx"><img src="http://libgdx.badlogicgames.com/img/spine.png"></a></td>
</tr>

<tr>
<td style="text-align: center;"><a href="http://bit.ly/saikoagdx"><img style="margin-right:20px" src="http://libgdx.badlogicgames.com/img/saikoa.png" alt="Saikoa" /></a></td>
<td style="text-align: center;"><a href="http://bit.ly/intelgdx"><img src="http://libgdx.badlogicgames.com/img/intel.png" alt="intel Software Partner" /></a></td>
</tr>

<tr>
<td style="text-align: center;"><a href="http://bit.ly/jetblog"><img src="http://libgdx.badlogicgames.com/img/excelsior.png" alt="Excelsior JET"></a></td>
<td style="text-align: center;"><a href="http://bit.ly/nextpeergdx"><img src="http://libgdx.badlogicgames.com/img/nextpeer.png"></a></td>
</tr>
</table>

Intel and the Intel logo are trademarks of Intel Corporation in the U.S. and/or other countries.