The JInput Project hosts an implementation of an API for game controller
+discovery and polled input. It is part of a suite of open-source technologies
+initiated by the Game Technology Group at Sun Microsystems with intention of
+making the development of high performance games in Java a reality.
+
The API itself is pure Java and presents a platform-neutral
+completely portable model of controller discovery and polling.
+It can handle arbitrary controllers and returns both human and
+machine understandable descriptions of the inputs available.
+
The implementation hosted here also includes plug-ins to allow
+the API to adapt to various specific platforms. These plug-ins
+often contain a native code portion to interface to the host system.
+
+
+##Getting Started
+
+Include dependency in your project:
+
+1. Maven - Easy way
+-----
+```xml
+
+ net.java.jinput
+ jinput
+ 2.0.7
+
+```
+
+2. Build from sources - Experts only
+-----
+ 1. Download latest source from [here]({{ site.github.zip_url }}).
+ 2. Build maven root project:
+ ```bash
+ mvn build .
+ ```
+ 3. Include generated artifacts to your project.
+
+##Usage
+
From 55e0f46eeca5f58dfdf338c16244eb20a6d3ef09 Mon Sep 17 00:00:00 2001
From: dyorgio
Date: Wed, 23 May 2018 11:23:36 -0300
Subject: [PATCH 5/7] Fix some markdown issues (github pages).
---
docs/index.md | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/docs/index.md b/docs/index.md
index f51def6..5dfc9a1 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -19,19 +19,19 @@ the API to adapt to various specific platforms. These plug-ins
often contain a native code portion to interface to the host system.
-##Getting Started
+## Getting Started
Include dependency in your project:
1. Maven - Easy way
-----
-```xml
-
- net.java.jinput
- jinput
- 2.0.7
-
-```
+ ```xml
+
+ net.java.jinput
+ jinput
+ 2.0.7
+
+ ```
2. Build from sources - Experts only
-----
@@ -42,5 +42,5 @@ Include dependency in your project:
```
3. Include generated artifacts to your project.
-##Usage
+## Usage
From b1d6589b73a5f228fcb6d251acad6d2948936160 Mon Sep 17 00:00:00 2001
From: dyorgio
Date: Wed, 23 May 2018 11:32:42 -0300
Subject: [PATCH 6/7] Added usage example (github pages).
---
docs/index.md | 25 +++++++++++++++++++++++++
1 file changed, 25 insertions(+)
diff --git a/docs/index.md b/docs/index.md
index 5dfc9a1..af1224a 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -44,3 +44,28 @@ Include dependency in your project:
## Usage
+ ```java
+ /* Create an event object for the underlying plugin to populate */
+ Event event = new Event();
+
+ /* Get the available controllers */
+ Controller[] controllers = ControllerEnvironment.getDefaultEnvironment().getControllers();
+ for (int i = 0; i < controllers.length; i++) {
+ /* Remember to poll each one */
+ controllers[i].poll();
+
+ /* Get the controllers event queue */
+ EventQueue queue = controllers[i].getEventQueue();
+
+ /* For each object in the queue */
+ while (queue.getNextEvent(event)) {
+ /* Get event component */
+ Component comp = event.getComponent();
+
+ /* Process event (your awesome code) */
+ ...
+ }
+ }
+ ```
+
+### [More examples here](https://github.com/jinput/jinput/tree/master/examples/src/main/java/net/java/games/input/example).
From 676f94ed4cde4ab78d3d2435864306216d5369e2 Mon Sep 17 00:00:00 2001
From: dyorgio <>
Date: Wed, 23 May 2018 11:34:50 -0300
Subject: [PATCH 7/7] Fix some markdown issues (github pages).
---
docs/index.md | 38 +++++++++++++++++++-------------------
1 file changed, 19 insertions(+), 19 deletions(-)
diff --git a/docs/index.md b/docs/index.md
index af1224a..5e1e1bd 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -44,28 +44,28 @@ Include dependency in your project:
## Usage
- ```java
- /* Create an event object for the underlying plugin to populate */
- Event event = new Event();
+```java
+/* Create an event object for the underlying plugin to populate */
+Event event = new Event();
- /* Get the available controllers */
- Controller[] controllers = ControllerEnvironment.getDefaultEnvironment().getControllers();
- for (int i = 0; i < controllers.length; i++) {
- /* Remember to poll each one */
- controllers[i].poll();
+/* Get the available controllers */
+Controller[] controllers = ControllerEnvironment.getDefaultEnvironment().getControllers();
+for (int i = 0; i < controllers.length; i++) {
+ /* Remember to poll each one */
+ controllers[i].poll();
- /* Get the controllers event queue */
- EventQueue queue = controllers[i].getEventQueue();
+ /* Get the controllers event queue */
+ EventQueue queue = controllers[i].getEventQueue();
- /* For each object in the queue */
- while (queue.getNextEvent(event)) {
- /* Get event component */
- Component comp = event.getComponent();
+ /* For each object in the queue */
+ while (queue.getNextEvent(event)) {
+ /* Get event component */
+ Component comp = event.getComponent();
- /* Process event (your awesome code) */
- ...
- }
+ /* Process event (your awesome code) */
+ ...
}
- ```
+}
+```
-### [More examples here](https://github.com/jinput/jinput/tree/master/examples/src/main/java/net/java/games/input/example).
+[More examples here](https://github.com/jinput/jinput/tree/master/examples/src/main/java/net/java/games/input/example).