https://github.com/zackeryrsmith/bongocat-plus

An extensible and highly configurable Bongo Cat overlay
https://github.com/zackeryrsmith/bongocat-plus

bongocat osu sfml

Last synced: 24 days ago
JSON representation

An extensible and highly configurable Bongo Cat overlay

• Host: GitHub
• URL: https://github.com/zackeryrsmith/bongocat-plus
• Owner: ZackeryRSmith
• License: mit
• Created: 2023-01-17T05:02:13.000Z (almost 2 years ago)
• Default Branch: refactor
• Last Pushed: 2024-06-15T13:29:45.000Z (5 months ago)
• Last Synced: 2024-10-11T11:11:52.738Z (about 1 month ago)
• Topics: bongocat, osu, sfml
• Language: C++
• Homepage:
• Size: 3.19 MB
• Stars: 9
• Watchers: 1
• Forks: 1
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        



> [!NOTE]

the state of the refactor is not current with the in-dev branch... *so then why is this (refactor) the default?*

> Simply because I believe it's more indicative of this projects direction. If you want a version of Bongocat-Plus

that's fully complete. Please check out [in-dev](https://github.com/ZackeryRSmith/bongocat-plus/tree/in-dev)






  

    

  




  

  

  

  

  

  

  

  

  



Bongocat Plus

  


    The extensible and highly configurable Bongo Cat overlay!

    


    Original Project

    



    Report Bug

    ·

    Request Feature

  

  

  



# About the Project

An improved Bongo Cat overlay with ~~smooth paw movement~~ **(**[#27](https://github.com/ZackeryRSmith/bongocat-plus/issues/27)**)** and customizable lua scripting. Originally created due to the lack of support from developers in the original project (90+ unsolved issues), it now stands as a distinct iteration, thanks to a complete rewrite of the code. Bongocat-Plus owes its existence to the creators of Bongocat-Osu, so thank you!

# Compiling

To compile bongocat-plus you need to install some dependencies:

- **Git** *(this is optional)*

- **GCC**, **G++**, *any c/c++ compiler really*

- **Make**

- **CMake** >=3.10 *(may be lowered soon, see [#55](https://github.com/ZackeryRSmith/bongocat-plus/issues/55))*

- **SFML** >=2.5 *(not required on Windows, see [#28](https://github.com/ZackeryRSmith/bongocat-plus/issues/28))*

- **Lua** >=5.4 *(will be downloaded automatically if not found, see [#51](https://github.com/ZackeryRSmith/bongocat-plus/issues/51))*

*Now, that's out of the way*. We can now actually compile Bongocat-Plus

1. First clone the repository — assuming you have Git — thats as simple as `git clone https://github.com/ZackeryRSmith/bongocat-plus`

2. Jump into the repo with a `cd bongocat-plus`

3. Then to generate the make files run `cmake .`

4. Top it off by running `make`

Boom, you have just compiled Bongocat-Plus! If you experience any issues compiling bongocat-plus please make an [issue](https://github.com/ZackeryRSmith/bongocat-plus/issues). Thanks!




# Contributors

Huge thank you to all the people who have contributed to this project: