Skip to content

Commit 5763362

Browse files
author
FastJava Team
committed
Update LICENSE, MAP, README and add .gitattributes
1 parent b237ba7 commit 5763362

4 files changed

Lines changed: 81 additions & 7 deletions

File tree

.gitattributes

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Primary Languages
2+
*.java linguist-detectable=true
3+
*.cpp linguist-detectable=true
4+
*.h linguist-detectable=true
5+
6+
# Exclude scripts and clutter from language stats
7+
*.bat linguist-detectable=false
8+
native/* linguist-detectable=true
9+
10+
# Exclude binary and build files
11+
*.dll linguist-detectable=false
12+
*.obj linguist-detectable=false
13+
*.lib linguist-detectable=false
14+
*.exp linguist-detectable=false
15+
build/* linguist-detectable=false
16+
target/* linguist-detectable=false
17+
18+
# Documentation
19+
*.md linguist-documentation

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2026 FastJava Team
3+
Copyright (c) 2026 Andre Stubbe
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

MAP.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,15 @@
3030
| **FastIO** | ✅ Stable | IOCP, Memory-mapped | File I/O (5-20×) | [](https://github.com/andrestubbe/FastIO) |
3131
| **FastTween** | ✅ Stable | Object pooling | Tweening engine | [](https://github.com/andrestubbe/FastTween) |
3232
| **FastAnimation** | ✅ Stable | Timeline | Animation orchestration | [](https://github.com/andrestubbe/FastAnimation) |
33+
| **FastWindow** | 🔧 Alpha | Win32, JNI | Native window management engine | [](https://github.com/andrestubbe/FastWindow) |
34+
| **FastKeyboard** | 🔧 Alpha | RawInput, JNI | Low-latency keyboard capture | [](https://github.com/andrestubbe/FastKeyboard) |
3335

3436
---
3537

3638
## � Coming Soon (No Links Yet)
3739

38-
**Q2 2026:** FastAI (Unified AI), FastMouse & FastKeyboard (RawInput), FastGamepad (XInput)
39-
**Q3 2026:** FastVision (GPU shaders), FastAudio (WASAPI), FastWindow, FastProcess, FastFileWatch
40+
**Q2 2026:** FastAI (Unified AI), FastMouse, FastGamepad (XInput)
41+
**Q3 2026:** FastVision (GPU shaders), FastAudio (WASAPI), FastProcess, FastFileWatch
4042
**Q4 2026:** FastOverlay, FastDWM
4143
**2027+:** FastHash, FastAudioCapture, FastTTS, FastSTT, FastVectorDB, FastRAG, FastMCP
4244

README.md

Lines changed: 57 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,21 +27,74 @@
2727
| **[FastClipboard](https://github.com/andrestubbe/fastclipboard)** | System | **2-3×** | Native vs AWT, zero bugs |
2828
| **[FastImageView](https://github.com/andrestubbe/fastimageview)** | Graphics | **10×** | 200ms startup vs 2s Swing |
2929
| **[FastFileIndex](https://github.com/andrestubbe/FastFileIndex)** | Filesystem | **** | Native mmap scan vs Files.walk() |
30+
| **[FastWindow](https://github.com/andrestubbe/FastWindow)** | UI/Engine | **** | Flicker-free native resize vs standard JFrame |
31+
| **[FastKeyboard](https://github.com/andrestubbe/FastKeyboard)** | Input | **16×** | RawInput vs standard AWT KeyListener |
3032
| **[FastFileSearch](https://github.com/andrestubbe/FastFileSearch)** | Filesystem | **100-1000×** | Indexed trie vs linear search |
3133
| **[FastFileWatch](https://github.com/andrestubbe/FastFileWatch)** | Filesystem | **10-100×** | USN Journal vs Java WatchService polling |
3234
| **[FastFileSystem](https://github.com/andrestubbe/FastFileSystem)** | Filesystem | **Unified** | Index + Search + Watch in one API |
3335
| [FastCore](https://github.com/andrestubbe/fastcore) | System || Cross-platform DLL loader |
3436
| [FastHotkey](https://github.com/andrestubbe/fasthotkey) | System | **❌ Java can't** | Global hotkeys — no Java API |
3537
| [FastTouch](https://github.com/andrestubbe/fasttouch) | System | **❌ Java can't** | Multi-touch pressure — no Java API exists |
3638
| [FastStylus](https://github.com/andrestubbe/faststylus) | System | **❌ Java can't** | Pen tilt/eraser — no Java API exists |
37-
| [FastTheme](https://github.com/andrestubbe/fasttheme) | UI | **❌ Java can't** | Native Windows theming — no Java API exists |
39+
| **[FastTheme](https://github.com/andrestubbe/fasttheme)** | UI | **❌ Java can't** | Native Windows theming — no Java API exists |
3840
| [FastNotification](https://github.com/andrestubbe/fastnotification) | UI | **❌ Broken in Java** | SystemTray deprecated/broken → native WinRT |
3941
| [FastTween](https://github.com/andrestubbe/fasttween) | Animation | **Zero overhead** | No built-in tweening — roll your own or use this |
4042
| [FastAnimation](https://github.com/andrestubbe/fastanimation) | Animation | **Zero overhead** | No built-in timelines — pure Java, zero-GC |
4143
| **[FastOCR](https://github.com/andrestubbe/FastOCR)** | Vision | **10× faster** | Tesseract4J slow → native WinRT OCR instant |
4244
| **[FastAudioPlayer](https://github.com/andrestubbe/FastAudioPlayer)** | Audio | **❌ No WASAPI** | Java Sound API only — no low-latency audio |
4345
| **[FastAudioCapture](https://github.com/andrestubbe/FastAudioCapture)** | Audio | **❌ No WASAPI** | Java Sound API only — no system audio capture |
4446

47+
## Installation
48+
49+
### Option 1: Maven (Recommended)
50+
Add the JitPack repository and the dependencies to your `pom.xml`:
51+
52+
```xml
53+
<repositories>
54+
<repository>
55+
<id>jitpack.io</id>
56+
<url>https://jitpack.io</url>
57+
</repository>
58+
</repositories>
59+
60+
<dependencies>
61+
<!-- FastJava Umbrella Library -->
62+
<dependency>
63+
<groupId>io.github.andrestubbe</groupId>
64+
<artifactId>fastjava</artifactId>
65+
<version>v0.1.0</version>
66+
</dependency>
67+
68+
<!-- FastCore (Required Native Loader) -->
69+
<dependency>
70+
<groupId>com.github.andrestubbe</groupId>
71+
<artifactId>fastcore</artifactId>
72+
<version>v1.0.0</version>
73+
</dependency>
74+
</dependencies>
75+
```
76+
77+
### Option 2: Gradle (via JitPack)
78+
```groovy
79+
repositories {
80+
maven { url 'https://jitpack.io' }
81+
}
82+
83+
dependencies {
84+
implementation 'io.github.andrestubbe:fastjava:v0.1.0'
85+
implementation 'com.github.andrestubbe:fastcore:v1.0.0'
86+
}
87+
```
88+
89+
### Option 3: Direct Download (No Build Tool)
90+
Download the latest JARs directly to add them to your classpath:
91+
92+
1. 📦 **[fastjava-v0.1.0.jar](https://github.com/andrestubbe/fastjava/releases)** (The Core Library)
93+
2. ⚙️ **[fastcore-v1.0.0.jar](https://github.com/andrestubbe/FastCore/releases)** (The Mandatory Native Loader)
94+
95+
> [!IMPORTANT]
96+
> Both JARs must be in your classpath for the native JNI calls to function correctly.
97+
4598
**Zero-GC.** **Zero-Copy.** **Native Speed.**
4699

47100
---
@@ -52,8 +105,8 @@
52105
| Library | Purpose | Tech | State |
53106
|---------|---------|------|-------|
54107
| **[FastHotkey](https://github.com/andrestubbe/fasthotkey)** | Global hotkeys | Win32 hooks | Alpha |
55-
| FastMouse | Raw mouse reading | RawInput API | TODO |
56-
| FastKeyboard | Raw keyboard reading | RawInput API | TODO |
108+
| **[FastKeyboard](https://github.com/andrestubbe/FastKeyboard)** | Raw keyboard reading | RawInput API | Alpha |
109+
| **[FastMouse](https://github.com/andrestubbe/FastMouse)** | Raw mouse reading | RawInput API | TODO |
57110
| FastInputHook | Global input hooks | SetWindowsHookEx | TODO |
58111
| **[FastTouch](https://github.com/andrestubbe/fasttouch)** | Multi-touch & pressure | Win32 touch | Alpha |
59112
| **[FastStylus](https://github.com/andrestubbe/faststylus)** | Pen pressure, tilt | WM_POINTER | Alpha |
@@ -78,7 +131,7 @@
78131
| **[FastRobot](https://github.com/andrestubbe/fastrobot)** | Screen capture & automation | DirectX, SendInput | Alpha |
79132
| **[FastGhostMouse](https://github.com/andrestubbe/FastGhostMouse)** | GPU secondary mouse overlay | DirectComposition, D2D | Alpha |
80133
| **[FastDisplay](https://github.com/andrestubbe/FastDisplay)** | Display/DPI monitoring | Win32, DWM | Alpha |
81-
| FastWindow | Window management | Win32 API | TODO |
134+
| **[FastWindow](https://github.com/andrestubbe/FastWindow)** | Window management | Win32 API | Alpha |
82135
| FastWindowHook | Window hooks | Win32 | TODO |
83136
| **[FastNotification](https://github.com/andrestubbe/fastnotification)** | Native notifications | WinRT, Toast | Alpha |
84137
| FastFileWatch | File notifications | ReadDirectoryChangesW | TODO |

0 commit comments

Comments
 (0)