Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 22 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,44 @@
Holiday Flare
=================
Allows an admin to display seasonal holiday flares on their forum. The Christmas and Valentine's Day themes can be enabled or disabled independently in the ACP via `EXTENSIONS --> Holiday Flare --> Settings`.
# Holiday Flare

[![CI](https://github.com/phpbbmodders/holiday_flare/actions/workflows/ci.yml/badge.svg)](https://github.com/phpbbmodders/holiday_flare/actions/workflows/ci.yml)
[![Tests](https://github.com/phpbbmodders/holiday_flare/actions/workflows/tests.yml/badge.svg)](https://github.com/phpbbmodders/holiday_flare/actions/workflows/tests.yml) [![Lint](https://github.com/phpbbmodders/holiday_flare/actions/workflows/lint.yml/badge.svg)](https://github.com/phpbbmodders/holiday_flare/actions/workflows/lint.yml)

Adds seasonal decorations — Christmas and Valentine's Day — that you switch on from the ACP.

## Features
* Enable/disable each holiday flare independently
* Christmas: a Santa hat in the header corner, plus a smaller matching icon on the forum list (prosilver, Green-Style-Slim, pro_ubuntu_lucid, proflat)
* Valentine's Day: a matching header-corner icon (prosilver, Green-Style-Slim, pro_ubuntu_lucid, proflat)

See [docs/screenshots](docs/screenshots) for both themes rendered.
- Each holiday theme can be switched on or off on its own.
- Christmas: a Santa hat in the header corner, plus a smaller matching icon on the forum list.
- Valentine's Day: a matching header-corner icon.
- Supported styles: prosilver, Green-Style-Slim, pro_ubuntu_lucid and proflat.

See [docs/screenshots](docs/screenshots) for both themes.

## Requirements

* PHP 7.4 or later
* phpBB 3.3.19 or later (3.3.x)
- phpBB 3.3.19 or later
- PHP 7.4 or later

## Installation

### 1. clone
Clone (or download and move) the repository into the folder phpBB3/ext/phpbbmodders/holidayflare:

```
cd phpBB3
git clone https://github.com/phpbbmodders/holiday_flare.git ext/phpbbmodders/holidayflare/
```

### 2. activate
Go to ACP -> `CUSTOMISE -> Manage extensions ->` enable Holiday Flare

### 3. configure
1. Copy the extension to `/ext/phpbbmodders/holidayflare`
2. In the Administration Control Panel, go to **Customise → Manage extensions**
3. Enable the **Holiday Flare** extension
4. Under **ACP → Extensions → Holiday Flare → Settings**, set *Christmas Theme* and/or *Valentine Theme* to *Yes*

Go to ACP -> `EXTENSIONS --> Holiday Flare --> Settings ->` set *Christmas Theme* and/or *Valentine Theme* to *Yes*
## Contributing

## Support
Contributions are welcome!

- **Bug reports**: [Open an issue](https://github.com/phpbbmodders/holiday_flare/issues).
- **Everything else** (questions, feature requests, general discussion): [the phpBB.com support thread](https://www.phpbb.com/community/viewtopic.php?f=456&t=2277491).

## Contributing

Contributions are welcome! Pull requests are welcome for bug fixes or discussed features.
- **Everything else** (questions, feature requests, ideas, general discussion): [Use Discussions](https://github.com/orgs/phpbbmodders/discussions), or the [community forum](https://www.phpbbmodders.com/community/). The [phpBB.com support thread](https://www.phpbb.com/community/viewtopic.php?f=456&t=2277491) is still open too.
- Pull requests are welcome for bug fixes or discussed features.

## Acknowledgments

- Converted to a phpBB extension by Matt Friedman ([MattF](https://www.phpbb.com/customise/db/author/mattf)).
- The Valentine's Day theme was originally contributed by [TWEagle](https://github.com/TWEagle).
- The jQuery-based header banner was originally contributed by Rich McGirr ([rmcgirr83](https://github.com/rmcgirr83)), extended to additional styles by Raphaël M. ([Galixte](https://github.com/Galixte)).
- French translation by Raphaël M. ([Galixte](https://github.com/Galixte)); Arabic translation by Basil Taha Alhitary.
- Modernization (current PHP/phpBB version support, a real bug fix confirmed against a live phpBB install, reconciling several long-open pull requests, and this documentation) assisted by [Claude](https://www.anthropic.com/claude).

## License
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "phpbbmodders/holidayflare",
"type": "phpbb-extension",
"description": "Allows an admin to display various seasonal holiday flares to their default style. The images/javascript can be enable/disabled in the ACP via EXTENSIONS --> Holiday Flare --> Settings",
"description": "Adds seasonal decorations — Christmas and Valentine's Day — that you switch on from the ACP.",
"homepage": "https://www.phpbbmodders.com/",
"version": "2.1.0",
"keywords": [
Expand Down
Loading