Files
san-reymoros/ext/phpbbstudio/ass/docs/README.md
2020-04-04 18:27:27 +02:00

87 lines
5.8 KiB
Markdown

<h1 align="center"><img src="./images/ass.png" alt="Advanced Shop System" /></h1>
<h4 align="center">An extension for the phpBB Forum Software.</h4>
<p align="center">
<img src="https://img.shields.io/badge/License-GPLv2-gold.svg" alt="GPLv2 License" />
</p>
## Table of Contents
> - [Install](#install)
> - [Uninstall](#uninstall)
> - [Support](#support)
> - [Translations](#translations)
> - [Features](#features)
> - [Other items](#other-items)
> - [Other extensions](#other-extensions)
> - [Extending Advanced Shop System](#extending-advanced-shop-system)
> - [You might also like](#you-might-also-like)
> - [License](#license)
## Install
1. Download the latest validated release
2. Unzip the downloaded release and copy it to the `ext` directory of your phpBB board.
3. Navigate in the ***<abbr title="Administration Control Panel">ACP</abbr>*** to `Customise » Extension management » Manage extensions`.
4. Look for `phpBB Studio - Advanced Shop System` under the **Disabled Extensions** list, and click its **`Enable`** link.
5. Set up and configure `Advanced Shop System` by navigating in the ***<abbr title="Administration Control Panel">ACP</abbr>*** to `Extensions » Advanced Shop System`.
> *Read more about [installing phpBB Extensions](https://www.phpbb.com/extensions/installing/#installing).*
## Uninstall
1. Navigate in the ***<abbr title="Administration Control Panel">ACP</abbr>*** to `Customise » Extension management » Manage extensions`.
2. Look for `phpBB Studio - Advanced Shop System` under the **Enabled Extensions** list, and click its **`Disable`** link.
3. To permanently uninstall, click **`Delete Data`** and then delete the `/ext/phpbbstudio/ass` directory.
> *Read more about [uninstalling phpBB Extensions](https://www.phpbb.com/extensions/installing/#removing).*
## Support
- **Important: Only official release versions validated by the phpBB Extensions Team should be installed on a live forum. Pre-release (beta, RC) versions downloaded from this repository are only to be used for testing on offline/development forums and are not officially supported.**
- Report bugs and other issues to our **[Issue Tracker](https://github.com/phpBB-Studio/AdvancedShopSystem/issues)**.
- Support requests can be posted and discussed in the **[Extension support](https://phpbbstudio.com/viewforum.php?f=5)** forum over at the [phpBB Studio](https://www.phpbbstudio.com).
- Support requests can be posted and discussed in the **[Development topic](https://www.phpbb.com/community/viewforum.php?f=456)** over at [phpBB.com](https://www.phpbb.com).
## Translations
- Translations should be posted in the corresponding forum in **[Extension support](https://phpbbstudio.com/viewforum.php?f=5)** over at the [phpBB Studio](https://www.phpbbstudio.com).
- Each translation should be created in a **separate** topic.
- The topic should either contain a **zip archive** as an attachment or a link to your **GitHub repository**.
- Translations should <u>***not***</u> be posted in the Development topic over at [phpBB.com](https://www.phpbb.com).
- Translations should <u>***not***</u> be created as Pull Requests over at the [GitHub](https://github.com/phpBB-Studio/) repository.
## Features
- Fully integrated Shop System for the [Advanced Points System](https://github.com/phpBB-Studio/AdvancedPointsSystem)
- Ease-of-use filesystem interface for item images and files.
- High customisation options and possibilities per item.
- Several item types included by default<br />*(Points and Files included by default)*
- More item types are available for expanding.
- Fully extendable by other extensions.<br />*(with detailed explanation and examples)*
## Other items
- [Rank](https://phpbbstudio.com/extensions/advanced-shop-system-rank)
- [Avatar](https://phpbbstudio.com/extensions/advanced-shop-system-avatar)
- [Username](https://phpbbstudio.com/extensions/advanced-shop-system-username)
- [Groups](https://phpbbstudio.com/extensions/advanced-shop-system-groups) *(Create a group and Join a group)*
- [Permissions](https://phpbbstudio.com/extensions/advanced-shop-system-permissions) *(Global permissions and Local permissions)*
## Other extensions
- [Advanced Points System](https://github.com/phpBB-Studio/AdvancedPointsSystem)
- [Advanced Points System · Purchases](https://phpbbstudio.com/extensions/advanced-points-system-purchases)
- [Advanced Points System · Auto Groups](https://github.com/phpBB-Studio/AdvancedShopSystemAutoGroups)
## Extending Advanced Shop System
For the extension developers amongst us, we have written a comprehensive Wiki that should describe everything in detail.
This can be read over at [Extending Advanced Shop System](https://github.com/phpBB-Studio/AdvancedShopSystem/wiki/Extending-ASS). If there are still any questions, feel free to ask.
## You might also like
- <a href="https://github.com/phpBB-Studio/DiceRolls"><img src="./images/dice_rolls.png" alt="Dice Rolls" /></a>
- <a href="https://github.com/phpBB-Studio/HighlightPosts"><img src="./images/highlight_posts.png" alt="Highlight Posts" /></a>
- <a href="https://github.com/phpBB-Studio/WhoReadWhat"><img src="./images/who_read_what.png" alt="Who Read What" /></a>
- <a href="https://github.com/phpBB-Studio/SubGlobalTopics"><img src="./images/subglobal_topic.png" alt="Sub Global Topic" /></a>
- <a href="https://github.com/phpBB-Studio/TopicCementStyle"><img src="./images/topic_cement.png" alt="Topic Cement Style" /></a>
- <a href="https://github.com/phpBB-Studio/DateTopicStarterTemplate"><img src="./images/topic_events.png" alt="Topic Events" /></a>
## License
GNU General Public License, version 2 ([GPLv2](../license.txt)).
---
> [phpbbstudio.com](https://www.phpbbstudio.com) · GitHub [phpbb-studio](https://github.com/phpbb-studio/) · phpBB [3Di](https://www.phpbb.com/community/memberlist.php?mode=viewprofile&u=177467) / [mrgoldy](https://www.phpbb.com/community/memberlist.php?mode=viewprofile&u=1114105)