{"id":26053310,"url":"https://github.com/ryouze/vroom","last_synced_at":"2026-06-06T15:02:44.927Z","repository":{"id":280705986,"uuid":"942892902","full_name":"ryouze/vroom","owner":"ryouze","description":"[WIP] Cross-platform 2D racing game.","archived":false,"fork":false,"pushed_at":"2025-03-04T21:08:56.000Z","size":896,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-04T22:20:42.640Z","etag":null,"topics":["car","cmake","cmake-fetchcontent","cpp","cross-platform","game","imgui","racing","sfml"],"latest_commit_sha":null,"homepage":"https://ryouze.net/","language":"CMake","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ryouze.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-03-04T21:04:53.000Z","updated_at":"2025-03-04T21:14:43.000Z","dependencies_parsed_at":"2025-03-04T22:33:13.436Z","dependency_job_id":null,"html_url":"https://github.com/ryouze/vroom","commit_stats":null,"previous_names":["ryouze/vroom"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryouze%2Fvroom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryouze%2Fvroom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryouze%2Fvroom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryouze%2Fvroom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ryouze","download_url":"https://codeload.github.com/ryouze/vroom/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242515285,"owners_count":20141990,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["car","cmake","cmake-fetchcontent","cpp","cross-platform","game","imgui","racing","sfml"],"created_at":"2025-03-08T07:27:54.409Z","updated_at":"2025-03-08T07:27:54.912Z","avatar_url":"https://github.com/ryouze.png","language":"CMake","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vroom\n\n\u003c!-- [![CI](https://github.com/ryouze/vroom/actions/workflows/ci.yml/badge.svg)](https://github.com/ryouze/vroom/actions/workflows/ci.yml)\n[![Release](https://github.com/ryouze/vroom/actions/workflows/release.yml/badge.svg)](https://github.com/ryouze/vroom/actions/workflows/release.yml)\n![Release version](https://img.shields.io/github/v/release/ryouze/vroom) --\u003e\n\nvroom is a cross-platform 2D racing game.\n\n\u003c!-- ![Screenshot](assets/screenshot.jpeg) --\u003e\n\n\n## Motivation\n\nI wanted to develop a simple game that would expand my knowledge of SFML, ImGui, and C++ in general. If possible, I'd like it to be playable on my Steam Deck.\n\n\n### Progress\n\n**Completed:**\n- [x] Basic SFML windowing.\n- [x] Basic ImGui integration with SFML.\n- [x] Basic window resizing.\n  - [x] Maximize fix for macOS.\n\n**To-Do:**\n- [ ] Robust window resizing (with relative positioning).\n  - [ ] Fix resizing with Rectangle on macOS (if possible).\n  - [ ] Research SFML's `sf::View` class.\n- [ ] Toggle-able fullscreen mode.\n  - [ ] Perhaps via ImGui?\n- [ ] Platform-specific directories for settings.\n  - [ ] Saving of ImGui settings to a platform-specific location instead of relative to the binary (especially on macOS).\n- [ ] Basic logging - console \u0026 file.\n- [ ] Better macOS plist.\n\n**Later:**\n- [ ] Basic audio.\n- [ ] Automated tests \u0026 CI/CD (once the project is more mature).\n  - [ ] Use Catch2 or other testing framework instead of reinventing the wheel again.\n- [ ] Less hacky setting of titlebar icon.\n- [ ] BETTER PACKAGING! Seriously!\n  - [ ] Less hacky macOS packaging.\n  - [ ] CPack?\n  - [ ] .dmg and .exe installers.\n- [ ] Gamepad support (maybe? Steam Deck can use Steam Input).\n\n\n## Features\n\n- Written in modern C++ (C++17).\n- Comprehensive documentation with doxygen-style comments.\n- Automatic third-party dependency management using CMake's [FetchContent](https://www.foonathan.net/2022/06/cmake-fetchcontent/).\n- No missing STL headers thanks to [header-warden](https://github.com/ryouze/header-warden).\n\n\n## Tested Systems\n\nThis project has been tested on the following systems:\n\n- macOS 15.3 (Sequoia)\n\u003c!-- - Manjaro 24.0 (Wynsdey)\n- Windows 11 23H2 --\u003e\n\nAutomated testing is also performed on the latest versions of macOS, GNU/Linux, and Windows using GitHub Actions.\n\n\n\u003c!-- ## Pre-built Binaries\n\nPre-built binaries are available for macOS (ARM64), GNU/Linux (x86_64), and Windows (x86_64). You can download the latest version from the [Releases](../../releases) page.\n\nTo remove macOS quarantine, use the following commands:\n\n```sh\nxattr -d com.apple.quarantine vroom-macos-arm64.app\nchmod +x vroom-macos-arm64.app\n```\n\nOn Windows, the OS might complain about the binary being unsigned. You can bypass this by clicking on \"More info\" and then \"Run anyway\". --\u003e\n\n\n## Requirements\n\nTo build and run this project, you'll need:\n\n- C++17 or higher\n- CMake\n\n\n## Build\n\nFollow these steps to build the project:\n\n1. **Clone the repository**:\n\n    ```sh\n    git clone https://github.com/ryouze/vroom.git\n    ```\n\n2. **Generate the build system**:\n\n    ```sh\n    cd vroom\n    mkdir build \u0026\u0026 cd build\n    cmake ..\n    ```\n\n    Optionally, you can disable compile warnings by setting `ENABLE_COMPILE_FLAGS` to `OFF`:\n\n    ```sh\n    cmake .. -DENABLE_COMPILE_FLAGS=OFF\n    ```\n\n3. **Compile the project**:\n\n    To compile the project, use the following command:\n\n    ```sh\n    cmake --build . --parallel\n    ```\n\nAfter successful compilation, you can run the program using `./vroom` (`open vroom.app` on macOS). However, it is highly recommended to install the program, so that it can be run from any directory. Refer to the [Install](#install) section below.\n\n\u003e [!TIP]\n\u003e The mode is set to `Release` by default. To build in `Debug` mode, use `cmake .. -DCMAKE_BUILD_TYPE=Debug`.\n\n\n## Install\n\nIf not already built, follow the steps in the [Build](#build) section and ensure that you are in the `build` directory.\n\nTo install the program, use the following command:\n\n```sh\nsudo cmake --install .\n```\n\nOn macOS, this will install the program to `/Applications`. You can then run `vroom.app` from the Launchpad, Spotlight, or by double-clicking the app in Finder.\n\n\n## Usage\n\nTo start the program, simply run the `vroom` executable (`vroom.app` on macOS, `open /Applications/vroom.app` to run from the terminal).\n\n\n\u003c!-- ### Controls\n\ntext --\u003e\n\n\n## Testing\n\nTests are included in the project but are not built by default.\n\nTo enable and build the tests manually, run the following commands from the `build` directory:\n\n```sh\ncmake .. -DBUILD_TESTS=ON\ncmake --build . --parallel\nctest --output-on-failure\n```\n\n\n## Credits\n\n**Libraries:**\n- [Dear ImGui](https://github.com/ocornut/imgui)\n- [fmt](https://github.com/fmtlib/fmt)\n- [ImGui-SFML](https://github.com/SFML/imgui-sfml)\n- [Simple and Fast Multimedia Library 3](https://github.com/sfml/sfml)\n\n**Graphics:**\n- [PlayCover](https://macosicons.com/#/u/helloman)\n\n\n## Contributing\n\nAll contributions are welcome.\n\n\n## License\n\nThis project is licensed under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryouze%2Fvroom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fryouze%2Fvroom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryouze%2Fvroom/lists"}