Skip to content

Commit 51f3cb7

Browse files
committed
Update README.md
1 parent 6ec7ead commit 51f3cb7

File tree

1 file changed

+4
-14
lines changed

1 file changed

+4
-14
lines changed

README.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,17 @@
11
#GDX-Proto - A lightweight 3D engine built with [libgdx](http://libgdx.badlogicgames.com)
22

3-
![screenshot](img/fps-demo-screen2.jpg)
4-
5-
---------------
6-
7-
###GDX-Proto is immature. Breaking changes are to be expected. Code might be a bit messy before it gets a nice refactoring.
3+
When I decided to create GDX-Proto, I had been playing with libgdx's 3D API for about 6 months on and off. I often see libgdx users at a loss when it comes to starting with 3D. The 2D side of libgdx is well documented and has many examples and tutorials, but when it comes to 3D, there are much less resources available (side note: Xoppa's [3D tutorial series](http://blog.xoppa.com/basic-3d-using-libgdx-2/) are a must read!)
84

9-
-----------
5+
I made GDX-Proto so show how one might implemented all the basic pieces you need to create a simple FPS with libgdx. I wouldn't use GDX-Proto to create a game with, since it might be a little rough in some areas, but I think it is a great resource to see how one could implement physics, graphics, and networking for a 3d game.
106

11-
GDX-Proto is a lightweight 3d engine built with two main objectives:
12-
- Provide an open source codebase showing how to do many basic and essential things for 3d games with [libgdx](http://libgdx.badlogicgames.com), a cross-platform Java game framework.
13-
- Provide a simple, extensible 3d engine that takes care of lower-level things such as physics and networking.
14-
15-
While the current version is implemented as a First Person Shooter (FPS) demo, the code is highly adaptable for other uses, without too much work.
7+
![screenshot](img/fps-demo-screen2.jpg)
168

179
## Overview of Features
1810

1911
### Graphics
2012
- Basic 3d rendering using a slightly modified version of the default libgdx 3d shader. It takes advantage of the new libgdx 3D API.
2113
- 3D Particle system based on the new libgdx 3d particle system (version 1.2.1+, not included in 1.2.0)
14+
- game entities can be rendered as 3d models or flat sprites
2215

2316
### Physics
2417
- The Bullet physics library is used for collision detection, but not for collision resolution. This allows for fast and efficient collision detection without the performance penalties of a fully simulated bullet world. A default collision resolution system is included in the Physics class, but it can be modified to suit your needs.
@@ -40,9 +33,6 @@ While the current version is implemented as a First Person Shooter (FPS) demo, t
4033
- Movement component class handles acceleration, velocity, position, rotation, max speeds
4134
- Subclasses of Movement: GroundMovement and FlyingMovement
4235

43-
### Using GDX-Proto For Your Own Projects
44-
Currently, GDX-Proto does not exist as a library. The best way to use it for your own project is to use it as a base for a new project, and remove parts you do not wish, while adding your own code on top. In the future it may be modified to be more convenient.
45-
4636
## Demo - First Person Shooter
4737

4838
**A pre-built jar of the [desktop demo can be downloaded here](https://github.com/jrenner/gdx-proto/blob/master/bin/desktop-1.0.jar?raw=true).**

0 commit comments

Comments
 (0)