{"id":19695433,"url":"https://github.com/tanis2000/bone","last_synced_at":"2025-02-27T10:51:06.897Z","repository":{"id":138035203,"uuid":"191948345","full_name":"tanis2000/bone","owner":"tanis2000","description":"Bone, the Binocle project generator","archived":false,"fork":false,"pushed_at":"2023-02-08T14:44:39.000Z","size":5453,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-10T09:33:59.026Z","etag":null,"topics":["c","cpp","engine","gamedev","generator","rust-lang"],"latest_commit_sha":null,"homepage":"","language":"Lua","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/tanis2000.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":"2019-06-14T13:31:30.000Z","updated_at":"2023-02-08T14:44:43.000Z","dependencies_parsed_at":null,"dependency_job_id":"d72794d0-fdcc-4175-a153-8c8f5fdd30e5","html_url":"https://github.com/tanis2000/bone","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tanis2000%2Fbone","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tanis2000%2Fbone/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tanis2000%2Fbone/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tanis2000%2Fbone/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tanis2000","download_url":"https://codeload.github.com/tanis2000/bone/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241005774,"owners_count":19892863,"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":["c","cpp","engine","gamedev","generator","rust-lang"],"created_at":"2024-11-11T19:27:51.463Z","updated_at":"2025-02-27T10:51:06.878Z","avatar_url":"https://github.com/tanis2000.png","language":"Lua","readme":"# Bone, the Binocle project generator\n\n[![Build Status](https://travis-ci.com/tanis2000/bone.svg?branch=master)](https://travis-ci.com/tanis2000/bone)\n\nBone is a project generator and build tool for the Binocle engine, a 2D/3D videogame and application engine.\n\nThe ultimate goal of Bone is to relieve the developer from all the tedious tasks like configuring CMake for different architectures, create build scripts, etc...\n\nThe idea isn't new and it can feel like yet another wrapper around CMake, and it actually is like that :-P\n[Fips](https://github.com/floooh/fips) is a good alternative if you want to manage your C/C++ project on your own.\nThe actual idea came from the [snow](https://github.com/snowkit/snow) and [lime](https://github.com/openfl/lime) tools. They are pretty similar but written in JavaScript and Haxe. I definitely used those as a source of inspiration.\n\nBone is far from being finished, but it's good enough for my usage and can probably be of use to others as well. I can always use a hand to support more target architectures, so feel free to submit PR or open issues as needed.\n\n## Install Bone\n\nThe quickest way is to download the binaries on the [Releases](https://github.com/tanis2000/bone/releases) page.\nJust get the one for your OS and you're ready to go.\n\nOtherwise you can just clone this repository and it yourself. You will need a recent Rust toolchain to do that.\n\n## Create a new project\n\nBone supports both the C version and C++ version of Binocle. As of the time I'm writing this, only the C version is available in the wild. The C++ version is still under closed source and will eventually be released in the future for historic reasons.\n\nLet's say that we want to create a Binocle C application called `project` in the `./project` folder.\n\n```sh\nbone init --engine binocle-c project ./project\n```\n\nThis will create the `./project` folder and initialize a new Binocle C project called `project` with a skeleton of an application.\n\n## Build a project\n\nTo build a project just do:\n\n```sh\nbone build ./project\n```\n\nThis will build the application for the hosting architecture. You can force the architecture by specifying the architecture from the following list:\n\n- mac\n- windows\n- linux\n- ios\n- android\n- web\n\ni.e. if you want to build for `ios` just do:\n\n```sh\nbone build ./project ios\n```\n\n## Run a project\n\nYou can easily run a project with the following command:\n\n```sh\nbone run ./project\n```\n\nJust like with the `build` command, you can specify a target architecture.\ni.e. if you want to run the `ios` version, just do:\n\n```sh\nbone run ./project ios\n```\n\n## Update a project\n\nFrom time to time I update the CMake scripts to reflect changes in development environments and to improve the user experience. In that cas you can `update` your project.\n\nPlease make sure to backup your work before doing so as it can break your build scripts.\n\nTo update your scripts, just run:\n\n```sh\nbone update ./project\n```\n\n## Upgrade a project\n\nIf you want to upgrade to the latest version of Binocle, just run the following command:\n\n```sh\nbone upgrade ./project\n```\n\nBinocle is a submodule of your project so it's just like doing a remote pull from the Binocle repository.\n\n## LICENSE\n\nMIT License\n\nCopyright (c) 2019 Valerio Santinelli\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftanis2000%2Fbone","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftanis2000%2Fbone","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftanis2000%2Fbone/lists"}