JUMG ('Jum-Gee') 3.0!

Java Utilities for Making Games the third

---

Contents

1. What is JUMG?
   1. JUMG Development Checklist
2. Demo Game
3. How to use JUMG
   1. Some Packages
   2. Full Library
   3. Quick Start
4. Extra Notes

---

What is JUMG?

JUMG (pronounced 'Jum-Gee', acronymed 'Java Utilities for Making Games') is a library that contains multiple utilities to make Java Games the most efficient way. JUMG utilises the concepts of separating certain portions of code from the rest, to allow one main class to bring them altogether.

As JUMG is in development, it is necessary for a checklist to be made of what needs to be added, and what is added. This is here for simplicity's sake:

JUMG Development Checklist:

1. Binary File IO (using custom protocols - so text can still be saved)
2. String Compression
3. Frame and Screen implementation
4. Graphical User Interface utilities (will be continued as I go on...)
5. Heads Up Display simplicity
6. Game Engine
7. Sprite Manager
8. Level Manager
9. AI (pathfinding and states)
10. Sound Manager
11. Key Bindings
12. Entities
13. Inventory System
14. Save Game System
15. Questing System
16. Messaging System (not exclusive to entities!)
17. Collision detection
18. Networking
19. Version control and updating
20. Startup Arguments
21. Bulk Debugging Classes
22. Full JavaDocs
23. RELEASE!

My Uni course has finally come to an end! I've made that project dormant while I continue to work on this library so I am able to quickly prototype new ideas and expend on my knowledge of game development from the ground up. Therefore, changes on this list may seem eratic. Just bear with me. 👌

Demo Games

• BattleCell - Check out the demo game which is was a project for my Computer Games course at Uni!
• th3 d33p - Here's a new demo game called 'th3 d33p' which is a realtime-roguelike game similar to Runescape's old Dungeoneering minigame.

How to use JUMG

Create a library dependency

1. Eclipse
   1. Make sure the JUMG Library is a project in your workspace.
   2. Right Click your project > "Build Path" > "Configure Build Path..."
   3. "Projects" tab > "Add..."
   4. Tick the JUMG project you have made > OK > OK
   5. The packages should be available for use!
2. VSCode
   1. Create a Workspace in VSCode and make sure the JUMG Library is a project in it.
   2. In your project, open the .classpath file and add the following line: <classpathentry combineaccessrules="false" kind="src" path="/JUMG 3.0"/>
   3. You should now be able to use and modify JUMG!

Note that these methods allow you to alter the packages, for your own personalization benefits, or to improve on JUMG. If you do make an improvement or addition that is not personalized, submit a PR!

Quick Start

Copy the content of QuickStart.java into your game's execution point (the main Java file) and follow the comments to get started.

Also look at the various demo games above to find out where to go from there.

Extra Notes

JUMG is an open source tool that is freely available for modifications. Take it and throw it into eclipse, but remember that it would be nice that if you muddle around with it, that if you could throw a push request to the current JUMG build, here on GitHub.

JUMG uses the Gnu GPL license to support modification of the works presented in this repository - however one should always remember to not redistribute the works under their name. I mean, come on man, that's not cool. Changes and additions to the works will be credited with a name, the work committed, and a slogan (provided that I approve of the slogan).

On another note about the license, if you need to hit the road but have already downloaded this library, and want to read the license, you can check the LICENSE.md file in the root of the library folder.

Disclamer

JUMG and BrennyPress are free softwares: you can redistribute them and/or modify them under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License any later version.

JUMG and BrennyPress are distributed in the hope that they will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this software collection. If not, see http://www.gnu.org/licenses/.