{"id":20526546,"url":"https://github.com/gbdev/rgbds-deb","last_synced_at":"2025-03-06T01:44:49.098Z","repository":{"id":220284562,"uuid":"750805534","full_name":"gbdev/rgbds-deb","owner":"gbdev","description":"Alright, let's get RGBDS into Debian repositories","archived":false,"fork":false,"pushed_at":"2024-02-18T13:35:00.000Z","size":10126,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"debian","last_synced_at":"2024-10-29T14:51:24.843Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/gbdev.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.rst","funding":".github/FUNDING.yml","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},"funding":{"open_collective":"gbdev","github":"gbdev"}},"created_at":"2024-01-31T11:02:12.000Z","updated_at":"2024-05-02T17:50:29.000Z","dependencies_parsed_at":"2024-02-18T14:47:36.535Z","dependency_job_id":null,"html_url":"https://github.com/gbdev/rgbds-deb","commit_stats":{"total_commits":2148,"total_committers":61,"mean_commits":35.21311475409836,"dds":0.5595903165735567,"last_synced_commit":"22baba8b8524cb51f4875d417b2487bbad1829af"},"previous_names":["gbdev/rgbds-deb"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gbdev%2Frgbds-deb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gbdev%2Frgbds-deb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gbdev%2Frgbds-deb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gbdev%2Frgbds-deb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gbdev","download_url":"https://codeload.github.com/gbdev/rgbds-deb/tar.gz/refs/heads/debian","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241828392,"owners_count":20026901,"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-11-15T23:14:39.385Z","updated_at":"2025-03-06T01:44:49.073Z","avatar_url":"https://github.com/gbdev.png","language":"C++","funding_links":["https://opencollective.com/gbdev","https://github.com/sponsors/gbdev"],"categories":[],"sub_categories":[],"readme":"RGBDS\n=====\n\nRGBDS (Rednex Game Boy Development System) is a free assembler/linker package\nfor the Game Boy and Game Boy Color. It consists of:\n\n- rgbasm (assembler)\n- rgblink (linker)\n- rgbfix (checksum/header fixer)\n- rgbgfx (PNG‐to‐Game Boy graphics converter)\n\nThis is a fork of the original RGBDS which aims to make the programs more like\nother UNIX tools.\n\nThis toolchain is maintained `on GitHub \u003chttps://github.com/gbdev/rgbds\u003e`__.\n\nThe documentation of this toolchain can be viewed online `here \u003chttps://rgbds.gbdev.io/docs/\u003e`__.\nIt is generated from the man pages found in this repository.\nThe source code of the website itself is on GitHub as well under the repo\n`rgbds-www \u003chttps://github.com/gbdev/rgbds-www\u003e`__.\n\nIf you want to contribute or maintain RGBDS, and have questions regarding the code, its\norganisation, etc. you can find the maintainers `on the gbdev community channels \u003chttps://gbdev.io/chat\u003e`__\nor via mail at ``rgbds at gbdev dot io``.\n\n1. Installing RGBDS\n-------------------\n\nThe `installation procedure \u003chttps://rgbds.gbdev.io/install\u003e`__ is available\nonline for various platforms. `Building from source \u003chttps://rgbds.gbdev.io/install/source\u003e`__\nis possible using ``make`` or ``cmake``; follow the link for more detailed instructions.\n\n.. code:: sh\n\n    make\n    sudo make install\n\n.. code:: sh\n\n    cmake -S . -B build -DCMAKE_BUILD_TYPE=Release\n    cmake --build build\n    cmake --install build\n\n2. RGBDS Folder Organization\n----------------------------\n\nThe RGBDS source code file structure is as follows:\n\n::\n\n       .\n       ├── .github/\n       │   ├── scripts/\n       │   │   └── ...\n       │   └── workflows/\n       │       └── ...\n       ├── contrib/\n       │   ├── zsh_compl/\n       │   │   └── ...\n       │   └── ...\n       ├── include/\n       │   └── ...\n       ├── man/\n       │   └── ...\n       ├── src/\n       │   ├── asm/\n       │   │   └── ...\n       │   ├── extern/\n       │   │   └── ...\n       │   ├── fix/\n       │   │   └── ...\n       │   ├── gfx/\n       │   │   └── ...\n       │   ├── link/\n       │   │   └── ...\n       │   ├── CMakeLists.txt\n       │   └── ...\n       ├── test/\n       │   ├── ...\n       │   └── run-tests.sh\n       ├── .clang-format\n       ├── CMakeLists.txt\n       ├── Dockerfile\n       ├── Makefile\n       └── README.rst\n\n.. |clang-format| replace:: ``clang-format``\n.. _clang-format: https://clang.llvm.org/docs/ClangFormat.html\n\n- ``.github/`` - files and scripts related to the integration of the RGBDS codebase with\n  GitHub.\n\n  * ``scripts/`` - scripts used by workflow files.\n  * ``workflows/`` - CI workflow description files.\n\n- ``contrib/`` - scripts and other resources which may be useful to users and developers of\n  RGBDS.\n\n  * ``zsh_compl`` contains tab completion scripts for use with zsh. Put them somewhere in\n    your ``fpath``, and they should auto-load.\n\n  * ``bash_compl`` contains tab completion scripts for use with bash. Run them with ``source``\n    somewhere in your ``.bashrc``, and they should load every time you open a shell.\n\n- ``include/`` - header files for the respective source files in `src`.\n\n- ``man/`` - manual pages.\n\n- ``src/`` - source code of RGBDS.\n\n  * Note that the code unique to each RGBDS tool is stored in its respective subdirectory\n    (rgbasm -\u003e ``src/asm/``, for example). ``src/extern/`` contains code imported from\n    external sources.\n\n- ``test/`` - testing framework used to verify that changes to the code don't break or\n  modify the behavior of RGBDS.\n\n- ``.clang-format`` - code style for automated C++ formatting with |clang-format|_.\n\n- ``Dockerfile`` - defines how to build RGBDS with Docker.\n\n3. History\n----------\n\n- 1996-10-01: Carsten Sørensen (a.k.a. SurfSmurf) releases\n  `xAsm \u003chttp://otakunozoku.com/RGBDSdocs/asm.htm\u003e`__,\n  `xLink \u003chttp://otakunozoku.com/RGBDSdocs/link.htm\u003e`__, and\n  `RGBFix \u003chttp://otakunozoku.com/RGBDSdocs/fix.htm\u003e`__,\n  a Game Boy SM83 (GBZ80) assembler/linker system for DOS/Win32.\n\n- 1997-07-03: Sørensen releases `ASMotor \u003chttp://otakunozoku.com/RGBDSdocs/geninfo.htm\u003e`__,\n  packaging the three programs together and moving towards making them a\n  general-purpose target-independent system.\n\n- 1999-08-01: Justin Lloyd (a.k.a. Otaku no Zoku) adapts ASMotor to re-focus\n  on SM83 assembly/machine code, and releases this version as\n  `RGBDS \u003chttp://otakunozoku.com/rednex-gameboy-development-system/\u003e`__.\n\n- 2009-06-11: Vegard Nossum adapts the code to be more UNIX-like and releases\n  this version as `rgbds-linux \u003chttps://github.com/vegard/rgbds-linux\u003e`__.\n\n- 2010-01-12: Anthony J. Bentley `forks \u003chttps://github.com/bentley\u003e`__ Nossum's\n  repository. The fork becomes the reference implementation of RGBDS.\n\n- 2015-01-18: stag019 begins implementing `rgbgfx \u003chttps://github.com/stag019/rgbgfx\u003e`__,\n  a PNG‐to‐Game Boy graphics converter, for eventual integration into RGBDS.\n\n- 2016-09-05: rgbgfx is `integrated \u003chttps://github.com/gbdev/rgbds/commit/c3c31138ddbd8680d4e67957e387f2816798a71b\u003e`__\n  into Bentley's repository.\n\n- 2017-02-23: Bentley's repository is moved to the `rednex \u003chttps://github.com/rednex\u003e`__\n  organization.\n\n- 2018-01-26: The codebase is `relicensed \u003chttps://github.com/gbdev/rgbds/issues/128\u003e`__\n  under the MIT license.\n\n- 2020-09-15: The repository is `moved \u003chttps://github.com/gbdev/rgbds/issues/567\u003e`__\n  to the `gbdev \u003chttps://github.com/gbdev\u003e`__ organization.\n\n- 2022-05-17: The `rgbds.gbdev.io \u003chttps://rgbds.gbdev.io\u003e`__ website for RGBDS\n  documentation and downloads is published.\n\n4. Acknowledgements\n-------------------\n\nRGBGFX generates palettes using algorithms found in the paper\n`\"Algorithms for the Pagination Problem, a Bin Packing with Overlapping Items\" \u003chttp://arxiv.org/abs/1605.00558\u003e`__\n(`GitHub \u003chttps://github.com/pagination-problem/pagination\u003e`__, MIT license),\nby Aristide Grange, Imed Kacem, and Sébastien Martin.\n\nRGBGFX's color palette was taken from `SameBoy \u003chttps://sameboy.github.io\u003e`__, with permission and help by `LIJI \u003chttps://github.com/LIJI32\u003e`__.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgbdev%2Frgbds-deb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgbdev%2Frgbds-deb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgbdev%2Frgbds-deb/lists"}