Skip to content

Commit 356dc9e

Browse files
committed
README.md: add UTF-8 symbols + improve diagrams
1 parent cea8230 commit 356dc9e

File tree

1 file changed

+33
-27
lines changed

1 file changed

+33
-27
lines changed

README.md

+33-27
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,35 @@
88
Visit the [ControllerBuddy Homepage](https://controllerbuddy.org) to get started.
99
For more support, join the [ControllerBuddy Discord](https://discord.gg/2Sg9ggZrAp).
1010

11-
## Description
11+
## 📖 Description
1212

1313
ControllerBuddy is an advanced gamepad mapping software that supports the creation of input profiles for complex target applications such as flight simulators.
1414

1515
In addition to the simple mapping of buttons and axes of a physical game controller to keyboard and mouse input, ControllerBuddy also supports feeding input commands to a virtual joystick device (vJoy / uinput).
1616

1717
The goal of ControllerBuddy is to allow the user to control target applications exclusively with a gamepad without ever having to reach for a keyboard or mouse.
1818

19-
## Download and Installation
19+
## ⬇️ Download and Installation
2020

21-
**Tip:**
22-
Check out the [ControllerBuddy-Install-Script](https://github.com/bwRavencl/ControllerBuddy-Install-Script),
23-
it automates all the steps below and much more!
24-
If you are running Linux, you additionally have the option of using the [ControllerBuddy-Flatpak](https://github.com/bwRavencl/ControllerBuddy-Flatpak).
21+
### 📜 Install-Script
2522

26-
### Windows x86-64
23+
For the easiest way to install and update, use the [ControllerBuddy-Install-Script](https://github.com/bwRavencl/ControllerBuddy-Install-Script).
24+
It automates all the steps below and much more!
25+
26+
### 📦 Flatpak
27+
28+
Linux users may want to use the [ControllerBuddy-Flatpak](https://github.com/bwRavencl/ControllerBuddy-Flatpak).
29+
30+
### 🧑‍🔧 Manual Installation
31+
32+
#### 🪟 Windows x86-64
2733

2834
1. First download and install [vJoy](https://github.com/jshafer817/vJoy/releases/latest) on your system.
2935
2. [Click here](https://github.com/bwRavencl/ControllerBuddy/releases/latest) and download the latest build of ControllerBuddy for Windows as a ZIP archive.
3036
3. Extract the `ControllerBuddy` directory from the archive to any desired location on your hard-drive.
3137
4. Run `ControllerBuddy.exe` inside the extracted `ControllerBuddy` directory.
3238

33-
### Linux x86-64 / aarch64
39+
#### 🐧 Linux x86-64 / aarch64
3440

3541
1. Create a controllerbuddy group:
3642
```
@@ -53,7 +59,7 @@ If you are running Linux, you additionally have the option of using the [Control
5359
7. Extract the `ControllerBuddy` directory from the archive to any desired location on your hard-drive.
5460
8. Run `ControllerBuddy` inside the extracted `ControllerBuddy/bin` directory.
5561
56-
## Features
62+
## Features
5763
5864
- Map gamepad axes and buttons to highly customizable actions:
5965
- vJoy axis movements (absolute and relative)
@@ -90,7 +96,7 @@ If you are running Linux, you additionally have the option of using the [Control
9096
- English
9197
- German
9298
93-
## Profiles
99+
## 🗃️ Profiles
94100
95101
Profiles are used to configure your gamepad for a specific target application.
96102
The general structure of a profile is as follows:
@@ -134,49 +140,49 @@ Mode switching can be configured to work in two different ways:
134140
135141
The [ControllerBuddy-Profiles](https://github.com/bwRavencl/ControllerBuddy-Profiles) repository contains a number of well-thought-out profiles for many different flight simulators.
136142
137-
## Architecture
143+
## 🏛️ Architecture
138144
139-
Local mode:
145+
### 🖥️ Local Mode
140146
141147
```
142148
Local:
143149

144150
Physical Controller
145-
|
146-
|
147-
v
151+
152+
153+
148154
ControllerBuddy
149155
|
150156
|
151-
v
157+
152158
vJoy + Win32 / uinput
153159
|
154160
|
155-
v
161+
156162
Target Application
157163
```
158164
159-
Server-Client mode:
165+
### 🖧 Client-Server Mode
160166
161167
```
162168
Server: Client:
163169

164170
Physical Controller
165171
|
166172
|
167-
v UDP
168-
ControllerBuddy --------------------> ControllerBuddy
173+
UDP
174+
ControllerBuddy ────────────────────► ControllerBuddy
169175
|
170176
|
171-
v
177+
172178
vJoy + Win32 / uinput
173179
|
174180
|
175-
v
181+
176182
Target Application
177183
```
178184
179-
## Screenshots
185+
## 🖼️ Screenshots
180186
181187
![Modes Tab](screenshot_1.png)
182188
@@ -192,7 +198,7 @@ Server-Client mode:
192198
193199
![Overlay](screenshot_7.png)
194200
195-
## Command Line Parameters
201+
## ⌨️ Command Line Parameters
196202
197203
| Parameter | Arguments | Description | Available for scripting |
198204
|---------------------|-------------------------|-------------------------------------------------------------------------------------------------------------|:-----------------------:|
@@ -216,7 +222,7 @@ If one instance of ControllerBuddy is already running, starting a second instanc
216222
This can be used to integrate ControllerBuddy into third party applications.
217223
For more information see [ControllerBuddy-DCS-Integration](https://github.com/bwRavencl/ControllerBuddy-DCS-Integration), an exemplary integration of ControllerBuddy into [DCS World](https://www.digitalcombatsimulator.com).
218224
219-
## Attribution
225+
## 🙏 Attribution
220226
221227
ControllerBuddy makes use of these awesome software technologies and libraries:
222228
@@ -232,7 +238,7 @@ ControllerBuddy makes use of these awesome software technologies and libraries:
232238
- [SDL_GameControllerDB](https://github.com/gabomdq/SDL_GameControllerDB)
233239
- [SLF4J](https://www.slf4j.org/)
234240
235-
## Building
241+
## 🛠️ Building
236242
237243
If you want to build ControllerBuddy from source, this section might be helpful to get you started.
238244
ControllerBuddy uses the Gradle build system, the following Gradle tasks are supported:
@@ -248,6 +254,6 @@ ControllerBuddy uses the Gradle build system, the following Gradle tasks are sup
248254
| Create a TGZ-compressed jpackage image | gradlew distTar |
249255
| Delete build and gen directories | gradlew clean |
250256
251-
## License
257+
## ⚖️ License
252258
253259
[GNU General Public License v3.0](LICENSE)

0 commit comments

Comments
 (0)