diff --git a/README.md b/README.md index d7582ac..ada8b55 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,15 @@ Main engine file is in `JavaProjectTemplate.java`. If you choose to rename this You will also have to update the `sig` script with the new `PROJECT_NAME` value. +# Window +Window Width, Height, and the title can all be customized. + # 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. +## Sprites +Sprites can be placed in the `sprites` folder and referenced accordingly. Instantiating a new `Sprite` class or `AnimatedSprite` class with the name will auto-load it in. Animated Sprites need their base width and height defined, the engine will figure out the animation frames for the rest of the image. `DrawAnimatedSprite` functions request what index of the animation to draw, you feed that yourself. Only horizontal animation strips are supported by default. + # 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`). \ No newline at end of file