Awesome
<a href="https://twitter.com/dumas181" target="_blank">Follow me on twitter !</a>
What is OpenRTS?
OpenRTS is a 3D real-time strategy game engine. It's coded in Java 1.8, powered by jMonkeyEngine 3, and is open-source.
OpenRTS intends to support any kind of common real-time strategy gameplay, design and control, providing its own editor and a versatile data structure.
The project also wants to be a pool of RTS resources, giving access to a large and free-to-use set of maps, models, sounds, armies' data, and gameplays.
OpenRTS is still under development. There is a long way to go and a huge and growing <a href="#github-issues-our-todo-list">TODO list</a>. We will be glad to receive any of your contributions!
Watch <a href="https://www.youtube.com/watch?v=XjYJWFQFIVE" target="_blank">the engine in action!</a>
How to set up?
The project uses Gradle to support any IDE, or none.
Just <a href="https://help.github.com/articles/cloning-a-repository/" target="_blank">clone the repository</a>, then at the command-line in the clone's root directory run "./gradlew run" (or "gradlew.bat run" on windows).
You want to set up in your favorite IDE like jMonkey SDK or Eclipse? Simple! Please follow <a href="https://github.com/methusalah/OpenRTS/wiki/Set-up-the-project-with-your-favorite-IDE-(Eclipse,-Netbeans,-etc.)" target="_blank">this page</a> of the wiki.
The engine is set by default with a test dataset and some example maps you can load.
- F1 : Game Mode (static iso camera)
- F2 : Editor Mode
- F3 : First Person view (for testing purpose)
Need Help?
First, you should take a look at the <a href="https://github.com/methusalah/OpenRTS/wiki" target="_blank">wiki</a>. Then you will likely want to go to the <a href="http://hub.jmonkeyengine.org/c/user-code-projects/openrts" target="_blank">forum</a>.
And of course, you shouldn't hesitate to write to us at openRTS.team@gmail.com
How to contribute?
You want to participate and make OpenRTS a fully functional game engine? Please do—the more the merrier!
Forum
The best place to start if you would like to contribute is in the <a href="http://hub.jmonkeyengine.org/c/user-code-projects/openrts" target="_blank">OpenRTS forum</a>! Join in on debates and brainstormings about how to make OpenRTS better. The forum is also the best place to meet our awesome team.
GitHub issues, our TODO list
We've got plenty of things you can work on right now, check our <a href="https://github.com/methusalah/OpenRTS/issues" target="_blank">current open issues</a>. And we will be happy to add your requested features to the <a href="https://github.com/methusalah/OpenRTS/labels/enhancement" target="_blank">enhancement list</a>.
Resources
OpenRTS wants to provide its own complete and workable dataset to allow immediate RTS creation.
We are glad to welcome all your creations : models, sounds, maps, particle sprites, army data... And if your contribution respects the current <a href="https://pinterest.com/search/pins/?q=low%20poly" target="_blank">low-poly art style</a>, so much the only better!
Please note that all your contributions will fall under the OpenRTS licence, and will become public and free-to-use, as is the engine itself.
Finaly, following (<a href="https://twitter.com/dumas181" target="_blank">twitter</a>), starring and sharing helps a lot !
Bug report
If you find a bug (and you will probably see many), please search for existing <a href="https://github.com/methusalah/OpenRTS/issues?q=is%3Aopen+is%3Aissue+label%3Abug" target="_blank">bug reports</a> to avoid duplicates. Then open your issue with a little test case. You can also report it on the forum, if you prefer.
Licensing
OpenRTS is released under the <a href="http://choosealicense.com/licenses/mit/" target="_blank">MIT License</a>, which will also apply to any contributions made to OpenRTS. See the file <a href="https://raw.githubusercontent.com/methusalah/OpenRTS/master/LICENSE" target="_blank">LICENSE</a>.
