aboutsummaryrefslogtreecommitdiff
path: root/keyboards/lily58/keymaps/druotoni/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/lily58/keymaps/druotoni/readme.md')
-rw-r--r--keyboards/lily58/keymaps/druotoni/readme.md133
1 files changed, 133 insertions, 0 deletions
diff --git a/keyboards/lily58/keymaps/druotoni/readme.md b/keyboards/lily58/keymaps/druotoni/readme.md
new file mode 100644
index 000000000..c6d47da5d
--- /dev/null
+++ b/keyboards/lily58/keymaps/druotoni/readme.md
@@ -0,0 +1,133 @@
1# HELL0 NAVI. Interface
2
3HELL0 NAVI. Interface is a GUI based en [Serial Experiments Lain](https://en.wikipedia.org/wiki/Serial_Experiments_Lain). Turn your [Lily58](https://github.com/kata0510/Lily58) keyboard into a Navi computer with its own Copland OS.
4
5
6Ready to dive into the Wired ?
7
8
9HELL0 NAVI provides interactive animations for both sides :
10- a scope on left side for burst, WPM and active layer
11- a ring on right side for the last key stroke
12
13
14
15
16
17
18
19## Typing animation
20
21The scope displays your burst time on a chart. The WPM is represented by an horizontal line.
22
23The ring display the last letter in the upper frame. Each time you enter a key, the Navi searches into the circular database and locks the position. A special animation is displayed when Enter, Backspce or Escape are struck.
24
25<img src="https://imgur.com/Yf7D6UN.gif" height="400" >
26
27## Startup animation
28
29Your Navi boots when it leaves the sleep mode. The animation can be canceled by typing.
30
31
32
33<img src="https://imgur.com/EXU92Ev.gif" height="400" >
34
35
36
37## Waking up animation
38
39After a period of inactivity, the scope and the ring turn off and the Navi runs in Idle mode. A new key stroke wakes them up.
40
41
42<img src="https://imgur.com/9GWa7rR.gif" height="400" >
43
44
45## Idle animation
46
47The Copland OS is still in beta test. After a while, some visual glitches will occur.
48
49
50<img src="https://imgur.com/eKZ7qgC.gif" height="400" >
51
52
53
54## Shutdown animation
55The Navi runs in sleep mode after 10 seconds in Idle mode. A nice (and difficul to render in a gif) animation is run. The OLED display turns off.
56
57# How to build & flash
58
59You need to flash each side with a specific version based on config.h configuration.
60
61 ## Left side (master)
62
63IS_RIGHT needs to be commented in config.h
64```
65#define IS_LEFT 1
66//#define IS_RIGHT 1
67```
68Connect the left side and flash
69
70 ## Right side (slave)
71
72Comment IS_LEFT and uncomment IS_RIGHT in config.h
73```
74//#define IS_LEFT 1
75#define IS_RIGHT 1
76```
77Connect the right side and flash
78
79# Customization
80
81## Logo
82Logo can be change in navi_logo.c.
83The new logo must be 32x32 pixels.
84```
85static void render_logo_clean(void) {
86 // your logo here
87 static const char PROGMEM logo_raw[] = {
88 0, 0, 0, 0, 0, 0, 128, 128, 0, 0, 128, 128, 192, 192, 204, 222, 222, 204, 192, 192, 128, 0, 0, 0, 128, 128, 0, 0,
89 0, 0, 0, 0, 192, 240, 248, 28, 14, 7, 3, 249, 252, 255, 15, 7, 3, 225, 241, 241, 241, 241, 225, 3, 7, 15, 255, 252,
90 249, 3, 7, 14, 28, 248, 240, 192, 192, 227, 231, 206, 28, 56, 112, 99, 15, 31, 60, 120, 240, 225, 227, 3, 3, 227,
91 225, 240, 120, 60, 31, 15, 103, 112, 56, 28, 206, 231, 227, 192, 0, 1, 1, 0, 0, 0, 56, 120, 96, 192, 192, 192,
92 96, 127, 63, 0, 0, 63, 127, 96, 192, 192, 192, 96, 120, 56, 0, 0, 0, 1, 1, 0,
93 };
94 oled_write_raw_P(logo_raw, sizeof(logo_raw));
95}
96```
97## Layer names
98
99The current version handle 3 differents layers. Names can be changed in layer_frame.h.
100```
101// layer name : must be 3 chars
102#define LAYER_NAME_0 "ABC"
103#define LAYER_NAME_1 "NAV"
104#define LAYER_NAME_2 "SPE"
105```
106
107## Timing
108
109You can tweak states timing in gui_state.h.
110```
111// states timing
112#define BOOTING_TIME_TRESHOLD 7000
113#define WAKING_UP_TIME_TRESHOLD 300
114#define IDLE_TIME_TRESHOLD 4000
115#define HALTING_TIME_TRESHOLD IDLE_TIME_TRESHOLD + 6000
116#define SLEEP_TIME_TRESHOLD HALTING_TIME_TRESHOLD + 8000
117```
118
119## Need space ?
120Boot and gliches can be commented in config.h
121```
122// states timing
123// logo glitch
124//#define WITH_GLITCH
125// boot sequence
126//#define WITH_BOOT
127```
128
129![My Navi](https://imgur.com/eYkgoZJ.png)
130> Keyboard : https://github.com/kata0510/Lily58
131>
132> Case : https://github.com/BoardSodie/Lily58-Acrylic-Case
133