fictioneer/README.md

49 lines
4.5 KiB
Markdown
Raw Normal View History

2023-01-21 01:31:34 +01:00
<p align="center"><img src="./repo/assets/fictioneer_logo.svg?raw=true" alt="Fictioneer"></p>
<p align="center">
2023-06-29 12:45:54 +02:00
<a href="https://github.com/Tetrakern/fictioneer"><img alt="Theme: 5.4" src="https://img.shields.io/badge/theme-5.4-blue?style=flat" /></a>
2023-01-21 01:31:34 +01:00
<a href="LICENSE.md"><img alt="License: GPL v3" src="https://img.shields.io/badge/license-GPL%20v3-blue?style=flat" /></a>
<a href="https://wordpress.org/download/"><img alt="WordPress 6.0+" src="https://img.shields.io/badge/WordPress-%3E%3D6.0-blue?style=flat" /></a>
2023-02-07 21:02:44 +01:00
<a href="https://www.php.net/"><img alt="PHP: 7.4+" src="https://img.shields.io/badge/php-%3E%3D7.4-blue?logoColor=white&style=flat" /></a>
2023-01-21 01:31:34 +01:00
<a href="https://ko-fi.com/tetrakern"><img alt="Support me on Ko-fi" src="https://img.shields.io/badge/-Ko--fi-FF5E5B?logo=kofi&logoColor=white&style=flat&labelColor=434B57" /></a>
</p>
<p align="center"><strong>WordPress theme and standalone solution for publishing and reading <a href="https://en.wikipedia.org/wiki/Web_fiction">web fictions</a>.</strong></p>
2023-02-19 15:36:26 +01:00
<p align="center"><a href="https://fictioneer-theme.com/" target="_blank">Demo</a> &bull; <a href="https://github.com/Tetrakern/fictioneer/releases">Download</a> &bull; <a href="DOCUMENTATION.md">Documentation</a> &bull; <a href="INSTALLATION.md">Installation</a> &bull; <a href="API.md">API</a> &bull; <a href="DEVELOPMENT.md">Development</a> &bull; <a href="FAQ.md">FAQ</a> &bull; <a href="CREDITS.md">Credits</a> &bull; <a href="https://discord.gg/tVfDB7EbaP" target="_blank">Discord</a></p>
2023-01-21 01:31:34 +01:00
<br>
## About
Fictioneer was originally developed for a closed group of authors and not intended for a public release. This is still reflected in the code, which takes several liberties not considered best practice. You will most likely never find it in official libraries for that reason, meaning installation and updates need to be done manually.
2023-07-24 21:37:28 +02:00
The theme is best suited for individuals and small collectives, not so much open community archives.
2023-01-21 01:31:34 +01:00
Fictioneer is open source and completely free. However, maintaining and developing a theme of these proportions takes a considerable amount of time and effort. So if you enjoy Fictioneer and have the capacity, please consider supporting me on [Ko-fi](https://ko-fi.com/tetrakern). I also take on [commissions](https://fictioneer-theme.com/commissions/) for setup and customizations, *within reason.*
## Key Features
stories, chapters, collections, and recommendations &bull; customizable web reader &bull; shortcodes &bull; text-to-speech &bull; bookmarks &bull; progress tracker &bull; lightbox &bull; dark/light mode &bull; ePUB converter &bull; advanced search form &bull; OAuth 2.0 logins (Discord, Google, Twitch, and Patreon) &bull; responsive layout &bull; cache aware &bull; custom comment system &bull; AJAX comments &bull; private comments &bull; comment reply subscriptions &bull; send comment notifications to Discord &bull; search engine optimization &bull; GDPR compliant &bull; hue, saturation, and lightness sliders &bull; translation ready
## Customization & Child Themes
[Child themes](https://developer.wordpress.org/themes/advanced-topics/child-themes/) are the best way to customize Fictioneer if the provided options prove insufficient. You do not even need much programming experience for this since there are many guides and code snippets to adjust WordPress to your needs. But note that Fictioneer is not a page builder, so changing the whole layout does require expertise. Plugins may or may not work here. For starters, look at the [base child theme](https://github.com/Tetrakern/fictioneer-child-theme) and the [Liminal child theme](https://github.com/Tetrakern/fictioneer-liminal).
## Support the Development
2023-08-05 04:54:54 +02:00
Fictioneer (up to 5.5) has been developed by one author, barring [credited](CREDITS.md) code snippets. This was an exhausting effort and is not sustainable, so any help going forward is appreciated. If you are interested, or want to fork your own version, take a look at the [development](DEVELOPMENT.md) guidelines, [actions](ACTIONS.md), and [filters](FILTERS.md). You can also join the [Discord](https://discord.gg/tVfDB7EbaP).
2023-01-21 01:31:34 +01:00
## Screenshots
2023-01-28 18:52:58 +01:00
<p align="center">Base Theme (Light/Dark)</p>
![Screenshot Collage](repo/assets/fictioneer_preview.jpg?raw=true)
<p align="center">Base Theme Parts</p>
2023-01-28 18:29:07 +01:00
2023-01-21 01:31:34 +01:00
![Screenshot Collage](repo/assets/screenshots.jpg?raw=true)
2023-01-28 18:28:06 +01:00
2023-01-28 18:40:44 +01:00
<p align="center"><a href="https://github.com/Tetrakern/fictioneer-liminal" target="_blank">Fictioneer Liminal Child Theme (Light/Dark)</a></p>
2023-01-28 18:29:07 +01:00
2023-01-28 18:28:06 +01:00
![Liminal Child Theme](repo/assets/liminal_child_theme_preview.jpg?raw=true)