https://github.com/berkano/katsu

game framework and source for ludum dare compo
https://github.com/berkano/katsu

compo game-development game-engine game-frameworks games java libgdx libgdx-desktop libgdx-engine libgdx-game libgdx-utilities ludum-dare ludumdare

Last synced: about 19 hours ago
JSON representation

game framework and source for ludum dare compo

• Host: GitHub
• URL: https://github.com/berkano/katsu
• Owner: berkano
• Created: 2015-07-23T22:07:20.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2021-06-27T19:14:42.000Z (over 3 years ago)
• Last Synced: 2024-09-21T15:02:16.463Z (6 days ago)
• Topics: compo, game-development, game-engine, game-frameworks, games, java, libgdx, libgdx-desktop, libgdx-engine, libgdx-game, libgdx-utilities, ludum-dare, ludumdare
• Language: Java
• Size: 25.7 MB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
### Katsu - Java 2D Game Framework based on LibGDX

This is my personal game framework for Ludum Dare (http://ludumdare.com/compo/)

which I have been extending over time based on my needs during the compo.

It's based on LibGDX and contains the source code and assets for my latest LD entry.

#### Dependencies

The project was originally generated by LibGDX and requires Gradle to build.

#### Running

- Gradle: `katsu:desktop [run]`

- Directly: run the class `KLauncher`

#### Producing a build for distribution

Gradle: `katsu:desktop [dist]`

#### Game implementation

The game library itself is under `core/src/katsu`.

Each game has its own:

  - implementation package e.g. `core/src/ld32` is my LD32 entry

  - resources folder e.g. `core/assets/ld32/...`

  - desktop launcher e.g. `desktop/src/ld32/LD32Runner`

      - this is set as the main class in build.gradle

      - the launcher must pass an instance of your implementation of KGame which is responsible for implementation specific details (level manager, sounds, settings and so on - the LD32 implementation hopefully shows what's needed here).

#### Testing

The code supports a `-DdevMode=true` parameter (add this to your run configuration) to enable some shortcuts/hacks/debug features while developing.

#### Credits & License

- The katsu.spatial.pathfinding package is adapted from http://www.gudradain.byethost12.com/Pathfinding.html, all that has changed is the package name (licensing terms are unclear).

- The Minecraftia font was obtained from http://www.dafont.com/minecraftia.font. Copyright Andrew Tyler. Visit that page for requirements around commercial usage.

- All other code and assets are hereby released into the public domain.