From 704da7d93443a1c57771d873bdfafa917d332cc1 Mon Sep 17 00:00:00 2001 From: Ellison Date: Fri, 28 Aug 2026 14:26:36 -0300 Subject: [PATCH] add initial coderabbit file (#403) * add initial coderabbit file * handling comments * typo * add security rules * reorder --- .coderabbit.yml | 46 ++++++++++++++++++++++++++++ .github/workflows/validate-links.yml | 13 -------- README.md | 14 ++++----- 3 files changed, 53 insertions(+), 20 deletions(-) create mode 100644 .coderabbit.yml delete mode 100644 .github/workflows/validate-links.yml diff --git a/.coderabbit.yml b/.coderabbit.yml new file mode 100644 index 0000000..cbd2481 --- /dev/null +++ b/.coderabbit.yml @@ -0,0 +1,46 @@ +reviews: + tools: + github-checks: + enabled: true + path_instructions: + - path: "README.md" + instructions: | + When reviewing changes to README.md, perform the following checks: + + ## 1. Link Validation + For every link in the markdown file (both new and existing), verify they are accessible: + - Only allow http and https URLs; flag any other protocol (ftp, file, mailto, javascript, etc.) + - Resolve the hostname and reject private, loopback, link-local, and other internal addresses (e.g., 127.0.0.1, 10.x.x.x, 192.168.x.x, 169.254.x.x, ::1) + - Follow HTTP redirects and revalidate each redirect target against the same rules + - Perform requests without credentials (no cookies, tokens, or auth headers) + - A link is valid if the final response returns 200 + - Flag broken links: 404, timeout, DNS failure, or any non-200 final status + - Report dead links as issues that need fixing + + ## 2. Alphabetical Ordering + Each section/subsection must have its entries in alphabetical order: + - Entries within `#### Assets/Placeholders`, `#### Spritesheet Tools`, etc. should be sorted A-Z by name + - The sort key is the link text (the part inside `[]`) + - Flag entries that are out of alphabetical order + + ## 3. License Emoji Validation + Each list entry must start with one of these valid emojis: + - `:free:` - Free + - `:tada:` - Open Source + - `:moneybag:` - Paid + - `:money_with_wings:` - Partially Free + + Flag any entries that: + - Use an invalid emoji (not one of the four above) + - Are missing an emoji entirely + - Use inconsistent emoji format (e.g., `🆓` instead of `:free:`) + pre_merge_checks: + custom_checks: + - name: "README Validation" + mode: "error" + instructions: | + If README.md is changed in this PR, validate the following: + 1. Link Validation: Only allow http/https URLs. Resolve hostnames and reject private, loopback, link-local, and internal addresses (127.0.0.1, 10.x.x.x, 192.168.x.x, 169.254.x.x, ::1). Follow redirects and revalidate each target. Perform requests without credentials. All links must return HTTP 200. Report any broken, invalid, or internal links. + 2. Alphabetical Ordering: Each subsection (e.g., Assets/Placeholders, Spritesheet Tools, Animation) must have entries sorted alphabetically by link text (the text inside []). + 3. License Emoji: Each list entry must start with exactly one of: :free:, :tada:, :moneybag:, :money_with_wings:. No other emojis or missing emojis are allowed. + Pass only if all three conditions are met. Fail if any condition is violated. diff --git a/.github/workflows/validate-links.yml b/.github/workflows/validate-links.yml deleted file mode 100644 index bdbd41d..0000000 --- a/.github/workflows/validate-links.yml +++ /dev/null @@ -1,13 +0,0 @@ -name: CI -on: [pull_request] -jobs: - validate-links: - runs-on: ubuntu-latest - steps: - - uses: actions/setup-go@v3 - id: go - with: - go-version: "^1.19.5" - - uses: actions/checkout@v3 - - run: go install github.com/ellisonleao/vl/cmd/vl@v0.1.0 - - run: vl -a 503,403 -t 30s -w html5gamedevelopment.com,poly.pizza,horde3d.org,p1.untergrund.net,bfxr.net,tigsource.com,gamesounds.xyz,jpct.net README.md diff --git a/README.md b/README.md index da3cf40..3c0c50d 100644 --- a/README.md +++ b/README.md @@ -90,8 +90,8 @@ _Great graphics placeholders and tools to turn that squared game into a picasso - :tada: [Libgdx Texture Packer](https://github.com/libgdx/libgdx/wiki/Texture-packer) - Texture Packer built into Libgdx - :free: [Littera](http://kvazars.com/littera) - Bitmap font generator - :free: [PixelChart Sprite Sheet Tools](https://pixelchart.app/tools/sprite-sheet-maker/) - Pack frames into a sheet with a JSON atlas, slice sheets back into PNGs, and convert between sheets and animated GIFs. Runs in the browser, no upload. -- :tada: [SnowB Bitmap Font](https://snowb.org/) - Bitmap font generator - :free: [ShoeBox](http://renderhjs.net/shoebox/) - Adobe Air based app with game and ui related tools. +- :tada: [SnowB Bitmap Font](https://snowb.org/) - Bitmap font generator - :money_with_wings: [TexturePacker](https://www.codeandweb.com/texturepacker) - Great spritesheet creation editor. - :tada: [Tilesplit](https://github.com/AlexPoulsen/tilesplit) - CLI text-based tilesheet splitter and namer. Turn a spritesheet into many separate files with names you pick, or not if you don't care. Support templates and textures that are not all the same size. @@ -130,10 +130,10 @@ _Great graphics placeholders and tools to turn that squared game into a picasso - :moneybag: [AnimKit](https://www.nasrtech.dev/animkit) - Maya animation toolkit with live tweening, smart keys, motion trails, a pose library and Mixamo retargeting. An affordable animBot alternative. - :money_with_wings: [Cascadeur](https://cascadeur.com/) - Powerful physics-based 3D character animation -- :tada: [LWF](http://gree.github.io/lwf/) - Lightweight SWF. LWF is an animation engine which can play animation data converted from FLASH contents in HTML5, Unity, Cocos2d-x, iOS UIKit, and more. - :moneybag: [Fusion Character Animator](http://loopengo.free.fr/) - small tool for Clickteam Fusion 2.5 to facilitate the animation of 2D character sprites for developers. - :free: [GameAsset.net](https://gameasset.net/) - 10,000+ free CC0 character animations, previewable in 3D with GLB download. -- 🆓 [GraphicsDale](https://graphicsgale.com/us/) - Powerful tool for spriting and pixel art. +- :free: [GraphicsDale](https://graphicsgale.com/us/) - Powerful tool for spriting and pixel art. +- :tada: [LWF](http://gree.github.io/lwf/) - Lightweight SWF. LWF is an animation engine which can play animation data converted from FLASH contents in HTML5, Unity, Cocos2d-x, iOS UIKit, and more. - :moneybag: [Mixamo](https://www.mixamo.com/#/) - tool for auto auto rigging and animation of 3D humanoid models, - :tada: [NixieFX](https://nixiefx.com/) - Free browser-based particle and VFX editor for Three.js and PixiJS web games, with an open-source runtime. - :tada: [Pixel Composer](https://github.com/Ttanasart-pt/Pixel-Composer) - Powerful node-based VFX editor for pixel art @@ -145,6 +145,7 @@ _Great graphics placeholders and tools to turn that squared game into a picasso - :moneybag: [Affinity Designer](https://affinity.serif.com/de/designer) - Vector graphics editor with a bunch of features which also supports Adobe file formats - :moneybag: [Affinity Photo](https://affinity.serif.com/de/photo) - Photo and raster graphics editor which works together with Adobe file formats and Affinity Designer - :money_with_wings: [Aseprite](http://www.aseprite.org/) - animated sprite editor & pixel art tool. +- :free: [Charas](http://charas-project.net/index.php) - Charas is a charset generator for RPG Maker. - :tada: [Gimp](http://www.gimp.org/) - GNU Image Manipulation Program. It is a freely distributed piece of software for such tasks as photo retouching, image composition and image authoring. - :tada: [Inkscape](https://inkscape.org/en/) - An open-source vector graphics editor similar to Adobe Illustrator, Corel Draw, Freehand, or Xara X. - :tada: [Krita](https://krita.org/) - Krita is a professional FREE and open source painting program. It is made by artists that want to see affordable art tools for everyone. @@ -157,23 +158,22 @@ _Great graphics placeholders and tools to turn that squared game into a picasso - :moneybag: [Pickle](http://www.pickleeditor.com/) - Another Pixel art Editor. - :tada: [PiskelApp](http://www.piskelapp.com/) - Free Online Pixel Art and Animated Sprite Tool. - :moneybag: [Pixelmator](http://www.pixelmator.com) - Full-featured image editing app for the Mac +- :money_with_wings: [Pixanima](https://pixanima.app) - Free in-browser pixel-art and animation editor with layers, a frame timeline, GIF/sprite-sheet export, and an optional AI assistant. - :moneybag: [Pixelator](http://pixelatorapp.com) - Turn any image into fancy pixel-art - :moneybag: [Pixen](https://github.com/Pixen/Pixen) - Pixel Art Editor for OSX - :free: [project one](http://p1.untergrund.net) - A picture converter and editor for the Commodore 64 covering different graphics mode of this computer. Windows only - :moneybag: [PyxelEdit](http://pyxeledit.com/) - Pixel art editor designed to make it fun and easy to make tilesets, levels and animations. - :free: [REXPaint](https://www.gridsagegames.com/rexpaint/) - a powerful and user-friendly ASCII art editor. - :tada: [rx](https://rx.cloudhead.io/) - a modern & minimalist pixel editor -- :free: [Tilemancer](https://led.itch.io/tilemancer) - A quick procedural tile creator designed for pixel-art games. -- :free: [Timanthes](http://csdb.dk/release/?id=75871) - A pixel art editor for the Commodore 64 computer running on Windows -- :free: [Charas](http://charas-project.net/index.php) - Charas is a charset generator for RPG Maker. - :tada: [Sprite Fusion Pixel Art Cleaner](https://www.spritefusion.com/pixel-snapper) - Convert messy AI-generated pixel art into true, pixel-perfect pixel art. [Source](https://github.com/Hugo-Dz/spritefusion-pixel-snapper) - :free: [Spritemate](http://www.spritemate.com) - Online Editor for Commodore 64 Sprites - :tada: [Squoosh](https://squoosh.app) - Make images smaller using best-in-class codecs, right in the browser. - :tada: [SVGcode](https://svgco.de/) - SVGcode is a Progressive Web App that lets you convert raster images like JPG, PNG, GIF, WebP, AVIF, etc. to vector graphics in SVG format. - :free: [SVG to PNG](https://vexlio.com/svg-to-png/) - Batch convert unlimited SVGs to PNG rasters. Privacy-preserving, doesn't require uploading your assets. +- :free: [Tilemancer](https://led.itch.io/tilemancer) - A quick procedural tile creator designed for pixel-art games. +- :free: [Timanthes](http://csdb.dk/release/?id=75871) - A pixel art editor for the Commodore 64 computer running on Windows - :money_with_wings: [Vector Magic](https://vectormagic.com/) - Free Raster to Vector Graphics Converter - :tada: [VTracer](https://www.visioncortex.org/vtracer/) - Raster to Vector Graphics Converter built on top of visioncortex -- :money_with_wings: [Pixanima](https://pixanima.app) - Free in-browser pixel-art and animation editor with layers, a frame timeline, GIF/sprite-sheet export, and an optional AI assistant. #### Modeling