sigonasr2/PixelEngine
1
0
Fork 0
generated from sigonasr2/JavaProjectTemplate
Code Issues 1 Pull Requests Projects Releases Wiki Activity

Small README included

Browse Source 
Co-authored-by: sigonasr2 <sigonasr2@gmail.com>
This commit is contained in:
sigonasr2 2022-11-28 17:55:36 -06:00
parent 078dacd790
commit 26ce76d425
1 changed files with 10 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -1,27 +1,15 @@
# JavaProjectTemplate
Provides a Java pipeline for building applications and deploying a JAR with ease. Providing a base graphical engine (fast pixel blitting) with support for input should be enough to get any project going.
# PixelEngine
A small pixel-based game / rendering engine made in Java highly influenced and similar to the olcPixelGameEngine.
The system will also use the SigScript updating system to keep files up-to-date.
Usage:
## Usage:
**./sig** - Shows a menu with all scripts. Example output:
```
gitpod /workspace/JavaProjectTemplate (main) $ ./sig
Main engine file is in `JavaProjectTemplate.java`. If you choose to rename this file you should probably have your IDE refactor it so all references change accordingly. Better to just leave it as-is.
Usage: ./sig <command> {args}
You will also have to update the `sig` script with the new `PROJECT_NAME` value.
==== Current Configuration =====================
PROJECT_NAME JavaProjectTemplate
PROJECT_DIR src/sig
MAIN_CLASS sig.JavaProjectTemplate
OUT_DIR bin
=====================================================
# Drawing
You will find all possible drawing features under the `game` Panel object that is initialized for you. Draw commands all start with `Draw`. The example program contains quite a few of the possible draw commands available.
Command List:
build Builds and runs the project.
clean Cleans up and removes unused files.
commit Adds a commit message and pushes project to github repository.
jar Builds a runnable jar file using ${MAIN_CLASS} as an entry point and then runs the newly generated jar.
```
Configuration is modified at the top of the script file while the command list includes all included modules inside of `scripts`.
# Input
Mouse input is handled from the `Mouse` static instance. Can poll for `Held`,`Pressed`, and `Released` status of the mouse.
Keyboard input is handled much the same way with the `Key` static instance. Also has `Held`,`Pressed`, and `Released` statuses per key. Keycodes come from the Java Swing `KeyEvent` class (ex.`KeyEvent.VK_UP`).