https://github.com/mikyll/sdl2-controller-tester
A tester for game controller written in C, using SDL2.
https://github.com/mikyll/sdl2-controller-tester
c controller game joystick ps3 sdl2
Last synced: 11 months ago
JSON representation
A tester for game controller written in C, using SDL2.
- Host: GitHub
- URL: https://github.com/mikyll/sdl2-controller-tester
- Owner: mikyll
- License: gpl-3.0
- Created: 2021-06-06T09:56:05.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-02-12T04:01:28.000Z (over 2 years ago)
- Last Synced: 2024-02-12T05:23:34.760Z (over 2 years ago)
- Topics: c, controller, game, joystick, ps3, sdl2
- Language: C
- Homepage:
- Size: 29.9 MB
- Stars: 22
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
\
[![LinkedIn][linkedin-shield]][linkedin-url]
[![GitHub followers][github-shield]][github-url]
SDL2 Controller Tester
This little application has been made while I was attending a tutorial to make games in C using SDL2. Since my purpose will be to implement a game with both keyboard or controller input, I wanted to test which of my PS3 controller feature I could use (spoiler: each one).
Explore the docs »
View Demo
·
Report Bug | Request Feature
Table of Contents
## About The Project
Demo video
### Built With
#### Written:
* in C
* using [SDL2](https://www.libsdl.org/)
#### Tested:
* on UNIX system (Debian 9.8 running on a VM)
* with a PS3 Official Controller: Sony® DualShock 3
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
* Git
* SDL2
* At least one controller compatible with your OS
### SDL2 Installation
#### Linux
The easiest way is to open a terminal and install the packages required. In Debian-based distributions, use Advanced Packaging Tool by entering `apt-get install libsdl2-dev` or every one using `apt-get install libsdl2-*`. In Fedora-based distributions, enter `sudo dnf install SDL2-devel make gcc`.
Otherwise download the source code from [there](https://www.libsdl.org/release/SDL2-2.0.14.tar.gz), extract the content and cd to the main directory. Then run `./configure` to configure the installation, `make all` to compile the source, and finally `make install` to install the package.
#### Windows (MinGW)
1. Download SDL2 source code .zip from [there](https://www.libsdl.org/release/SDL2-2.0.14.zip) and extract the content.
2. Inside SDL2-2.0.14, depending on your OS, open the 32bit or 64bit directory, respectively **i686-w64-mingw32** or **x86_64-w64-mingw32**.
3. Then copy the content of the lib subdirectory to the MinGW lib directory (which should be at C:\MinGW\lib).
4. Then, going back to our SDL2 directory, open the include subdirectory and copy the folder **SDL2** to the MinGW include subdirectory.
**NB**: to compile a project which uses SLD2 libraries, you also need SDL2.dll, which can be found inside the bin subdirectory of the 32 or 64 bit version of the SDL2 root directory (SDL2-2.0.14, the one extracted from the archive). This one has to be put in the directory from which you compile the application.
### Project Build (Linux)
1. Clone the repo.
```sh
git clone https://github.com/mikyll/SDL2-Controller-Tester
cd SDL2-Controller-Tester
```
2. Install SDL2. In Debian-based distributions:
```sh
sudo apt-get install sdl2-*
```
3. Compile the project using the makefile.
```sh
make
```
## Usage
1. Connect the controller via cable.
2. Run the application.
3. Spam buttons.
4. Press the button 0 and 3 (respectively SELECT and START in the case of a PS3 controller) at the same time to make the controller vibrate.
For more detailed information, please refer to the [Documentation](https://github.com/mikyll/SDL2-Controller-Tester/blob/main/Documentation/Prototype%20Documentation.md).
## Roadmap
See the [open issues](https://github.com/mikyll/SDL2-Controller-Tester/issues) for the full list of proposed features (and known issues).
### Open Issues
### Future developments
* Add SDL_JoyBallEvent and SDL_JoyHatEvent events in doInput().
* Sound effects when connecting or disconnecting a device.
* GUI with text for details.
* Interactive demo.
* Use [SDL Game Controller](https://wiki.libsdl.org/CategoryGameController) support.
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project.
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`).
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`).
4. Push to the Branch (`git push origin feature/AmazingFeature`).
5. Open a Pull Request.
## License
Distributed under the GNU v3.0 License. See [`LICENSE`](https://github.com/mikyll/SDL2-Controller-Tester/blob/main/LICENSE) for more information.
## Contact
Michele Righi - righi.michele98@gmail.com
Project Link: [https://github.com/mikyll/SDL2-Controller-Tester](https://github.com/mikyll/SDL2-Controller-Tester)
## Acknowledgements
* [Parallel Realities](https://www.parallelrealities.co.uk) for the lovely and super detailed tutorials involving game development in C using SDL2, from which I "stole" (actually I bought some of the tutorials, they're extremely cheap -just 1$ each one-) the project structure and the makefile.
* [Othneil Drew](https://github.com/othneildrew) for the amazing [README template](https://github.com/othneildrew/Best-README-Template).
[contributors-shield]: https://img.shields.io/github/contributors/mikyll/SDL2-Controller-Tester
[contributors-url]: https://github.com/mikyll/SDL2-Controller-Tester/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/mikyll/SDL2-Controller-Tester?style=flat
[forks-url]: https://github.com/mikyll/SDL2-Controller-Tester/network/members
[stars-shield]: https://img.shields.io/github/stars/mikyll/SDL2-Controller-Tester?style=flat
[stars-url]: https://github.com/mikyll/SDL2-Controller-Tester/stargazers
[issues-shield]: https://img.shields.io/github/issues/mikyll/SDL2-Controller-Tester
[issues-url]: https://github.com/mikyll/SDL2-Controller-Tester/issues
[license-shield]: https://img.shields.io/github/license/mikyll/SDL2-Controller-Tester
[license-url]: https://github.com/mikyll/SDL2-Controller-Tester/blob/master/LICENSE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?logo=linkedin&colorB=0077B5
[linkedin-url]: https://www.linkedin.com/in/michele-righi/?locale=en_US
[github-shield]: https://img.shields.io/github/followers/mikyll.svg?style=social&label=Follow
[github-url]: https://github.com/mikyll