{"id":17549143,"url":"https://github.com/dolphywind/sfml-extension","last_synced_at":"2025-03-29T06:41:53.454Z","repository":{"id":111832911,"uuid":"606055187","full_name":"DolphyWind/SFML-Extension","owner":"DolphyWind","description":"SFML Extension is a set of classes/functions to speed up SFML Game development.","archived":false,"fork":false,"pushed_at":"2024-02-09T15:52:52.000Z","size":11487,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-03T19:15:41.649Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C++","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/DolphyWind.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":"2023-02-24T13:54:04.000Z","updated_at":"2024-02-09T15:50:19.000Z","dependencies_parsed_at":"2023-10-14T18:34:42.759Z","dependency_job_id":"82239d77-9db2-46e1-b8cc-dbf219bf0555","html_url":"https://github.com/DolphyWind/SFML-Extension","commit_stats":null,"previous_names":["dolphywind/sfml-extension"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DolphyWind%2FSFML-Extension","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DolphyWind%2FSFML-Extension/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DolphyWind%2FSFML-Extension/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DolphyWind%2FSFML-Extension/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DolphyWind","download_url":"https://codeload.github.com/DolphyWind/SFML-Extension/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246150416,"owners_count":20731419,"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":[],"created_at":"2024-10-21T02:49:58.718Z","updated_at":"2025-03-29T06:41:53.421Z","avatar_url":"https://github.com/DolphyWind.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"**THIS LIBRARY IS WORK IN PROGRESS. ANY FEATURE CAN CHANGE IN ANYTIME.**\n\n# SFEX - SFML Extension\nSFML Extension is a set of classes/functions to speed up SFML Game development.\n\n# Build Status\n[![Linux Build](https://github.com/DolphyWind/SFML-Extension/actions/workflows/linux_build.yml/badge.svg)](https://github.com/DolphyWind/SFML-Extension/actions/workflows/linux_build.yml)  \n[![Windows Build](https://github.com/DolphyWind/SFML-Extension/actions/workflows/windows_build.yml/badge.svg)](https://github.com/DolphyWind/SFML-Extension/actions/workflows/windows_build.yml)  \n[![MacOS build](https://github.com/DolphyWind/SFML-Extension/actions/workflows/mac_build.yml/badge.svg)](https://github.com/DolphyWind/SFML-Extension/actions/workflows/mac_build.yml)  \n[![Building Documentation](https://github.com/DolphyWind/SFML-Extension/actions/workflows/build_docs.yml/badge.svg)](https://github.com/DolphyWind/SFML-Extension/actions/workflows/build_docs.yml)\n\n# What This Library Provides\nSFEX currently contains 4 modules: General, Graphics, Managers and Numeric.\n\n- **General:** Classes that doesn't fit into other modules.\n    - Joystick - Simple joystick class for detecting and proccessing the joystick input. Only contains static methods.\n    - Keyboard - Simple keyboard class for detecting and proccessing the keyboard input. Only contains static methods.\n    - Listener - Listener class that can be instantiated unlike sf::Listener.\n    - Mouse - Simple mouse class for detecting and proccessing the mouse input. Only contains static methods.\n    - Multitype - A class for holding different types of variables under the name of one.\n    - Scene - Base scene class.\n    - Singleton - A singleton base class. \n    - StaticClass - A base class for static classes like sfex::Joystick, sfex::Keyboard, sfex::Mouse, sfex::Math.\n    - Stopwatch - Measures the elapsed time. Can be paused and resumed.\n- **Graphics:** Classes that are related to graphics.\n    - Animation - A class for sprite sheet animations.\n    - Color - A color class.\n    - Ellipse - An ellipse shape class.\n    - RoundedRectangle - A class for rectangles with smoothed out corners.\n    - Squircle - A squircle shape class based on x^4 + y^4 = r^4 definition.\n    - Star - A star shape class.\n- **Managers:** Managers for various Game Development related objects.\n    - AnimationManager - Manages animations for one sprite. Makes animations really easy to implement for SFML. Inherits from `ManagerBase\u003cAnimation\u003e`\n    - ManagerBase - Base manager class. All the other managers classes are derived from this class.\n    - MusicManager - Simple music manager class that stores musics in a hashmap and can play them. Inherits from `ManagerBase\u003csf::Music\u003e`\n    - OptionManager - Simple OptionManager that stores Options in a hashmap. It also support JSON format. Inherits from `ManagerBase\u003csfex::Option\u003e`\n    - SceneManager - Simple scene manager class. Stores shared pointers to Scene objects. Inherits from `ManagerBase\u003cstd::shared_ptr\u003cScene\u003e\u003e`\n    - SoundManager - Simple sound manager class that stores sounds and their buffers into seperate hashmaps. Inherits from `ManagerBase\u003csf::Sound\u003e`\n    - SpriteManager - Simple SpriteManager class. Inherits from `ManagerBase\u003csf::Sprite\u003e`\n    - TextureManager - Loads textures from various resources and stores them in a hashmap. Inherits from `ManagerBase\u003csf::Texture\u003e`\n- **Numeric:** Classes that are related to math.\n    - AngleSystem - A class for representing angle measurement systems.\n    - Gradient - A gradient class that allows you to create gradients between anything that supports addition and multiplication operators.\n    - Math - A math class that contains some math constants and functions. Only contains static methods and constants so it doesn't meant to be instantiated.\n    - `Vector\u003cN, T\u003e` - N-Dimensional Vector class.\n    - `Vector2\u003cT\u003e` - 2D Vector class that adds some linear algebra functions and operators to `sf::Vector2\u003cT\u003e`\n    - `Vector3\u003cT\u003e` - 3D Vector class that adds some linear algebra functions and operators to `sf::Vector3\u003cT\u003e`\n\n# Building SFEX\n\nTo build SFEX from source, make sure that you have cmake and make installed. Then, open up a terminal and run these commands.\n```bash\n# Clone the git repository\ngit clone https://github.com/DolphyWind/SFML-Extension\n# Change your directory\ncd SFML-Extension\n# Create build folder and move into it\nmkdir build\ncd build\n# Run CMake to generate build files\ncmake .. -DCMAKE_BUILD_TYPE=Release\n# Alternatively, you can also enable BUILD_DOCS option in CMake to generate documentation via Doxygen.\ncmake .. -DCMAKE_BUILD_TYPE=Release -DBUILD_DOCS=ON\n# Run make to build SFEX\nmake\n# Run tests (If BUILD_TESTS is set to ON)\nctest\n# Install SFEX to your system\nsudo make install\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdolphywind%2Fsfml-extension","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdolphywind%2Fsfml-extension","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdolphywind%2Fsfml-extension/lists"}