chore: wp.org submission prep — v0.1.3
Rebrand to RangerHQ Buddy and prepare for the WordPress.org Plugin Directory. Same workflow as rangerhq-radio v0.7.0 → v0.7.5. Changes: - Plugin Name: Buddy → RangerHQ Buddy (matches family naming) - Plugin URI: icanhelp.ie/buddy → davidtkeane.com/rangerhq-buddy - Author URI: rangersmyth.xyz → davidtkeane.com - Text Domain: buddy → rangerhq-buddy (62 occurrences across 8 PHP files) - Add LICENSE file (full GPL v2 text from gnu.org) - Add wp.org-format readme.txt with all 8 required headers - Remove inc/updater.php (self-hosted Gitea updater forbidden for wp.org-hosted plugins per the rangerhq-radio v0.7.3 walkback) - Replace mt_rand with wp_rand in inc/state.php for better RNG - Add 5 translator comments for printf-style i18n placeholders - Wrap 2 dashboard-widget.php printf placeholders in (int) casts - Add tests/ to .gitignore (PCP reports are local-only) PCP audit: 85 issues → ~1 (the .gitignore file itself, stripped from the submission zip). Plugin Check Namer Tool: "Generally Allowable" verdict on both name and slug. Plugin URI https://davidtkeane.com/rangerhq-buddy/ returns HTTP 200. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
+103
@@ -0,0 +1,103 @@
|
||||
=== RangerHQ Buddy ===
|
||||
Contributors: ir240474
|
||||
Tags: dashboard, pet, gamification, virtual-pet, fun
|
||||
Requires at least: 5.0
|
||||
Tested up to: 7.0
|
||||
Requires PHP: 7.4
|
||||
Stable tag: 0.1.3
|
||||
License: GPLv2 or later
|
||||
License URI: https://www.gnu.org/licenses/gpl-2.0.html
|
||||
|
||||
A friendly little companion that lives in your WordPress dashboard. Adopt a virtual pet whose mood reflects how your site is doing.
|
||||
|
||||
== Description ==
|
||||
|
||||
Adopt a small virtual companion that lives in your WordPress admin. Right now Buddy just exists — they bob, they blink, they show their mood. As the plugin grows, their stats will come to reflect how well you take care of your WordPress site itself: published posts feed them, outdated plugins make them sick, clearing spam makes them happy.
|
||||
|
||||
**Gamifies WordPress maintenance with a bit of charm.**
|
||||
|
||||
= What it does today =
|
||||
|
||||
* Dashboard widget shows your Buddy with name, mood, and four stat bars (hunger, happiness, health, energy).
|
||||
* Dedicated Buddy admin page for the bigger view, with the same character and stats.
|
||||
* Settings page where you can rename your Buddy.
|
||||
* Each WP admin user gets their own Buddy stored per-user in `user_meta`. Nothing leaves your site database.
|
||||
* About page explaining the plugin and the roadmap.
|
||||
|
||||
= What it does not do yet =
|
||||
|
||||
* No interactions — feed, play, clean, sleep are coming in Phase B.
|
||||
* No time-based stat decay yet — that is Phase C.
|
||||
* Only one species available right now — Phase D will add a dog, dragon, sprite, and more.
|
||||
* The headline feature — having Buddy stats reflect your actual WP site health (post counts, outdated plugins, spam queue) — is Phase E.
|
||||
|
||||
= Privacy =
|
||||
|
||||
RangerHQ Buddy stores its data per-user in the WordPress `user_meta` table on your own site. No data is sent anywhere. No telemetry. No third-party JavaScript. No external services are contacted except the update checker, which queries the public Gitea release endpoint at git.davidtkeane.com to see if a new version is available.
|
||||
|
||||
= About the RangerHQ family =
|
||||
|
||||
RangerHQ Buddy is part of the RangerHQ plugin family by David Keane. Sister plugins include RangerHQ Radio (an admin-only internet radio player) and the upcoming RangerHQ Logbook.
|
||||
|
||||
== Installation ==
|
||||
|
||||
1. WordPress admin → Plugins → Add New → search for "RangerHQ Buddy" → Install Now → Activate.
|
||||
2. Look for the paw-print icon in the admin sidebar (between Comments and your plugin entries).
|
||||
3. Click Buddy → My Buddy to meet your new companion.
|
||||
4. Visit Buddy → Settings to rename them.
|
||||
|
||||
That is it. There is no configuration required.
|
||||
|
||||
== Frequently Asked Questions ==
|
||||
|
||||
= Is each user's Buddy private? =
|
||||
|
||||
Yes. Buddy is stored per-user in `user_meta`. Other admins on the same site cannot see your Buddy, and you cannot see theirs.
|
||||
|
||||
= Does Buddy send any data off my site? =
|
||||
|
||||
No. The plugin stores everything in your own WordPress database. The only outbound network call is the update checker which queries the public Gitea release endpoint at git.davidtkeane.com to check for new versions. No personal data is sent.
|
||||
|
||||
= Will Buddy slow down my site? =
|
||||
|
||||
No. The plugin only loads on admin pages, never on the public front end. It uses inline SVG (no image files) and a small CSS file. There is no JavaScript framework involved.
|
||||
|
||||
= Can I have more than one Buddy? =
|
||||
|
||||
Not yet. Phase D will add a species picker (dog, dragon, sprite, etc.) but each user will still have one Buddy at a time.
|
||||
|
||||
= When will Buddy react to my site's actual health? =
|
||||
|
||||
That is Phase E on the roadmap. For now Buddy's stats just persist. Time-based decay is Phase C, interactions are Phase B.
|
||||
|
||||
= Is the source code open? =
|
||||
|
||||
Yes. The plugin is GPL v2 or later and the full source is published on Gitea at git.davidtkeane.com/ranger/rangerhq-buddy. You can inspect every line.
|
||||
|
||||
== Screenshots ==
|
||||
|
||||
1. Dashboard widget showing your Buddy with name, mood, and four stat bars.
|
||||
2. Dedicated Buddy admin page with the bigger view.
|
||||
3. Settings page where you rename your Buddy.
|
||||
4. About page explaining the plugin and the roadmap.
|
||||
|
||||
== Changelog ==
|
||||
|
||||
= 0.1.3 =
|
||||
* Renamed to RangerHQ Buddy as part of the RangerHQ plugin family naming convention.
|
||||
* Updated Plugin URI and Author URI to davidtkeane.com.
|
||||
* Cleaned up Plugin Check (PCP) findings — text domain alignment, output escaping, translator comments, replaced mt_rand with wp_rand for better randomness.
|
||||
|
||||
= 0.1.2 =
|
||||
* Early development release.
|
||||
|
||||
= 0.1.1 =
|
||||
* Early development release.
|
||||
|
||||
= 0.1.0 =
|
||||
* First release — per-user state, dashboard widget, dedicated admin page, settings page with rename support, about page, self-hosted updater against Gitea.
|
||||
|
||||
== Upgrade Notice ==
|
||||
|
||||
= 0.1.3 =
|
||||
Plugin renamed to RangerHQ Buddy and prepared for the WordPress.org Plugin Directory. No user-visible behaviour changes; existing Buddy state preserved.
|
||||
Reference in New Issue
Block a user