Skip to content

Commit 03d9bdc

Browse files
authored
Update README.md
1 parent 99efdc2 commit 03d9bdc

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,30 @@
11
# XMapLib
22
A closer to the metal library for Xbox controller to keyboard and mouse input.
33

4-
<p>XMapLibSharp is a C# .NET GUI project using the C++ project code through a DLL via managed/native interop. With this approach,
5-
the project has access to the entire .NET framework for GUI work while keeping the native performance and power of the C++ XMapLib code.
4+
<p>XMapLibSharp is a C# .NET GUI project using the C++ project code through a DLL. With this approach,
5+
the project has access to the entire .NET framework for GUI work while keeping the native performance and power of the C++ XMapLib project code.
6+
<p>The project utilizes
7+
<ul>
8+
<li>.NET multi-threading</li>
9+
<li>events</li>
10+
<li>programmatic UI element creation</li>
11+
<li>a producer/consumer design pattern.</li>
12+
<li>managed/native interop via custom C++ DLL</li>
13+
</ul>
614

715
<a href="https://ibb.co/x28d2WX"><img src="https://i.ibb.co/0nVvnTm/XMap-Lib-gui1.jpg" alt="XMap-Lib-gui1" border="0"></a>
816

917
<b><p>A high level code diagram of the XMapLib project code (native C++)</b>
1018
<a href="https://ibb.co/vmjctWD"><img src="https://i.ibb.co/ZKMfZrN/XMap-Lib-uml.jpg" alt="XMap-Lib-uml" border="0"></a>
1119

1220
<b>The main classes for use in the native C++ XMapLib project are :</b>
13-
<b><p><a href="https://github.com/calebtt/XMapLib/blob/master/XMapLib/MouseMapper.h">MouseMapper</a></p></b>
14-
<b><p><a href="https://github.com/calebtt/XMapLib/blob/master/XMapLib/KeyboardMapper.h">KeyboardMapper</a></p></b>
15-
<b><p><a href="https://github.com/calebtt/XMapLib/blob/master/XMapLib/MousePlayerInfo.h">MousePlayerInfo</a></p></b>
16-
<b><p><a href="https://github.com/calebtt/XMapLib/blob/master/XMapLib/KeyboardPlayerInfo.h">KeyboardPlayerInfo</a></p></b>
17-
To set the mapping details <b><a href="https://github.com/calebtt/XMapLib/blob/master/XMapLib/KeyboardKeyMap.h">KeyboardKeyMap</a></b> encapsulates the information comprising a controller key to keyboard/mouse key mapping.
21+
<ul>
22+
<li><b><a href="https://github.com/calebtt/XMapLib/blob/master/XMapLib/MouseMapper.h">MouseMapper</a></b></li>
23+
<li><b><a href="https://github.com/calebtt/XMapLib/blob/master/XMapLib/KeyboardMapper.h">KeyboardMapper</a></b></li>
24+
<li><b><a href="https://github.com/calebtt/XMapLib/blob/master/XMapLib/MousePlayerInfo.h">MousePlayerInfo</a></b></li>
25+
<li><b><a href="https://github.com/calebtt/XMapLib/blob/master/XMapLib/KeyboardPlayerInfo.h">KeyboardPlayerInfo</a></b></li>
26+
<li>To set the mapping details <b><a href="https://github.com/calebtt/XMapLib/blob/master/XMapLib/KeyboardKeyMap.h">KeyboardKeyMap</a></b> encapsulates the information comprising a controller key to keyboard/mouse key mapping.</li>
27+
</ul>
1828
<p>Also, please see the <b><a href="https://github.com/calebtt/XMapLib/blob/master/XMapLib/XMapLib.cpp">Example</a></b></p>
1929

2030
<b><p>The DLL API exposed from XMapLibDLL is described totally in <a href="https://github.com/calebtt/XMapLib/blob/master/XMapLibDLL/apifuncs.h">apifuncs.h</a> in the DLL project.</b>

0 commit comments

Comments
 (0)