/README.md

https://github.com/kuroni/bongocat-osu · Markdown · 60 lines · 39 code · 21 blank · 0 comment · 0 complexity · 8834c2b5aa164fb27a89c091f9614f42 MD5 · raw file 

    

  1. # Description
    2. 

  2. An osu! Bongo Cat overlay with smooth paw movement and simple skinning ability, written in C++.
    3. 

  3. 

  4. You can find how to configure the application in our [wiki](https://github.com/kuroni/bongocat-osu/wiki/Settings).
    5. 

  5. 

  6. Download the program [here](https://github.com/kuroni/bongocat-osu/releases).
    7. 

  7. 

  8. Hugs and kisses to [CSaratakij](https://github.com/CSaratakij) for creating the Linux port for this project!
    9. 

  9. 

  10. Any suggestion and/or collaboration, especially that relating to sprites, is welcomed! Thank you!
    11. 

  11. 

  12. [Original post](https://www.reddit.com/r/osugame/comments/9hrkte/i_know_bongo_cat_is_getting_old_but_heres_a_nicer/) by [Kuvster](https://github.com/Kuvster).
    13. 

  13. 

  14. ## Further information
    15. 

  15. In order to play with fullscreen on Windows 10, run both osu! and this application in Windows 7 compability mode.
    16. 

  16. 

  17. Press Ctrl + R to reload configuration and images (will only reload configurations when the window is focused).
    18. 

  18. 

  19. Supported operating system:
    20. 

  20. * Windows
    21. 

  21. * Linux (tested with Arch Linux with WINE Staging 5). Note: You **must** use WINE Staging, because for whatever reason on stable WINE bongocat-osu doesn't register keyboard input from other windows.
    22. 

    23. 

  23. _Notice_: If you're using WINE on Linux, make sure that osu! and this application run in the same `WINEPREFIX`.
    24. 

    25. 

  25. ## For developers
    26. 

  26. This project uses [SFML](https://www.sfml-dev.org/index.php) and [JsonCpp](https://github.com/open-source-parsers/jsoncpp). JsonCpp libraries are directly included in the source using the provided `amalgamation.py` from the developers.
    27. 

  27. 

  28. ### Libraries and dependency
    29. 

  29. 

  30. #### Windows and MinGW
    31. 

  31. To build the source, download the SFML libraries [here](https://www.sfml-dev.org/index.php), copy `Makefile.windows` to `Makefile`, then replace *`<SFML-folder>`* in `Makefile` with the desired folder.
    32. 

  32. 

  33. #### Linux
    34. 

  34. You need to have these dependencies installed. Check with your package manager for the exact name of these dependencies on your distro:
    35. 

  35. - g++
    36. 

  36. - libxdo
    37. 

  37. - sdl2
    38. 

  38. - sfml
    39. 

  39. - x11
    40. 

  40. - xrandr
    41. 

  41. 

  42. Then, copy `Makefile.linux` to `Makefile`.
    43. 

  43. 

  44. ### Building and testing
    45. 

  45. To build, run this command from the base directory:
    46. 

  46. 

  47. ```sh
    48. 

  48. make
    49. 

  49. ```
    50. 

  50. 

  51. To test the program, run this from the base directory:
    52. 

  52. 

  53. ```sh
    54. 

  54. make test
    55. 

  55. ```
    56. 

  56. 

  57. Alternatively, you can copy the newly-compiled `bin/bongo.exe` or `bin/bongo` into the base directory and execute it.
    58. 

  58. 

  59. If you have troubles compiling, it can be due to version mismatch between your compiler and SFML. See [#43](https://github.com/kuroni/bongocat-osu/issues/43) for more information.
    60.